« blib/lib/Paws/Inspector/GetAssessmentReportResponse.pm
↑ Summary
blib/lib/Paws/Inspector/GetExclusionsPreviewResponse.pm »
| 1 | |||
| 2 | package Paws::Inspector::GetExclusionsPreview; | ||
| 3 | use Moose; | ||
| 4 | has AssessmentTemplateArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'assessmentTemplateArn' , required => 1); | ||
| 5 | has Locale => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'locale' ); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 8 | has PreviewToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'previewToken' , required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetExclusionsPreview'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Inspector::GetExclusionsPreviewResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Inspector::GetExclusionsPreview - Arguments for method GetExclusionsPreview on L<Paws::Inspector> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetExclusionsPreview on the | ||
| 26 | L<Amazon Inspector|Paws::Inspector> service. Use the attributes of this class | ||
| 27 | as arguments to method GetExclusionsPreview. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetExclusionsPreview. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $inspector = Paws->service('Inspector'); | ||
| 34 | my $GetExclusionsPreviewResponse = $inspector->GetExclusionsPreview( | ||
| 35 | AssessmentTemplateArn => 'MyArn', | ||
| 36 | PreviewToken => 'MyUUID', | ||
| 37 | Locale => 'EN_US', # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $ExclusionPreviews = $GetExclusionsPreviewResponse->ExclusionPreviews; | ||
| 44 | my $NextToken = $GetExclusionsPreviewResponse->NextToken; | ||
| 45 | my $PreviewStatus = $GetExclusionsPreviewResponse->PreviewStatus; | ||
| 46 | |||
| 47 | # Returns a L<Paws::Inspector::GetExclusionsPreviewResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/inspector/GetExclusionsPreview> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> AssessmentTemplateArn => Str | ||
| 56 | |||
| 57 | The ARN that specifies the assessment template for which the exclusions | ||
| 58 | preview was requested. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 Locale => Str | ||
| 63 | |||
| 64 | The locale into which you want to translate the exclusion's title, | ||
| 65 | description, and recommendation. | ||
| 66 | |||
| 67 | Valid values are: C<"EN_US"> | ||
| 68 | |||
| 69 | =head2 MaxResults => Int | ||
| 70 | |||
| 71 | You can use this parameter to indicate the maximum number of items you | ||
| 72 | want in the response. The default value is 100. The maximum value is | ||
| 73 | 500. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 NextToken => Str | ||
| 78 | |||
| 79 | You can use this parameter when paginating results. Set the value of | ||
| 80 | this parameter to null on your first call to the | ||
| 81 | GetExclusionsPreviewRequest action. Subsequent calls to the action fill | ||
| 82 | nextToken in the request with the value of nextToken from the previous | ||
| 83 | response to continue listing data. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> PreviewToken => Str | ||
| 88 | |||
| 89 | The unique identifier associated of the exclusions preview. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method GetExclusionsPreview in L<Paws::Inspector> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |