NAME
Paws::Health - Perl Interface to AWS AWS Health APIs and Notifications
SYNOPSIS
use Paws;
my $obj = Paws->service('Health');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
AWS Health
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
METHODS
DescribeAffectedEntities(Filter => Paws::Health::EntityFilter, [Locale => Str, MaxResults => Int, NextToken => Str])
Each argument is described in detail in: Paws::Health::DescribeAffectedEntities
Returns: a Paws::Health::DescribeAffectedEntitiesResponse instance
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.
DescribeEntityAggregates([EventArns => ArrayRef[Str|Undef]])
Each argument is described in detail in: Paws::Health::DescribeEntityAggregates
Returns: a Paws::Health::DescribeEntityAggregatesResponse instance
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.DescribeEventAggregates(AggregateField => Str, [Filter => Paws::Health::EventFilter, MaxResults => Int, NextToken => Str])
Each argument is described in detail in: Paws::Health::DescribeEventAggregates
Returns: a Paws::Health::DescribeEventAggregatesResponse instance
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.DescribeEventDetails(EventArns => ArrayRef[Str|Undef], [Locale => Str])
Each argument is described in detail in: Paws::Health::DescribeEventDetails
Returns: a Paws::Health::DescribeEventDetailsResponse instance
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.
DescribeEvents([Filter => Paws::Health::EventFilter, Locale => Str, MaxResults => Int, NextToken => Str])
Each argument is described in detail in: Paws::Health::DescribeEvents
Returns: a Paws::Health::DescribeEventsResponse instance
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.
DescribeEventTypes([Filter => Paws::Health::EventTypeFilter, Locale => Str, MaxResults => Int, NextToken => Str])
Each argument is described in detail in: Paws::Health::DescribeEventTypes
Returns: a Paws::Health::DescribeEventTypesResponse instance
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.PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
DescribeAllAffectedEntities(sub { },Filter => Paws::Health::EntityFilter, [Locale => Str, MaxResults => Int, NextToken => Str])
DescribeAllAffectedEntities(Filter => Paws::Health::EntityFilter, [Locale => Str, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- entities, passing the object as the first parameter, and the string 'entities' as the second parameter If not, it will return a a Paws::Health::DescribeAffectedEntitiesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
DescribeAllEventAggregates(sub { },AggregateField => Str, [Filter => Paws::Health::EventFilter, MaxResults => Int, NextToken => Str])
DescribeAllEventAggregates(AggregateField => Str, [Filter => Paws::Health::EventFilter, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- eventAggregates, passing the object as the first parameter, and the string 'eventAggregates' as the second parameter If not, it will return a a Paws::Health::DescribeEventAggregatesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
DescribeAllEvents(sub { },[Filter => Paws::Health::EventFilter, Locale => Str, MaxResults => Int, NextToken => Str])
DescribeAllEvents([Filter => Paws::Health::EventFilter, Locale => Str, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- events, passing the object as the first parameter, and the string 'events' as the second parameter If not, it will return a a Paws::Health::DescribeEventsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
DescribeAllEventTypes(sub { },[Filter => Paws::Health::EventTypeFilter, Locale => Str, MaxResults => Int, NextToken => Str])
DescribeAllEventTypes([Filter => Paws::Health::EventTypeFilter, Locale => Str, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- eventTypes, passing the object as the first parameter, and the string 'eventTypes' as the second parameter If not, it will return a a Paws::Health::DescribeEventTypesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues