AbstractAWSHealth (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.health.AbstractAWSHealth

All Implemented Interfaces:

AWSHealth

Direct Known Subclasses:

AbstractAWSHealthAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSHealth
extends Object
implements AWSHealth
```
Abstract implementation of AWSHealth. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.health.AWSHealth
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeAffectedEntitiesResult`	`describeAffectedEntities(DescribeAffectedEntitiesRequest request)` Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.
`DescribeEntityAggregatesResult`	`describeEntityAggregates(DescribeEntityAggregatesRequest request)` Returns the number of entities that are affected by each of the specified events.
`DescribeEventAggregatesResult`	`describeEventAggregates(DescribeEventAggregatesRequest request)` Returns the number of events of each event type (issue, scheduled change, and account notification).
`DescribeEventDetailsResult`	`describeEventDetails(DescribeEventDetailsRequest request)` Returns detailed information about one or more specified events.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest request)` Returns information about events that meet the specified filter criteria.
`DescribeEventTypesResult`	`describeEventTypes(DescribeEventTypesRequest request)` Returns the event types that meet the specified filter criteria.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("health.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSHealth.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSHealth
    
    Overrides the default endpoint for this client ("health.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "health.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "health.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AWSHealth
    
    Parameters:
    
    endpoint - The endpoint (ex: "health.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "health.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSHealth
    
    An alternative to AWSHealth.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AWSHealth
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - describeAffectedEntities
```
public DescribeAffectedEntitiesResult describeAffectedEntities(DescribeAffectedEntitiesRequest request)
```
    Description copied from interface: AWSHealth
    
    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.
    
    Specified by:
    
    describeAffectedEntities in interface AWSHealth
    
    Returns:
    
    Result of the DescribeAffectedEntities operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEntityAggregates
```
public DescribeEntityAggregatesResult describeEntityAggregates(DescribeEntityAggregatesRequest request)
```
    Description copied from interface: AWSHealth
    
    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.
    
    Specified by:
    
    describeEntityAggregates in interface AWSHealth
    
    Returns:
    
    Result of the DescribeEntityAggregates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventAggregates
```
public DescribeEventAggregatesResult describeEventAggregates(DescribeEventAggregatesRequest request)
```
    Description copied from interface: AWSHealth
    
    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.
    
    Specified by:
    
    describeEventAggregates in interface AWSHealth
    
    Returns:
    
    Result of the DescribeEventAggregates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventDetails
```
public DescribeEventDetailsResult describeEventDetails(DescribeEventDetailsRequest request)
```
    Description copied from interface: AWSHealth
    
    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.
    
    Specified by:
    
    describeEventDetails in interface AWSHealth
    
    Returns:
    
    Result of the DescribeEventDetails operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventTypes
```
public DescribeEventTypesResult describeEventTypes(DescribeEventTypesRequest request)
```
    Description copied from interface: AWSHealth
    
    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.
    
    Specified by:
    
    describeEventTypes in interface AWSHealth
    
    Returns:
    
    Result of the DescribeEventTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
```
    Description copied from interface: AWSHealth
    
    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.
    
    Specified by:
    
    describeEvents in interface AWSHealth
    
    Returns:
    
    Result of the DescribeEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSHealth
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSHealth
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSHealth
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSHealth
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSHealth

Field Summary

Fields inherited from interface com.amazonaws.services.health.AWSHealth

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

describeAffectedEntities

describeEntityAggregates

describeEventAggregates

describeEventDetails

describeEventTypes

describeEvents

shutdown

getCachedResponseMetadata