« blib/lib/Paws/IoT/UpdateRoleAliasResponse.pm
↑ Summary
blib/lib/Paws/IoT/UpdateScheduledAuditResponse.pm »
| 1 | |||
| 2 | package Paws::IoT::UpdateScheduledAudit; | ||
| 3 | use Moose; | ||
| 4 | has DayOfMonth => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dayOfMonth'); | ||
| 5 | has DayOfWeek => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dayOfWeek'); | ||
| 6 | has Frequency => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'frequency'); | ||
| 7 | has ScheduledAuditName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'scheduledAuditName', required => 1); | ||
| 8 | has TargetCheckNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'targetCheckNames'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateScheduledAudit'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/audit/scheduledaudits/{scheduledAuditName}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::UpdateScheduledAuditResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IoT::UpdateScheduledAudit - Arguments for method UpdateScheduledAudit on L<Paws::IoT> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateScheduledAudit on the | ||
| 27 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateScheduledAudit. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateScheduledAudit. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $iot = Paws->service('IoT'); | ||
| 35 | my $UpdateScheduledAuditResponse = $iot->UpdateScheduledAudit( | ||
| 36 | ScheduledAuditName => 'MyScheduledAuditName', | ||
| 37 | DayOfMonth => 'MyDayOfMonth', # OPTIONAL | ||
| 38 | DayOfWeek => 'SUN', # OPTIONAL | ||
| 39 | Frequency => 'DAILY', # OPTIONAL | ||
| 40 | TargetCheckNames => [ 'MyAuditCheckName', ... ], # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $ScheduledAuditArn = $UpdateScheduledAuditResponse->ScheduledAuditArn; | ||
| 45 | |||
| 46 | # Returns a L<Paws::IoT::UpdateScheduledAuditResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/UpdateScheduledAudit> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 DayOfMonth => Str | ||
| 55 | |||
| 56 | The day of the month on which the scheduled audit takes place. This can | ||
| 57 | be C<1> through C<31> or C<LAST>. This field is required if the | ||
| 58 | C<frequency> parameter is set to C<MONTHLY>. If days 29-31 are | ||
| 59 | specified, and the month does not have that many days, the audit takes | ||
| 60 | place on the "LAST" day of the month. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 DayOfWeek => Str | ||
| 65 | |||
| 66 | The day of the week on which the scheduled audit takes place. This can | ||
| 67 | be one of C<SUN>, C<MON>, C<TUE>, C<WED>, C<THU>, C<FRI>, or C<SAT>. | ||
| 68 | This field is required if the "frequency" parameter is set to C<WEEKLY> | ||
| 69 | or C<BIWEEKLY>. | ||
| 70 | |||
| 71 | Valid values are: C<"SUN">, C<"MON">, C<"TUE">, C<"WED">, C<"THU">, C<"FRI">, C<"SAT"> | ||
| 72 | |||
| 73 | =head2 Frequency => Str | ||
| 74 | |||
| 75 | How often the scheduled audit takes place, either C<DAILY>, C<WEEKLY>, | ||
| 76 | C<BIWEEKLY>, or C<MONTHLY>. The start time of each audit is determined | ||
| 77 | by the system. | ||
| 78 | |||
| 79 | Valid values are: C<"DAILY">, C<"WEEKLY">, C<"BIWEEKLY">, C<"MONTHLY"> | ||
| 80 | |||
| 81 | =head2 B<REQUIRED> ScheduledAuditName => Str | ||
| 82 | |||
| 83 | The name of the scheduled audit. (Max. 128 chars) | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 TargetCheckNames => ArrayRef[Str|Undef] | ||
| 88 | |||
| 89 | Which checks are performed during the scheduled audit. Checks must be | ||
| 90 | enabled for your account. (Use C<DescribeAccountAuditConfiguration> to | ||
| 91 | see the list of all checks, including those that are enabled or use | ||
| 92 | C<UpdateAccountAuditConfiguration> to select which checks are enabled.) | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method UpdateScheduledAudit in L<Paws::IoT> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |