« blib/lib/Paws/IoT/SqsAction.pm
↑ Summary
blib/lib/Paws/IoT/StartAuditMitigationActionsTaskResponse.pm »
| 1 | |||
| 2 | package Paws::IoT::StartAuditMitigationActionsTask; | ||
| 3 | use Moose; | ||
| 4 | has AuditCheckToActionsMapping => (is => 'ro', isa => 'Paws::IoT::AuditCheckToActionsMapping', traits => ['NameInRequest'], request_name => 'auditCheckToActionsMapping', required => 1); | ||
| 5 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken', required => 1); | ||
| 6 | has Target => (is => 'ro', isa => 'Paws::IoT::AuditMitigationActionsTaskTarget', traits => ['NameInRequest'], request_name => 'target', required => 1); | ||
| 7 | has TaskId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'taskId', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartAuditMitigationActionsTask'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/audit/mitigationactions/tasks/{taskId}'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::StartAuditMitigationActionsTaskResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IoT::StartAuditMitigationActionsTask - Arguments for method StartAuditMitigationActionsTask on L<Paws::IoT> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method StartAuditMitigationActionsTask on the | ||
| 26 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 27 | as arguments to method StartAuditMitigationActionsTask. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartAuditMitigationActionsTask. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $iot = Paws->service('IoT'); | ||
| 34 | my $StartAuditMitigationActionsTaskResponse = | ||
| 35 | $iot->StartAuditMitigationActionsTask( | ||
| 36 | AuditCheckToActionsMapping => { | ||
| 37 | 'MyAuditCheckName' => [ | ||
| 38 | 'MyMitigationActionName', ... # max: 128 | ||
| 39 | ], # , value: min: 1, max: 5 | ||
| 40 | }, | ||
| 41 | ClientRequestToken => 'MyClientRequestToken', | ||
| 42 | Target => { | ||
| 43 | AuditCheckToReasonCodeFilter => { | ||
| 44 | 'MyAuditCheckName' => [ 'MyReasonForNonComplianceCode', ... ] | ||
| 45 | , # , value: min: 1, max: 25 | ||
| 46 | }, # OPTIONAL | ||
| 47 | AuditTaskId => 'MyAuditTaskId', # min: 1, max: 40; OPTIONAL | ||
| 48 | FindingIds => [ | ||
| 49 | 'MyFindingId', ... # min: 1, max: 128 | ||
| 50 | ], # min: 1, max: 25; OPTIONAL | ||
| 51 | }, | ||
| 52 | TaskId => 'MyMitigationActionsTaskId', | ||
| 53 | |||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $TaskId = $StartAuditMitigationActionsTaskResponse->TaskId; | ||
| 58 | |||
| 59 | # Returns a L<Paws::IoT::StartAuditMitigationActionsTaskResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/StartAuditMitigationActionsTask> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> AuditCheckToActionsMapping => L<Paws::IoT::AuditCheckToActionsMapping> | ||
| 68 | |||
| 69 | For an audit check, specifies which mitigation actions to apply. Those | ||
| 70 | actions must be defined in your AWS account. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> ClientRequestToken => Str | ||
| 75 | |||
| 76 | Each audit mitigation task must have a unique client request token. If | ||
| 77 | you try to start a new task with the same token as a task that already | ||
| 78 | exists, an exception occurs. If you omit this value, a unique client | ||
| 79 | request token is generated automatically. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> Target => L<Paws::IoT::AuditMitigationActionsTaskTarget> | ||
| 84 | |||
| 85 | Specifies the audit findings to which the mitigation actions are | ||
| 86 | applied. You can apply them to a type of audit check, to all findings | ||
| 87 | from an audit, or to a specific set of findings. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> TaskId => Str | ||
| 92 | |||
| 93 | A unique identifier for the task. You can use this identifier to check | ||
| 94 | the status of the task or to cancel it. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method StartAuditMitigationActionsTask in L<Paws::IoT> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |