@Generated(value="software.amazon.awssdk:codegen") public interface HealthClient extends SdkClient
builder()
method.
The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:
DescribeEvents: Summary information about events.
DescribeEventDetails: Detailed information about one or more events.
DescribeAffectedEntities: Information about AWS resources that are affected by one or more events.
In addition, these operations provide information about event types and summary counts of events or affected entities:
DescribeEventTypes: Information about the kinds of events that AWS Health tracks.
DescribeEventAggregates: A count of the number of events that meet specified criteria.
DescribeEntityAggregates: A count of the number of affected entities that meet specified criteria.
The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not
have a Business or Enterprise support plan causes a SubscriptionRequiredException
.
For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.
See the AWS Health User Guide for information about how to use the API.
Service Endpoint
The HTTP endpoint for the AWS Health API is:
https://health.us-east-1.amazonaws.com
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static HealthClientBuilder |
builder()
Create a builder that can be used to configure and create a
HealthClient . |
static HealthClient |
create()
Create a
HealthClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default 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 DescribeAffectedEntitiesResponse |
describeAffectedEntities(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter
criteria.
|
default DescribeAffectedEntitiesIterable |
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 DescribeAffectedEntitiesIterable |
describeAffectedEntitiesPaginator(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)
Returns a list of entities that have been affected by the specified events, based on the specified filter
criteria.
|
default DescribeEntityAggregatesResponse |
describeEntityAggregates()
Returns the number of entities that are affected by each of the specified events.
|
default DescribeEntityAggregatesResponse |
describeEntityAggregates(Consumer<DescribeEntityAggregatesRequest.Builder> describeEntityAggregatesRequest)
Returns the number of entities that are affected by each of the specified events.
|
default DescribeEntityAggregatesResponse |
describeEntityAggregates(DescribeEntityAggregatesRequest describeEntityAggregatesRequest)
Returns the number of entities that are affected by each of the specified events.
|
default DescribeEventAggregatesResponse |
describeEventAggregates(Consumer<DescribeEventAggregatesRequest.Builder> describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification).
|
default DescribeEventAggregatesResponse |
describeEventAggregates(DescribeEventAggregatesRequest describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification).
|
default DescribeEventAggregatesIterable |
describeEventAggregatesPaginator(Consumer<DescribeEventAggregatesRequest.Builder> describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification).
|
default DescribeEventAggregatesIterable |
describeEventAggregatesPaginator(DescribeEventAggregatesRequest describeEventAggregatesRequest)
Returns the number of events of each event type (issue, scheduled change, and account notification).
|
default DescribeEventDetailsResponse |
describeEventDetails(Consumer<DescribeEventDetailsRequest.Builder> describeEventDetailsRequest)
Returns detailed information about one or more specified events.
|
default DescribeEventDetailsResponse |
describeEventDetails(DescribeEventDetailsRequest describeEventDetailsRequest)
Returns detailed information about one or more specified events.
|
default DescribeEventsResponse |
describeEvents()
Returns information about events that meet the specified filter criteria.
|
default DescribeEventsResponse |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns information about events that meet the specified filter criteria.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns information about events that meet the specified filter criteria.
|
default DescribeEventsIterable |
describeEventsPaginator()
Returns information about events that meet the specified filter criteria.
|
default DescribeEventsIterable |
describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns information about events that meet the specified filter criteria.
|
default DescribeEventsIterable |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns information about events that meet the specified filter criteria.
|
default DescribeEventTypesResponse |
describeEventTypes()
Returns the event types that meet the specified filter criteria.
|
default DescribeEventTypesResponse |
describeEventTypes(Consumer<DescribeEventTypesRequest.Builder> describeEventTypesRequest)
Returns the event types that meet the specified filter criteria.
|
default DescribeEventTypesResponse |
describeEventTypes(DescribeEventTypesRequest describeEventTypesRequest)
Returns the event types that meet the specified filter criteria.
|
default DescribeEventTypesIterable |
describeEventTypesPaginator()
Returns the event types that meet the specified filter criteria.
|
default DescribeEventTypesIterable |
describeEventTypesPaginator(Consumer<DescribeEventTypesRequest.Builder> describeEventTypesRequest)
Returns the event types that meet the specified filter criteria.
|
default DescribeEventTypesIterable |
describeEventTypesPaginator(DescribeEventTypesRequest describeEventTypesRequest)
Returns the event types that meet the specified filter criteria.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static HealthClient create()
HealthClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static HealthClientBuilder builder()
HealthClient
.default DescribeAffectedEntitiesResponse describeAffectedEntities(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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 AWS 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. Results are sorted by the lastUpdatedTime
of the entity,
starting with the most recent.
describeAffectedEntitiesRequest
- InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAffectedEntitiesResponse describeAffectedEntities(Consumer<DescribeAffectedEntitiesRequest.Builder> describeAffectedEntitiesRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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 AWS 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. Results are sorted by the lastUpdatedTime
of the entity,
starting with the most recent.
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.InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAffectedEntitiesIterable describeAffectedEntitiesPaginator(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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 AWS 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. Results are sorted by the lastUpdatedTime
of the entity,
starting with the most recent.
This is a variant of
describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client.describeAffectedEntitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client .describeAffectedEntitiesPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client.describeAffectedEntitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest)
operation.
describeAffectedEntitiesRequest
- InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAffectedEntitiesIterable describeAffectedEntitiesPaginator(Consumer<DescribeAffectedEntitiesRequest.Builder> describeAffectedEntitiesRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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 AWS 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. Results are sorted by the lastUpdatedTime
of the entity,
starting with the most recent.
This is a variant of
describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client.describeAffectedEntitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client .describeAffectedEntitiesPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client.describeAffectedEntitiesPaginator(request);
responses.iterator().forEachRemaining(....);
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.InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEntityAggregatesResponse describeEntityAggregates() throws AwsServiceException, SdkClientException, HealthException
Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEntityAggregates(DescribeEntityAggregatesRequest)
,
AWS API Documentationdefault DescribeEntityAggregatesResponse describeEntityAggregates(DescribeEntityAggregatesRequest describeEntityAggregatesRequest) throws AwsServiceException, SdkClientException, HealthException
Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
describeEntityAggregatesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEntityAggregatesResponse describeEntityAggregates(Consumer<DescribeEntityAggregatesRequest.Builder> describeEntityAggregatesRequest) throws AwsServiceException, SdkClientException, HealthException
Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventAggregatesResponse describeEventAggregates(DescribeEventAggregatesRequest describeEventAggregatesRequest) throws InvalidPaginationTokenException, AwsServiceException, SdkClientException, HealthException
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.
describeEventAggregatesRequest
- InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventAggregatesResponse describeEventAggregates(Consumer<DescribeEventAggregatesRequest.Builder> describeEventAggregatesRequest) throws InvalidPaginationTokenException, AwsServiceException, SdkClientException, HealthException
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 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.InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventAggregatesIterable describeEventAggregatesPaginator(DescribeEventAggregatesRequest describeEventAggregatesRequest) throws InvalidPaginationTokenException, AwsServiceException, SdkClientException, HealthException
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 is a variant of
describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client.describeEventAggregatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client .describeEventAggregatesPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeEventAggregatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client.describeEventAggregatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest)
operation.
describeEventAggregatesRequest
- InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventAggregatesIterable describeEventAggregatesPaginator(Consumer<DescribeEventAggregatesRequest.Builder> describeEventAggregatesRequest) throws InvalidPaginationTokenException, AwsServiceException, SdkClientException, HealthException
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 is a variant of
describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client.describeEventAggregatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client .describeEventAggregatesPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeEventAggregatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client.describeEventAggregatesPaginator(request);
responses.iterator().forEachRemaining(....);
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.InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventDetailsResponse describeEventDetails(DescribeEventDetailsRequest describeEventDetailsRequest) throws UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., 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 those, use the DescribeAffectedEntities operation.
If a specified event cannot be retrieved, an error message is returned for that event.
describeEventDetailsRequest
- UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventDetailsResponse describeEventDetails(Consumer<DescribeEventDetailsRequest.Builder> describeEventDetailsRequest) throws UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., 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 those, use the DescribeAffectedEntities operation.
If a specified event cannot be retrieved, an error message is returned for that event.
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.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventTypesResponse describeEventTypes() throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventTypes(DescribeEventTypesRequest)
,
AWS API
Documentationdefault DescribeEventTypesResponse describeEventTypes(DescribeEventTypesRequest describeEventTypesRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
describeEventTypesRequest
- InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventTypesResponse describeEventTypes(Consumer<DescribeEventTypesRequest.Builder> describeEventTypesRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
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.InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventTypesIterable describeEventTypesPaginator() throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
This is a variant of
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client .describeEventTypesPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeEventTypesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest)
operation.
InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventTypesPaginator(DescribeEventTypesRequest)
,
AWS API
Documentationdefault DescribeEventTypesIterable describeEventTypesPaginator(DescribeEventTypesRequest describeEventTypesRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
This is a variant of
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client .describeEventTypesPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeEventTypesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest)
operation.
describeEventTypesRequest
- InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventTypesIterable describeEventTypesPaginator(Consumer<DescribeEventTypesRequest.Builder> describeEventTypesRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
This is a variant of
describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client .describeEventTypesPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeEventTypesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
responses.iterator().forEachRemaining(....);
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.InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsResponse describeEvents() throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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.
InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEvents(DescribeEventsRequest)
,
AWS API
Documentationdefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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.
describeEventsRequest
- InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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.
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.InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsIterable describeEventsPaginator() throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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.
This is a variant of describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest)
operation.
InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventsPaginator(DescribeEventsRequest)
,
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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.
This is a variant of describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest)
operation.
describeEventsRequest
- InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws InvalidPaginationTokenException, UnsupportedLocaleException, AwsServiceException, SdkClientException, HealthException
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.
This is a variant of describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.health.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
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.InvalidPaginationTokenException
- The specified pagination token (nextToken
) is not valid.UnsupportedLocaleException
- The specified locale is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HealthException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.