« blib/lib/Paws/IoT/StartAuditMitigationActionsTaskResponse.pm
↑ Summary
blib/lib/Paws/IoT/StartDetectMitigationActionsTaskResponse.pm »
| 1 | |||
| 2 | package Paws::IoT::StartDetectMitigationActionsTask; | ||
| 3 | use Moose; | ||
| 4 | has Actions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'actions', required => 1); | ||
| 5 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken', required => 1); | ||
| 6 | has IncludeOnlyActiveViolations => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeOnlyActiveViolations'); | ||
| 7 | has IncludeSuppressedAlerts => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeSuppressedAlerts'); | ||
| 8 | has Target => (is => 'ro', isa => 'Paws::IoT::DetectMitigationActionsTaskTarget', traits => ['NameInRequest'], request_name => 'target', required => 1); | ||
| 9 | has TaskId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'taskId', required => 1); | ||
| 10 | has ViolationEventOccurrenceRange => (is => 'ro', isa => 'Paws::IoT::ViolationEventOccurrenceRange', traits => ['NameInRequest'], request_name => 'violationEventOccurrenceRange'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartDetectMitigationActionsTask'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/detect/mitigationactions/tasks/{taskId}'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::StartDetectMitigationActionsTaskResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::IoT::StartDetectMitigationActionsTask - Arguments for method StartDetectMitigationActionsTask on L<Paws::IoT> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method StartDetectMitigationActionsTask on the | ||
| 29 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 30 | as arguments to method StartDetectMitigationActionsTask. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartDetectMitigationActionsTask. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $iot = Paws->service('IoT'); | ||
| 37 | my $StartDetectMitigationActionsTaskResponse = | ||
| 38 | $iot->StartDetectMitigationActionsTask( | ||
| 39 | Actions => [ | ||
| 40 | 'MyMitigationActionName', ... # max: 128 | ||
| 41 | ], | ||
| 42 | ClientRequestToken => 'MyClientRequestToken', | ||
| 43 | Target => { | ||
| 44 | BehaviorName => 'MyBehaviorName', # min: 1, max: 128; OPTIONAL | ||
| 45 | SecurityProfileName => | ||
| 46 | 'MySecurityProfileName', # min: 1, max: 128; OPTIONAL | ||
| 47 | ViolationIds => [ | ||
| 48 | 'MyViolationId', ... # min: 1, max: 128 | ||
| 49 | ], # min: 1, max: 25; OPTIONAL | ||
| 50 | }, | ||
| 51 | TaskId => 'MyMitigationActionsTaskId', | ||
| 52 | IncludeOnlyActiveViolations => 1, # OPTIONAL | ||
| 53 | IncludeSuppressedAlerts => 1, # OPTIONAL | ||
| 54 | ViolationEventOccurrenceRange => { | ||
| 55 | EndTime => '1970-01-01T01:00:00', | ||
| 56 | StartTime => '1970-01-01T01:00:00', | ||
| 57 | |||
| 58 | }, # OPTIONAL | ||
| 59 | ); | ||
| 60 | |||
| 61 | # Results: | ||
| 62 | my $TaskId = $StartDetectMitigationActionsTaskResponse->TaskId; | ||
| 63 | |||
| 64 | # Returns a L<Paws::IoT::StartDetectMitigationActionsTaskResponse> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/StartDetectMitigationActionsTask> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> Actions => ArrayRef[Str|Undef] | ||
| 73 | |||
| 74 | The actions to be performed when a device has unexpected behavior. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> ClientRequestToken => Str | ||
| 79 | |||
| 80 | Each mitigation action task must have a unique client request token. If | ||
| 81 | you try to create a new task with the same token as a task that already | ||
| 82 | exists, an exception occurs. If you omit this value, AWS SDKs will | ||
| 83 | automatically generate a unique client request. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 IncludeOnlyActiveViolations => Bool | ||
| 88 | |||
| 89 | Specifies to list only active violations. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 IncludeSuppressedAlerts => Bool | ||
| 94 | |||
| 95 | Specifies to include suppressed alerts. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> Target => L<Paws::IoT::DetectMitigationActionsTaskTarget> | ||
| 100 | |||
| 101 | Specifies the ML Detect findings to which the mitigation actions are | ||
| 102 | applied. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> TaskId => Str | ||
| 107 | |||
| 108 | The unique identifier of the task. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 ViolationEventOccurrenceRange => L<Paws::IoT::ViolationEventOccurrenceRange> | ||
| 113 | |||
| 114 | Specifies the time period of which violation events occurred between. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, documenting arguments for method StartDetectMitigationActionsTask in L<Paws::IoT> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |