| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Inspector::AssessmentRun; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest'], required => 1); | ||
| 5 | has AssessmentTemplateArn => (is => 'ro', isa => 'Str', request_name => 'assessmentTemplateArn', traits => ['NameInRequest'], required => 1); | ||
| 6 | has CompletedAt => (is => 'ro', isa => 'Str', request_name => 'completedAt', traits => ['NameInRequest']); | ||
| 7 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest'], required => 1); | ||
| 8 | has DataCollected => (is => 'ro', isa => 'Bool', request_name => 'dataCollected', traits => ['NameInRequest'], required => 1); | ||
| 9 | has DurationInSeconds => (is => 'ro', isa => 'Int', request_name => 'durationInSeconds', traits => ['NameInRequest'], required => 1); | ||
| 10 | has FindingCounts => (is => 'ro', isa => 'Paws::Inspector::AssessmentRunFindingCounts', request_name => 'findingCounts', traits => ['NameInRequest'], required => 1); | ||
| 11 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 12 | has Notifications => (is => 'ro', isa => 'ArrayRef[Paws::Inspector::AssessmentRunNotification]', request_name => 'notifications', traits => ['NameInRequest'], required => 1); | ||
| 13 | has RulesPackageArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'rulesPackageArns', traits => ['NameInRequest'], required => 1); | ||
| 14 | has StartedAt => (is => 'ro', isa => 'Str', request_name => 'startedAt', traits => ['NameInRequest']); | ||
| 15 | has State => (is => 'ro', isa => 'Str', request_name => 'state', traits => ['NameInRequest'], required => 1); | ||
| 16 | has StateChangedAt => (is => 'ro', isa => 'Str', request_name => 'stateChangedAt', traits => ['NameInRequest'], required => 1); | ||
| 17 | has StateChanges => (is => 'ro', isa => 'ArrayRef[Paws::Inspector::AssessmentRunStateChange]', request_name => 'stateChanges', traits => ['NameInRequest'], required => 1); | ||
| 18 | has UserAttributesForFindings => (is => 'ro', isa => 'ArrayRef[Paws::Inspector::Attribute]', request_name => 'userAttributesForFindings', traits => ['NameInRequest'], required => 1); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Inspector::AssessmentRun | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::Inspector::AssessmentRun object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { Arn => $value, ..., UserAttributesForFindings => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::Inspector::AssessmentRun object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->Arn | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | A snapshot of an Amazon Inspector assessment run that contains the | ||
| 51 | findings of the assessment run . | ||
| 52 | |||
| 53 | Used as the response element in the DescribeAssessmentRuns action. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> Arn => Str | ||
| 59 | |||
| 60 | The ARN of the assessment run. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> AssessmentTemplateArn => Str | ||
| 64 | |||
| 65 | The ARN of the assessment template that is associated with the | ||
| 66 | assessment run. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 CompletedAt => Str | ||
| 70 | |||
| 71 | The assessment run completion time that corresponds to the rules | ||
| 72 | packages evaluation completion time or failure. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> CreatedAt => Str | ||
| 76 | |||
| 77 | The time when StartAssessmentRun was called. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> DataCollected => Bool | ||
| 81 | |||
| 82 | A Boolean value (true or false) that specifies whether the process of | ||
| 83 | collecting data from the agents is completed. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> DurationInSeconds => Int | ||
| 87 | |||
| 88 | The duration of the assessment run. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> FindingCounts => L<Paws::Inspector::AssessmentRunFindingCounts> | ||
| 92 | |||
| 93 | Provides a total count of generated findings per severity. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> Name => Str | ||
| 97 | |||
| 98 | The auto-generated name for the assessment run. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> Notifications => ArrayRef[L<Paws::Inspector::AssessmentRunNotification>] | ||
| 102 | |||
| 103 | A list of notifications for the event subscriptions. A notification | ||
| 104 | about a particular generated finding is added to this list only once. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> RulesPackageArns => ArrayRef[Str|Undef] | ||
| 108 | |||
| 109 | The rules packages selected for the assessment run. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 StartedAt => Str | ||
| 113 | |||
| 114 | The time when StartAssessmentRun was called. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 B<REQUIRED> State => Str | ||
| 118 | |||
| 119 | The state of the assessment run. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> StateChangedAt => Str | ||
| 123 | |||
| 124 | The last time when the assessment run's state changed. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 B<REQUIRED> StateChanges => ArrayRef[L<Paws::Inspector::AssessmentRunStateChange>] | ||
| 128 | |||
| 129 | A list of the assessment run state changes. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 B<REQUIRED> UserAttributesForFindings => ArrayRef[L<Paws::Inspector::Attribute>] | ||
| 133 | |||
| 134 | The user-defined attributes that are assigned to every generated | ||
| 135 | finding. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head1 SEE ALSO | ||
| 140 | |||
| 141 | This class forms part of L<Paws>, describing an object used in L<Paws::Inspector> | ||
| 142 | |||
| 143 | =head1 BUGS and CONTRIBUTIONS | ||
| 144 | |||
| 145 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 146 | |||
| 147 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 148 | |||
| 149 | =cut | ||
| 150 |