« blib/lib/Paws/IoT/ListV2LoggingLevelsResponse.pm
↑ Summary
blib/lib/Paws/IoT/ListViolationEventsResponse.pm »
| 1 | |||
| 2 | package Paws::IoT::ListViolationEvents; | ||
| 3 | use Moose; | ||
| 4 | has BehaviorCriteriaType => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'behaviorCriteriaType'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'endTime', required => 1); | ||
| 6 | has ListSuppressedAlerts => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'listSuppressedAlerts'); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 9 | has SecurityProfileName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'securityProfileName'); | ||
| 10 | has StartTime => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'startTime', required => 1); | ||
| 11 | has ThingName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'thingName'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListViolationEvents'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/violation-events'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::ListViolationEventsResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::IoT::ListViolationEvents - Arguments for method ListViolationEvents on L<Paws::IoT> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ListViolationEvents on the | ||
| 30 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 31 | as arguments to method ListViolationEvents. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListViolationEvents. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $iot = Paws->service('IoT'); | ||
| 38 | my $ListViolationEventsResponse = $iot->ListViolationEvents( | ||
| 39 | EndTime => '1970-01-01T01:00:00', | ||
| 40 | StartTime => '1970-01-01T01:00:00', | ||
| 41 | BehaviorCriteriaType => 'STATIC', # OPTIONAL | ||
| 42 | ListSuppressedAlerts => 1, # OPTIONAL | ||
| 43 | MaxResults => 1, # OPTIONAL | ||
| 44 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 45 | SecurityProfileName => 'MySecurityProfileName', # OPTIONAL | ||
| 46 | ThingName => 'MyDeviceDefenderThingName', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $NextToken = $ListViolationEventsResponse->NextToken; | ||
| 51 | my $ViolationEvents = $ListViolationEventsResponse->ViolationEvents; | ||
| 52 | |||
| 53 | # Returns a L<Paws::IoT::ListViolationEventsResponse> object. | ||
| 54 | |||
| 55 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/ListViolationEvents> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 BehaviorCriteriaType => Str | ||
| 62 | |||
| 63 | The criteria for a behavior. | ||
| 64 | |||
| 65 | Valid values are: C<"STATIC">, C<"STATISTICAL">, C<"MACHINE_LEARNING"> | ||
| 66 | |||
| 67 | =head2 B<REQUIRED> EndTime => Str | ||
| 68 | |||
| 69 | The end time for the alerts to be listed. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 ListSuppressedAlerts => Bool | ||
| 74 | |||
| 75 | A list of all suppressed alerts. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 MaxResults => Int | ||
| 80 | |||
| 81 | The maximum number of results to return at one time. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 NextToken => Str | ||
| 86 | |||
| 87 | The token for the next set of results. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 SecurityProfileName => Str | ||
| 92 | |||
| 93 | A filter to limit results to those alerts generated by the specified | ||
| 94 | security profile. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> StartTime => Str | ||
| 99 | |||
| 100 | The start time for the alerts to be listed. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 ThingName => Str | ||
| 105 | |||
| 106 | A filter to limit results to those alerts caused by the specified | ||
| 107 | thing. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method ListViolationEvents in L<Paws::IoT> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |