« blib/lib/Paws/FMS/ListAppsListsResponse.pm
↑ Summary
blib/lib/Paws/FMS/ListComplianceStatusResponse.pm »
| 1 | |||
| 2 | package Paws::FMS::ListComplianceStatus; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has PolicyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListComplianceStatus'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::FMS::ListComplianceStatusResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::FMS::ListComplianceStatus - Arguments for method ListComplianceStatus on L<Paws::FMS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListComplianceStatus on the | ||
| 24 | L<Firewall Management Service|Paws::FMS> service. Use the attributes of this class | ||
| 25 | as arguments to method ListComplianceStatus. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListComplianceStatus. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $fms = Paws->service('FMS'); | ||
| 32 | my $ListComplianceStatusResponse = $fms->ListComplianceStatus( | ||
| 33 | PolicyId => 'MyPolicyId', | ||
| 34 | MaxResults => 1, # OPTIONAL | ||
| 35 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $NextToken = $ListComplianceStatusResponse->NextToken; | ||
| 40 | my $PolicyComplianceStatusList = | ||
| 41 | $ListComplianceStatusResponse->PolicyComplianceStatusList; | ||
| 42 | |||
| 43 | # Returns a L<Paws::FMS::ListComplianceStatusResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/fms/ListComplianceStatus> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 MaxResults => Int | ||
| 52 | |||
| 53 | Specifies the number of C<PolicyComplianceStatus> objects that you want | ||
| 54 | AWS Firewall Manager to return for this request. If you have more | ||
| 55 | C<PolicyComplianceStatus> objects than the number that you specify for | ||
| 56 | C<MaxResults>, the response includes a C<NextToken> value that you can | ||
| 57 | use to get another batch of C<PolicyComplianceStatus> objects. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 NextToken => Str | ||
| 62 | |||
| 63 | If you specify a value for C<MaxResults> and you have more | ||
| 64 | C<PolicyComplianceStatus> objects than the number that you specify for | ||
| 65 | C<MaxResults>, AWS Firewall Manager returns a C<NextToken> value in the | ||
| 66 | response that allows you to list another group of | ||
| 67 | C<PolicyComplianceStatus> objects. For the second and subsequent | ||
| 68 | C<ListComplianceStatus> requests, specify the value of C<NextToken> | ||
| 69 | from the previous response to get information about another batch of | ||
| 70 | C<PolicyComplianceStatus> objects. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> PolicyId => Str | ||
| 75 | |||
| 76 | The ID of the AWS Firewall Manager policy that you want the details | ||
| 77 | for. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, documenting arguments for method ListComplianceStatus in L<Paws::FMS> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |