« blib/lib/Paws/AccessAnalyzer/UpdateFindings.pm
↑ Summary
blib/lib/Paws/AccessAnalyzer/ValidatePolicyFinding.pm »
| 1 | |||
| 2 | package Paws::AccessAnalyzer::ValidatePolicy; | ||
| 3 | use Moose; | ||
| 4 | has Locale => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'locale'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 7 | has PolicyDocument => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'policyDocument', required => 1); | ||
| 8 | has PolicyType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'policyType', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ValidatePolicy'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/policy/validation'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AccessAnalyzer::ValidatePolicyResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::AccessAnalyzer::ValidatePolicy - Arguments for method ValidatePolicy on L<Paws::AccessAnalyzer> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ValidatePolicy on the | ||
| 27 | L<Access Analyzer|Paws::AccessAnalyzer> service. Use the attributes of this class | ||
| 28 | as arguments to method ValidatePolicy. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ValidatePolicy. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $access-analyzer = Paws->service('AccessAnalyzer'); | ||
| 35 | my $ValidatePolicyResponse = $access -analyzer->ValidatePolicy( | ||
| 36 | PolicyDocument => 'MyPolicyDocument', | ||
| 37 | PolicyType => 'IDENTITY_POLICY', | ||
| 38 | Locale => 'DE', # OPTIONAL | ||
| 39 | MaxResults => 1, # OPTIONAL | ||
| 40 | NextToken => 'MyToken', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Findings = $ValidatePolicyResponse->Findings; | ||
| 45 | my $NextToken = $ValidatePolicyResponse->NextToken; | ||
| 46 | |||
| 47 | # Returns a L<Paws::AccessAnalyzer::ValidatePolicyResponse> 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/access-analyzer/ValidatePolicy> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Locale => Str | ||
| 56 | |||
| 57 | The locale to use for localizing the findings. | ||
| 58 | |||
| 59 | Valid values are: C<"DE">, C<"EN">, C<"ES">, C<"FR">, C<"IT">, C<"JA">, C<"KO">, C<"PT_BR">, C<"ZH_CN">, C<"ZH_TW"> | ||
| 60 | |||
| 61 | =head2 MaxResults => Int | ||
| 62 | |||
| 63 | The maximum number of results to return in the response. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 NextToken => Str | ||
| 68 | |||
| 69 | A token used for pagination of results returned. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> PolicyDocument => Str | ||
| 74 | |||
| 75 | The JSON policy document to use as the content for the policy. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> PolicyType => Str | ||
| 80 | |||
| 81 | The type of policy to validate. Identity policies grant permissions to | ||
| 82 | IAM principals. Identity policies include managed and inline policies | ||
| 83 | for IAM roles, users, and groups. They also include service-control | ||
| 84 | policies (SCPs) that are attached to an AWS organization, | ||
| 85 | organizational unit (OU), or an account. | ||
| 86 | |||
| 87 | Resource policies grant permissions on AWS resources. Resource policies | ||
| 88 | include trust policies for IAM roles and bucket policies for S3 | ||
| 89 | buckets. You can provide a generic input such as identity policy or | ||
| 90 | resource policy or a specific input such as managed policy or S3 bucket | ||
| 91 | policy. | ||
| 92 | |||
| 93 | Valid values are: C<"IDENTITY_POLICY">, C<"RESOURCE_POLICY">, C<"SERVICE_CONTROL_POLICY"> | ||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method ValidatePolicy in L<Paws::AccessAnalyzer> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |