@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface HealthAsyncClient extends AwsClient
builder()
method.
The Health API provides access to the Health information that appears in the Health Dashboard. You can use the API operations to get information about events that might affect your Amazon Web 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 SubscriptionRequiredException error.
For API access, you need an access key ID and a secret access key. Use temporary credentials instead of long-term access keys when possible. Temporary credentials include an access key ID, a secret access key, and a security token that indicates when the credentials expire. For more information, see Best practices for managing Amazon Web Services access keys in the Amazon Web Services General Reference.
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
DescribeEventsForOrganization operation to get all events in your organization, you might receive
several page results. Specify the nextToken in the next request to return more results.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static HealthAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
HealthAsyncClient. |
static HealthAsyncClient |
create()
Create a
HealthAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<DescribeAffectedAccountsForOrganizationResponse> |
describeAffectedAccountsForOrganization(Consumer<DescribeAffectedAccountsForOrganizationRequest.Builder> describeAffectedAccountsForOrganizationRequest)
Returns a list of accounts in the organization from Organizations that are affected by the provided event.
|
default CompletableFuture<DescribeAffectedAccountsForOrganizationResponse> |
describeAffectedAccountsForOrganization(DescribeAffectedAccountsForOrganizationRequest describeAffectedAccountsForOrganizationRequest)
Returns a list of accounts in the organization from Organizations that are affected by the provided event.
|
default DescribeAffectedAccountsForOrganizationPublisher |
describeAffectedAccountsForOrganizationPaginator(Consumer<DescribeAffectedAccountsForOrganizationRequest.Builder> describeAffectedAccountsForOrganizationRequest)
Returns a list of accounts in the organization from Organizations that are affected by the provided event.
|
default DescribeAffectedAccountsForOrganizationPublisher |
describeAffectedAccountsForOrganizationPaginator(DescribeAffectedAccountsForOrganizationRequest describeAffectedAccountsForOrganizationRequest)
Returns a list of accounts in the organization from Organizations that are affected by the provided event.
|
default CompletableFuture<DescribeAffectedEntitiesResponse> |
describeAffectedEntities(Consumer<DescribeAffectedEntitiesRequest.Builder> describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter
criteria.
|
default CompletableFuture<DescribeAffectedEntitiesResponse> |
describeAffectedEntities(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter
criteria.
|
default CompletableFuture<DescribeAffectedEntitiesForOrganizationResponse> |
describeAffectedEntitiesForOrganization(Consumer<DescribeAffectedEntitiesForOrganizationRequest.Builder> describeAffectedEntitiesForOrganizationRequest)
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.
|
default CompletableFuture<DescribeAffectedEntitiesForOrganizationResponse> |
describeAffectedEntitiesForOrganization(DescribeAffectedEntitiesForOrganizationRequest describeAffectedEntitiesForOrganizationRequest)
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.
|
default DescribeAffectedEntitiesForOrganizationPublisher |
describeAffectedEntitiesForOrganizationPaginator(Consumer<DescribeAffectedEntitiesForOrganizationRequest.Builder> describeAffectedEntitiesForOrganizationRequest)
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.
|
default DescribeAffectedEntitiesForOrganizationPublisher |
describeAffectedEntitiesForOrganizationPaginator(DescribeAffectedEntitiesForOrganizationRequest describeAffectedEntitiesForOrganizationRequest)
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.
|
default DescribeAffectedEntitiesPublisher |
describeAffectedEntitiesPaginator(Consumer<DescribeAffectedEntitiesRequest.Builder> describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter
criteria.
|
default DescribeAffectedEntitiesPublisher |
describeAffectedEntitiesPaginator(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter
criteria.
|
default CompletableFuture<DescribeEntityAggregatesResponse> |
describeEntityAggregates()
Returns the number of entities that are affected by each of the specified events.
|
default CompletableFuture<DescribeEntityAggregatesResponse> |
describeEntityAggregates(Consumer<DescribeEntityAggregatesRequest.Builder> describeEntityAggregatesRequest)
Returns the number of entities that are affected by each of the specified events.
|
default CompletableFuture<DescribeEntityAggregatesResponse> |
describeEntityAggregates(DescribeEntityAggregatesRequest describeEntityAggregatesRequest)
Returns the number of entities that are affected by each of the specified events.
|
default CompletableFuture<DescribeEntityAggregatesForOrganizationResponse> |
describeEntityAggregatesForOrganization(Consumer<DescribeEntityAggregatesForOrganizationRequest.Builder> describeEntityAggregatesForOrganizationRequest)
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
|
default CompletableFuture<DescribeEntityAggregatesForOrganizationResponse> |
describeEntityAggregatesForOrganization(DescribeEntityAggregatesForOrganizationRequest describeEntityAggregatesForOrganizationRequest)
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
|
default CompletableFuture<DescribeEventAggregatesResponse> |
describeEventAggregates(Consumer<DescribeEventAggregatesRequest.Builder> describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification).
|
default CompletableFuture<DescribeEventAggregatesResponse> |
describeEventAggregates(DescribeEventAggregatesRequest describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification).
|
default DescribeEventAggregatesPublisher |
describeEventAggregatesPaginator(Consumer<DescribeEventAggregatesRequest.Builder> describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification).
|
default DescribeEventAggregatesPublisher |
describeEventAggregatesPaginator(DescribeEventAggregatesRequest describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification).
|
default CompletableFuture<DescribeEventDetailsResponse> |
describeEventDetails(Consumer<DescribeEventDetailsRequest.Builder> describeEventDetailsRequest)
Returns detailed information about one or more specified events.
|
default CompletableFuture<DescribeEventDetailsResponse> |
describeEventDetails(DescribeEventDetailsRequest describeEventDetailsRequest)
Returns detailed information about one or more specified events.
|
default CompletableFuture<DescribeEventDetailsForOrganizationResponse> |
describeEventDetailsForOrganization(Consumer<DescribeEventDetailsForOrganizationRequest.Builder> describeEventDetailsForOrganizationRequest)
Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in
your organization.
|
default CompletableFuture<DescribeEventDetailsForOrganizationResponse> |
describeEventDetailsForOrganization(DescribeEventDetailsForOrganizationRequest describeEventDetailsForOrganizationRequest)
Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in
your organization.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents()
Returns information about events that meet the specified filter criteria.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns information about events that meet the specified filter criteria.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns information about events that meet the specified filter criteria.
|
default CompletableFuture<DescribeEventsForOrganizationResponse> |
describeEventsForOrganization(Consumer<DescribeEventsForOrganizationRequest.Builder> describeEventsForOrganizationRequest)
Returns information about events across your organization in Organizations.
|
default CompletableFuture<DescribeEventsForOrganizationResponse> |
describeEventsForOrganization(DescribeEventsForOrganizationRequest describeEventsForOrganizationRequest)
Returns information about events across your organization in Organizations.
|
default DescribeEventsForOrganizationPublisher |
describeEventsForOrganizationPaginator(Consumer<DescribeEventsForOrganizationRequest.Builder> describeEventsForOrganizationRequest)
Returns information about events across your organization in Organizations.
|
default DescribeEventsForOrganizationPublisher |
describeEventsForOrganizationPaginator(DescribeEventsForOrganizationRequest describeEventsForOrganizationRequest)
Returns information about events across your organization in Organizations.
|
default DescribeEventsPublisher |
describeEventsPaginator()
Returns information about events that meet the specified filter criteria.
|
default DescribeEventsPublisher |
describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns information about events that meet the specified filter criteria.
|
default DescribeEventsPublisher |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns information about events that meet the specified filter criteria.
|
default CompletableFuture<DescribeEventTypesResponse> |
describeEventTypes()
Returns the event types that meet the specified filter criteria.
|
default CompletableFuture<DescribeEventTypesResponse> |
describeEventTypes(Consumer<DescribeEventTypesRequest.Builder> describeEventTypesRequest)
Returns the event types that meet the specified filter criteria.
|
default CompletableFuture<DescribeEventTypesResponse> |
describeEventTypes(DescribeEventTypesRequest describeEventTypesRequest)
Returns the event types that meet the specified filter criteria.
|
default DescribeEventTypesPublisher |
describeEventTypesPaginator()
Returns the event types that meet the specified filter criteria.
|
default DescribeEventTypesPublisher |
describeEventTypesPaginator(Consumer<DescribeEventTypesRequest.Builder> describeEventTypesRequest)
Returns the event types that meet the specified filter criteria.
|
default DescribeEventTypesPublisher |
describeEventTypesPaginator(DescribeEventTypesRequest describeEventTypesRequest)
Returns the event types that meet the specified filter criteria.
|
default CompletableFuture<DescribeHealthServiceStatusForOrganizationResponse> |
describeHealthServiceStatusForOrganization(Consumer<DescribeHealthServiceStatusForOrganizationRequest.Builder> describeHealthServiceStatusForOrganizationRequest)
This operation provides status information on enabling or disabling Health to work with your organization.
|
default CompletableFuture<DescribeHealthServiceStatusForOrganizationResponse> |
describeHealthServiceStatusForOrganization(DescribeHealthServiceStatusForOrganizationRequest describeHealthServiceStatusForOrganizationRequest)
This operation provides status information on enabling or disabling Health to work with your organization.
|
default CompletableFuture<DisableHealthServiceAccessForOrganizationResponse> |
disableHealthServiceAccessForOrganization(Consumer<DisableHealthServiceAccessForOrganizationRequest.Builder> disableHealthServiceAccessForOrganizationRequest)
Disables Health from working with Organizations.
|
default CompletableFuture<DisableHealthServiceAccessForOrganizationResponse> |
disableHealthServiceAccessForOrganization(DisableHealthServiceAccessForOrganizationRequest disableHealthServiceAccessForOrganizationRequest)
Disables Health from working with Organizations.
|
default CompletableFuture<EnableHealthServiceAccessForOrganizationResponse> |
enableHealthServiceAccessForOrganization(Consumer<EnableHealthServiceAccessForOrganizationRequest.Builder> enableHealthServiceAccessForOrganizationRequest)
Enables Health to work with Organizations.
|
default CompletableFuture<EnableHealthServiceAccessForOrganizationResponse> |
enableHealthServiceAccessForOrganization(EnableHealthServiceAccessForOrganizationRequest enableHealthServiceAccessForOrganizationRequest)
Enables Health to work with Organizations.
|
default HealthServiceClientConfiguration |
serviceClientConfiguration() |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<DescribeAffectedAccountsForOrganizationResponse> describeAffectedAccountsForOrganization(DescribeAffectedAccountsForOrganizationRequest describeAffectedAccountsForOrganizationRequest)
Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
describeAffectedAccountsForOrganizationRequest - nextToken) is not valid.
default CompletableFuture<DescribeAffectedAccountsForOrganizationResponse> describeAffectedAccountsForOrganization(Consumer<DescribeAffectedAccountsForOrganizationRequest.Builder> describeAffectedAccountsForOrganizationRequest)
Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a convenience which creates an instance of the
DescribeAffectedAccountsForOrganizationRequest.Builder avoiding the need to create one manually via
DescribeAffectedAccountsForOrganizationRequest.builder()
describeAffectedAccountsForOrganizationRequest - A Consumer that will call methods on
DescribeAffectedAccountsForOrganizationRequest.Builder
to create a request.nextToken) is not valid.
default DescribeAffectedAccountsForOrganizationPublisher describeAffectedAccountsForOrganizationPaginator(DescribeAffectedAccountsForOrganizationRequest describeAffectedAccountsForOrganizationRequest)
Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of
describeAffectedAccountsForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeAffectedAccountsForOrganizationPublisher publisher = client.describeAffectedAccountsForOrganizationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeAffectedAccountsForOrganizationPublisher publisher = client.describeAffectedAccountsForOrganizationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAffectedAccountsForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationRequest)
operation.
describeAffectedAccountsForOrganizationRequest - nextToken) is not valid.
default DescribeAffectedAccountsForOrganizationPublisher describeAffectedAccountsForOrganizationPaginator(Consumer<DescribeAffectedAccountsForOrganizationRequest.Builder> describeAffectedAccountsForOrganizationRequest)
Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of
describeAffectedAccountsForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeAffectedAccountsForOrganizationPublisher publisher = client.describeAffectedAccountsForOrganizationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeAffectedAccountsForOrganizationPublisher publisher = client.describeAffectedAccountsForOrganizationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAffectedAccountsForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationRequest)
operation.
This is a convenience which creates an instance of the
DescribeAffectedAccountsForOrganizationRequest.Builder avoiding the need to create one manually via
DescribeAffectedAccountsForOrganizationRequest.builder()
describeAffectedAccountsForOrganizationRequest - A Consumer that will call methods on
DescribeAffectedAccountsForOrganizationRequest.Builder
to create a request.nextToken) is not valid.
default CompletableFuture<DescribeAffectedEntitiesResponse> describeAffectedEntities(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
At least one event ARN is required.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
describeAffectedEntitiesRequest - nextToken) is not valid.
default CompletableFuture<DescribeAffectedEntitiesResponse> describeAffectedEntities(Consumer<DescribeAffectedEntitiesRequest.Builder> describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
At least one event ARN is required.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
This is a convenience which creates an instance of the DescribeAffectedEntitiesRequest.Builder avoiding
the need to create one manually via DescribeAffectedEntitiesRequest.builder()
describeAffectedEntitiesRequest - A Consumer that will call methods on
DescribeAffectedEntitiesRequest.Builder to create a
request.nextToken) is not valid.
default CompletableFuture<DescribeAffectedEntitiesForOrganizationResponse> describeAffectedEntitiesForOrganization(DescribeAffectedEntitiesForOrganizationRequest describeAffectedEntitiesForOrganizationRequest)
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service.
At least one event Amazon Resource Name (ARN) and account ID are required.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
describeAffectedEntitiesForOrganizationRequest - nextToken) is not valid.
default CompletableFuture<DescribeAffectedEntitiesForOrganizationResponse> describeAffectedEntitiesForOrganization(Consumer<DescribeAffectedEntitiesForOrganizationRequest.Builder> describeAffectedEntitiesForOrganizationRequest)
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service.
At least one event Amazon Resource Name (ARN) and account ID are required.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
This is a convenience which creates an instance of the
DescribeAffectedEntitiesForOrganizationRequest.Builder avoiding the need to create one manually via
DescribeAffectedEntitiesForOrganizationRequest.builder()
describeAffectedEntitiesForOrganizationRequest - A Consumer that will call methods on
DescribeAffectedEntitiesForOrganizationRequest.Builder
to create a request.nextToken) is not valid.
default DescribeAffectedEntitiesForOrganizationPublisher describeAffectedEntitiesForOrganizationPaginator(DescribeAffectedEntitiesForOrganizationRequest describeAffectedEntitiesForOrganizationRequest)
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service.
At least one event Amazon Resource Name (ARN) and account ID are required.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
This is a variant of
describeAffectedEntitiesForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationPublisher publisher = client.describeAffectedEntitiesForOrganizationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationPublisher publisher = client.describeAffectedEntitiesForOrganizationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAffectedEntitiesForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationRequest)
operation.
describeAffectedEntitiesForOrganizationRequest - nextToken) is not valid.
default DescribeAffectedEntitiesForOrganizationPublisher describeAffectedEntitiesForOrganizationPaginator(Consumer<DescribeAffectedEntitiesForOrganizationRequest.Builder> describeAffectedEntitiesForOrganizationRequest)
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service.
At least one event Amazon Resource Name (ARN) and account ID are required.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
This is a variant of
describeAffectedEntitiesForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationPublisher publisher = client.describeAffectedEntitiesForOrganizationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationPublisher publisher = client.describeAffectedEntitiesForOrganizationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAffectedEntitiesForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationRequest)
operation.
This is a convenience which creates an instance of the
DescribeAffectedEntitiesForOrganizationRequest.Builder avoiding the need to create one manually via
DescribeAffectedEntitiesForOrganizationRequest.builder()
describeAffectedEntitiesForOrganizationRequest - A Consumer that will call methods on
DescribeAffectedEntitiesForOrganizationRequest.Builder
to create a request.nextToken) is not valid.
default DescribeAffectedEntitiesPublisher describeAffectedEntitiesPaginator(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
At least one event ARN is required.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
This is a variant of
describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesPublisher publisher = client.describeAffectedEntitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesPublisher publisher = client.describeAffectedEntitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest)
operation.
describeAffectedEntitiesRequest - nextToken) is not valid.
default DescribeAffectedEntitiesPublisher describeAffectedEntitiesPaginator(Consumer<DescribeAffectedEntitiesRequest.Builder> describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
At least one event ARN is required.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
This is a variant of
describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesPublisher publisher = client.describeAffectedEntitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesPublisher publisher = client.describeAffectedEntitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest)
operation.
This is a convenience which creates an instance of the DescribeAffectedEntitiesRequest.Builder avoiding
the need to create one manually via DescribeAffectedEntitiesRequest.builder()
describeAffectedEntitiesRequest - A Consumer that will call methods on
DescribeAffectedEntitiesRequest.Builder to create a
request.nextToken) is not valid.
default CompletableFuture<DescribeEntityAggregatesResponse> describeEntityAggregates(DescribeEntityAggregatesRequest describeEntityAggregatesRequest)
Returns the number of entities that are affected by each of the specified events.
describeEntityAggregatesRequest - default CompletableFuture<DescribeEntityAggregatesResponse> describeEntityAggregates(Consumer<DescribeEntityAggregatesRequest.Builder> describeEntityAggregatesRequest)
Returns the number of entities that are affected by each of the specified events.
This is a convenience which creates an instance of the DescribeEntityAggregatesRequest.Builder avoiding
the need to create one manually via DescribeEntityAggregatesRequest.builder()
describeEntityAggregatesRequest - A Consumer that will call methods on
DescribeEntityAggregatesRequest.Builder to create a
request.default CompletableFuture<DescribeEntityAggregatesResponse> describeEntityAggregates()
Returns the number of entities that are affected by each of the specified events.
default CompletableFuture<DescribeEntityAggregatesForOrganizationResponse> describeEntityAggregatesForOrganization(DescribeEntityAggregatesForOrganizationRequest describeEntityAggregatesForOrganizationRequest)
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
describeEntityAggregatesForOrganizationRequest - default CompletableFuture<DescribeEntityAggregatesForOrganizationResponse> describeEntityAggregatesForOrganization(Consumer<DescribeEntityAggregatesForOrganizationRequest.Builder> describeEntityAggregatesForOrganizationRequest)
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
This is a convenience which creates an instance of the
DescribeEntityAggregatesForOrganizationRequest.Builder avoiding the need to create one manually via
DescribeEntityAggregatesForOrganizationRequest.builder()
describeEntityAggregatesForOrganizationRequest - A Consumer that will call methods on
DescribeEntityAggregatesForOrganizationRequest.Builder
to create a request.default CompletableFuture<DescribeEventAggregatesResponse> describeEventAggregates(DescribeEventAggregatesRequest describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
describeEventAggregatesRequest - nextToken) is not valid.
default CompletableFuture<DescribeEventAggregatesResponse> describeEventAggregates(Consumer<DescribeEventAggregatesRequest.Builder> describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a convenience which creates an instance of the DescribeEventAggregatesRequest.Builder avoiding
the need to create one manually via DescribeEventAggregatesRequest.builder()
describeEventAggregatesRequest - A Consumer that will call methods on
DescribeEventAggregatesRequest.Builder to create a
request.nextToken) is not valid.
default DescribeEventAggregatesPublisher describeEventAggregatesPaginator(DescribeEventAggregatesRequest describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of
describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesPublisher publisher = client.describeEventAggregatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesPublisher publisher = client.describeEventAggregatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventAggregatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventAggregatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest)
operation.
describeEventAggregatesRequest - nextToken) is not valid.
default DescribeEventAggregatesPublisher describeEventAggregatesPaginator(Consumer<DescribeEventAggregatesRequest.Builder> describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of
describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesPublisher publisher = client.describeEventAggregatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesPublisher publisher = client.describeEventAggregatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventAggregatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventAggregatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest)
operation.
This is a convenience which creates an instance of the DescribeEventAggregatesRequest.Builder avoiding
the need to create one manually via DescribeEventAggregatesRequest.builder()
describeEventAggregatesRequest - A Consumer that will call methods on
DescribeEventAggregatesRequest.Builder to create a
request.nextToken) is not valid.
default CompletableFuture<DescribeEventDetailsResponse> describeEventDetails(DescribeEventDetailsRequest describeEventDetailsRequest)
Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation.
If a specified event can't be retrieved, an error message is returned for that event.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
describeEventDetailsRequest - default CompletableFuture<DescribeEventDetailsResponse> describeEventDetails(Consumer<DescribeEventDetailsRequest.Builder> describeEventDetailsRequest)
Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation.
If a specified event can't be retrieved, an error message is returned for that event.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
This is a convenience which creates an instance of the DescribeEventDetailsRequest.Builder avoiding the
need to create one manually via DescribeEventDetailsRequest.builder()
describeEventDetailsRequest - A Consumer that will call methods on
DescribeEventDetailsRequest.Builder to create a
request.default CompletableFuture<DescribeEventDetailsForOrganizationResponse> describeEventDetailsForOrganization(DescribeEventDetailsForOrganizationRequest describeEventDetailsForOrganizationRequest)
Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
When you call the DescribeEventDetailsForOrganization operation, specify the
organizationEventDetailFilters object in the request. Depending on the Health event type, note the
following differences:
To return event details for a public event, you must specify a null value for the awsAccountId
parameter. If you specify an account ID for a public event, Health returns an error message because public events
aren't specific to an account.
To return event details for an event that is specific to an account in your organization, you must specify the
awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error
message because the event is specific to an account in your organization.
For more information, see Event.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
describeEventDetailsForOrganizationRequest - default CompletableFuture<DescribeEventDetailsForOrganizationResponse> describeEventDetailsForOrganization(Consumer<DescribeEventDetailsForOrganizationRequest.Builder> describeEventDetailsForOrganizationRequest)
Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
When you call the DescribeEventDetailsForOrganization operation, specify the
organizationEventDetailFilters object in the request. Depending on the Health event type, note the
following differences:
To return event details for a public event, you must specify a null value for the awsAccountId
parameter. If you specify an account ID for a public event, Health returns an error message because public events
aren't specific to an account.
To return event details for an event that is specific to an account in your organization, you must specify the
awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error
message because the event is specific to an account in your organization.
For more information, see Event.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
This is a convenience which creates an instance of the DescribeEventDetailsForOrganizationRequest.Builder
avoiding the need to create one manually via DescribeEventDetailsForOrganizationRequest.builder()
describeEventDetailsForOrganizationRequest - A Consumer that will call methods on
DescribeEventDetailsForOrganizationRequest.Builder to
create a request.default CompletableFuture<DescribeEventTypesResponse> describeEventTypes(DescribeEventTypesRequest describeEventTypesRequest)
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, in no particular order.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
describeEventTypesRequest - nextToken) is not valid.
default CompletableFuture<DescribeEventTypesResponse> describeEventTypes(Consumer<DescribeEventTypesRequest.Builder> describeEventTypesRequest)
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, in no particular order.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a convenience which creates an instance of the DescribeEventTypesRequest.Builder avoiding the
need to create one manually via DescribeEventTypesRequest.builder()
describeEventTypesRequest - A Consumer that will call methods on
DescribeEventTypesRequest.Builder to create a
request.nextToken) is not valid.
default CompletableFuture<DescribeEventTypesResponse> describeEventTypes()
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, in no particular order.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
nextToken) is not valid.
default DescribeEventTypesPublisher describeEventTypesPaginator()
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, in no particular order.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventTypesPublisher publisher = client.describeEventTypesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventTypesPublisher publisher = client.describeEventTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest)
operation.
nextToken) is not valid.
default DescribeEventTypesPublisher describeEventTypesPaginator(DescribeEventTypesRequest describeEventTypesRequest)
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, in no particular order.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventTypesPublisher publisher = client.describeEventTypesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventTypesPublisher publisher = client.describeEventTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest)
operation.
describeEventTypesRequest - nextToken) is not valid.
default DescribeEventTypesPublisher describeEventTypesPaginator(Consumer<DescribeEventTypesRequest.Builder> describeEventTypesRequest)
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, in no particular order.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventTypesPublisher publisher = client.describeEventTypesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventTypesPublisher publisher = client.describeEventTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest)
operation.
This is a convenience which creates an instance of the DescribeEventTypesRequest.Builder avoiding the
need to create one manually via DescribeEventTypesRequest.builder()
describeEventTypesRequest - A Consumer that will call methods on
DescribeEventTypesRequest.Builder to create a
request.nextToken) is not valid.
default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest)
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime
, starting with the most recent event.
When you call the DescribeEvents operation and specify an entity for the entityValues
parameter, Health might return public events that aren't specific to that resource. For example, if you call
DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health
might return events that aren't specific to that resource or service. To get events that are specific to a
service, use the services parameter in the filter object. For more information, see Event.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
describeEventsRequest - nextToken) is not valid.
default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime
, starting with the most recent event.
When you call the DescribeEvents operation and specify an entity for the entityValues
parameter, Health might return public events that aren't specific to that resource. For example, if you call
DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health
might return events that aren't specific to that resource or service. To get events that are specific to a
service, use the services parameter in the filter object. For more information, see Event.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on
DescribeEventsRequest.Builder to create a request.nextToken) is not valid.
default CompletableFuture<DescribeEventsResponse> describeEvents()
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime
, starting with the most recent event.
When you call the DescribeEvents operation and specify an entity for the entityValues
parameter, Health might return public events that aren't specific to that resource. For example, if you call
DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health
might return events that aren't specific to that resource or service. To get events that are specific to a
service, use the services parameter in the filter object. For more information, see Event.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
nextToken) is not valid.
default CompletableFuture<DescribeEventsForOrganizationResponse> describeEventsForOrganization(DescribeEventsForOrganizationRequest describeEventsForOrganizationRequest)
Returns information about events across your organization in Organizations. You can use thefilters
parameter to specify the events that you want to return. Events are returned in a summary form and don't include
the affected accounts, detailed description, any additional metadata that depends on the event type, or any
affected resources. To retrieve that information, use the following operations:
If you don't specify a filter, the DescribeEventsForOrganizations returns all events
across your organization. Results are sorted by lastModifiedTime, starting with the most recent
event.
For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
describeEventsForOrganizationRequest - nextToken) is not valid.
default CompletableFuture<DescribeEventsForOrganizationResponse> describeEventsForOrganization(Consumer<DescribeEventsForOrganizationRequest.Builder> describeEventsForOrganizationRequest)
Returns information about events across your organization in Organizations. You can use thefilters
parameter to specify the events that you want to return. Events are returned in a summary form and don't include
the affected accounts, detailed description, any additional metadata that depends on the event type, or any
affected resources. To retrieve that information, use the following operations:
If you don't specify a filter, the DescribeEventsForOrganizations returns all events
across your organization. Results are sorted by lastModifiedTime, starting with the most recent
event.
For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a convenience which creates an instance of the DescribeEventsForOrganizationRequest.Builder
avoiding the need to create one manually via DescribeEventsForOrganizationRequest.builder()
describeEventsForOrganizationRequest - A Consumer that will call methods on
DescribeEventsForOrganizationRequest.Builder to
create a request.nextToken) is not valid.
default DescribeEventsForOrganizationPublisher describeEventsForOrganizationPaginator(DescribeEventsForOrganizationRequest describeEventsForOrganizationRequest)
Returns information about events across your organization in Organizations. You can use thefilters
parameter to specify the events that you want to return. Events are returned in a summary form and don't include
the affected accounts, detailed description, any additional metadata that depends on the event type, or any
affected resources. To retrieve that information, use the following operations:
If you don't specify a filter, the DescribeEventsForOrganizations returns all events
across your organization. Results are sorted by lastModifiedTime, starting with the most recent
event.
For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of
describeEventsForOrganization(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationPublisher publisher = client.describeEventsForOrganizationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationPublisher publisher = client.describeEventsForOrganizationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventsForOrganization(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationRequest)
operation.
describeEventsForOrganizationRequest - nextToken) is not valid.
default DescribeEventsForOrganizationPublisher describeEventsForOrganizationPaginator(Consumer<DescribeEventsForOrganizationRequest.Builder> describeEventsForOrganizationRequest)
Returns information about events across your organization in Organizations. You can use thefilters
parameter to specify the events that you want to return. Events are returned in a summary form and don't include
the affected accounts, detailed description, any additional metadata that depends on the event type, or any
affected resources. To retrieve that information, use the following operations:
If you don't specify a filter, the DescribeEventsForOrganizations returns all events
across your organization. Results are sorted by lastModifiedTime, starting with the most recent
event.
For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of
describeEventsForOrganization(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationPublisher publisher = client.describeEventsForOrganizationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationPublisher publisher = client.describeEventsForOrganizationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventsForOrganization(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationRequest)
operation.
This is a convenience which creates an instance of the DescribeEventsForOrganizationRequest.Builder
avoiding the need to create one manually via DescribeEventsForOrganizationRequest.builder()
describeEventsForOrganizationRequest - A Consumer that will call methods on
DescribeEventsForOrganizationRequest.Builder to
create a request.nextToken) is not valid.
default DescribeEventsPublisher describeEventsPaginator()
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime
, starting with the most recent event.
When you call the DescribeEvents operation and specify an entity for the entityValues
parameter, Health might return public events that aren't specific to that resource. For example, if you call
DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health
might return events that aren't specific to that resource or service. To get events that are specific to a
service, use the services parameter in the filter object. For more information, see Event.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest) operation.
nextToken) is not valid.
default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime
, starting with the most recent event.
When you call the DescribeEvents operation and specify an entity for the entityValues
parameter, Health might return public events that aren't specific to that resource. For example, if you call
DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health
might return events that aren't specific to that resource or service. To get events that are specific to a
service, use the services parameter in the filter object. For more information, see Event.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest) operation.
describeEventsRequest - nextToken) is not valid.
default DescribeEventsPublisher describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime
, starting with the most recent event.
When you call the DescribeEvents operation and specify an entity for the entityValues
parameter, Health might return public events that aren't specific to that resource. For example, if you call
DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health
might return events that aren't specific to that resource or service. To get events that are specific to a
service, use the services parameter in the filter object. For more information, see Event.
This API operation uses pagination. Specify the nextToken parameter in the next request to return
more results.
This is a variant of describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.health.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.health.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.health.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.health.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest) operation.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on
DescribeEventsRequest.Builder to create a request.nextToken) is not valid.
default CompletableFuture<DescribeHealthServiceStatusForOrganizationResponse> describeHealthServiceStatusForOrganization(DescribeHealthServiceStatusForOrganizationRequest describeHealthServiceStatusForOrganizationRequest)
This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the organization's management account.
describeHealthServiceStatusForOrganizationRequest - default CompletableFuture<DescribeHealthServiceStatusForOrganizationResponse> describeHealthServiceStatusForOrganization(Consumer<DescribeHealthServiceStatusForOrganizationRequest.Builder> describeHealthServiceStatusForOrganizationRequest)
This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the organization's management account.
This is a convenience which creates an instance of the
DescribeHealthServiceStatusForOrganizationRequest.Builder avoiding the need to create one manually via
DescribeHealthServiceStatusForOrganizationRequest.builder()
describeHealthServiceStatusForOrganizationRequest - A Consumer that will call methods on
DescribeHealthServiceStatusForOrganizationRequest.Builder
to create a request.default CompletableFuture<DisableHealthServiceAccessForOrganizationResponse> disableHealthServiceAccessForOrganization(DisableHealthServiceAccessForOrganizationRequest disableHealthServiceAccessForOrganizationRequest)
Disables Health from working with Organizations. To call this operation, you must sign in to the organization's management account. For more information, see Aggregating Health events in the Health User Guide.
This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide.
You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, Health stops aggregating events for all other Amazon Web Services accounts in your organization. If you call the Health API operations for organizational view, Health returns an error. Health continues to aggregate health events for your Amazon Web Services account.
disableHealthServiceAccessForOrganizationRequest - default CompletableFuture<DisableHealthServiceAccessForOrganizationResponse> disableHealthServiceAccessForOrganization(Consumer<DisableHealthServiceAccessForOrganizationRequest.Builder> disableHealthServiceAccessForOrganizationRequest)
Disables Health from working with Organizations. To call this operation, you must sign in to the organization's management account. For more information, see Aggregating Health events in the Health User Guide.
This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide.
You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, Health stops aggregating events for all other Amazon Web Services accounts in your organization. If you call the Health API operations for organizational view, Health returns an error. Health continues to aggregate health events for your Amazon Web Services account.
This is a convenience which creates an instance of the
DisableHealthServiceAccessForOrganizationRequest.Builder avoiding the need to create one manually via
DisableHealthServiceAccessForOrganizationRequest.builder()
disableHealthServiceAccessForOrganizationRequest - A Consumer that will call methods on
DisableHealthServiceAccessForOrganizationRequest.Builder
to create a request.default CompletableFuture<EnableHealthServiceAccessForOrganizationResponse> enableHealthServiceAccessForOrganization(EnableHealthServiceAccessForOrganizationRequest enableHealthServiceAccessForOrganizationRequest)
Enables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.
This operation also creates a service-linked role for the management account in the organization.
To call this operation, you must meet the following requirements:
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call
the Health API from an Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or
Enterprise Support plan, you receive a SubscriptionRequiredException error.
You must have permission to call this operation from the organization's management account. For example IAM policies, see Health identity-based policy examples.
If you don't have the required support plan, you can instead use the Health console to enable the organizational view feature. For more information, see Aggregating Health events in the Health User Guide.
enableHealthServiceAccessForOrganizationRequest - default CompletableFuture<EnableHealthServiceAccessForOrganizationResponse> enableHealthServiceAccessForOrganization(Consumer<EnableHealthServiceAccessForOrganizationRequest.Builder> enableHealthServiceAccessForOrganizationRequest)
Enables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.
This operation also creates a service-linked role for the management account in the organization.
To call this operation, you must meet the following requirements:
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call
the Health API from an Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or
Enterprise Support plan, you receive a SubscriptionRequiredException error.
You must have permission to call this operation from the organization's management account. For example IAM policies, see Health identity-based policy examples.
If you don't have the required support plan, you can instead use the Health console to enable the organizational view feature. For more information, see Aggregating Health events in the Health User Guide.
This is a convenience which creates an instance of the
EnableHealthServiceAccessForOrganizationRequest.Builder avoiding the need to create one manually via
EnableHealthServiceAccessForOrganizationRequest.builder()
enableHealthServiceAccessForOrganizationRequest - A Consumer that will call methods on
EnableHealthServiceAccessForOrganizationRequest.Builder
to create a request.default HealthServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic HealthAsyncClient create()
HealthAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static HealthAsyncClientBuilder builder()
HealthAsyncClient.Copyright © 2023. All rights reserved.