« blib/lib/Paws/FMS/GetPolicyResponse.pm
↑ Summary
blib/lib/Paws/FMS/GetProtectionStatusResponse.pm »
| 1 | |||
| 2 | package Paws::FMS::GetProtectionStatus; | ||
| 3 | use Moose; | ||
| 4 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has MemberAccountId => (is => 'ro', isa => 'Str'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has PolicyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetProtectionStatus'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::FMS::GetProtectionStatusResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::FMS::GetProtectionStatus - Arguments for method GetProtectionStatus on L<Paws::FMS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetProtectionStatus on the | ||
| 27 | L<Firewall Management Service|Paws::FMS> service. Use the attributes of this class | ||
| 28 | as arguments to method GetProtectionStatus. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetProtectionStatus. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $fms = Paws->service('FMS'); | ||
| 35 | my $GetProtectionStatusResponse = $fms->GetProtectionStatus( | ||
| 36 | PolicyId => 'MyPolicyId', | ||
| 37 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | MemberAccountId => 'MyAWSAccountId', # OPTIONAL | ||
| 40 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 41 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $AdminAccountId = $GetProtectionStatusResponse->AdminAccountId; | ||
| 46 | my $Data = $GetProtectionStatusResponse->Data; | ||
| 47 | my $NextToken = $GetProtectionStatusResponse->NextToken; | ||
| 48 | my $ServiceType = $GetProtectionStatusResponse->ServiceType; | ||
| 49 | |||
| 50 | # Returns a L<Paws::FMS::GetProtectionStatusResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/fms/GetProtectionStatus> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 EndTime => Str | ||
| 59 | |||
| 60 | The end of the time period to query for the attacks. This is a | ||
| 61 | C<timestamp> type. The request syntax listing indicates a C<number> | ||
| 62 | type because the default used by AWS Firewall Manager is Unix time in | ||
| 63 | seconds. However, any valid C<timestamp> format is allowed. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 MaxResults => Int | ||
| 68 | |||
| 69 | Specifies the number of objects that you want AWS Firewall Manager to | ||
| 70 | return for this request. If you have more objects than the number that | ||
| 71 | you specify for C<MaxResults>, the response includes a C<NextToken> | ||
| 72 | value that you can use to get another batch of objects. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 MemberAccountId => Str | ||
| 77 | |||
| 78 | The AWS account that is in scope of the policy that you want to get the | ||
| 79 | details for. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 NextToken => Str | ||
| 84 | |||
| 85 | If you specify a value for C<MaxResults> and you have more objects than | ||
| 86 | the number that you specify for C<MaxResults>, AWS Firewall Manager | ||
| 87 | returns a C<NextToken> value in the response, which you can use to | ||
| 88 | retrieve another group of objects. For the second and subsequent | ||
| 89 | C<GetProtectionStatus> requests, specify the value of C<NextToken> from | ||
| 90 | the previous response to get information about another batch of | ||
| 91 | objects. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> PolicyId => Str | ||
| 96 | |||
| 97 | The ID of the policy for which you want to get the attack information. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 StartTime => Str | ||
| 102 | |||
| 103 | The start of the time period to query for the attacks. This is a | ||
| 104 | C<timestamp> type. The request syntax listing indicates a C<number> | ||
| 105 | type because the default used by AWS Firewall Manager is Unix time in | ||
| 106 | seconds. However, any valid C<timestamp> format is allowed. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method GetProtectionStatus in L<Paws::FMS> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |