HealthClient Class

Member Function Documentation

HealthClient::HealthClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a HealthClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

HealthClient::HealthClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads HealthClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] DescribeAffectedEntitiesResponse *HealthClient::describeAffectedEntities(const DescribeAffectedEntitiesRequest &request)

Sends request to the HealthClient service, and returns a pointer to an DescribeAffectedEntitiesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>lastUpdatedTime</code> of the entity, starting with the most

[slot] DescribeEntityAggregatesResponse *HealthClient::describeEntityAggregates(const DescribeEntityAggregatesRequest &request)

Sends request to the HealthClient service, and returns a pointer to an DescribeEntityAggregatesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeEventAggregatesResponse *HealthClient::describeEventAggregates(const DescribeEventAggregatesRequest &request)

Sends request to the HealthClient service, and returns a pointer to an DescribeEventAggregatesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeEventDetailsResponse *HealthClient::describeEventDetails(const DescribeEventDetailsRequest &request)

Sends request to the HealthClient service, and returns a pointer to an DescribeEventDetailsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by <a>DescribeEvents</a>), 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 <a>DescribeAffectedEntities</a>

operation>

If a specified event cannot be retrieved, an error message is returned for that

[slot] DescribeEventTypesResponse *HealthClient::describeEventTypes(const DescribeEventTypesRequest &request)

Sends request to the HealthClient service, and returns a pointer to an DescribeEventTypesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular

[slot] DescribeEventsResponse *HealthClient::describeEvents(const DescribeEventsRequest &request)

Sends request to the HealthClient service, and returns a pointer to an DescribeEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>DescribeEventDetails</a> and <a>DescribeAffectedEntities</a>

operations>

If no filter criteria are specified, all events are returned. Results are sorted by <code>lastModifiedTime</code>, starting with the most