« blib/lib/Paws/IoT/TaskStatisticsForAuditCheck.pm
↑ Summary
blib/lib/Paws/IoT/TestAuthorizationResponse.pm »
| 1 | |||
| 2 | package Paws::IoT::TestAuthorization; | ||
| 3 | use Moose; | ||
| 4 | has AuthInfos => (is => 'ro', isa => 'ArrayRef[Paws::IoT::AuthInfo]', traits => ['NameInRequest'], request_name => 'authInfos', required => 1); | ||
| 5 | has ClientId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'clientId'); | ||
| 6 | has CognitoIdentityPoolId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cognitoIdentityPoolId'); | ||
| 7 | has PolicyNamesToAdd => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'policyNamesToAdd'); | ||
| 8 | has PolicyNamesToSkip => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'policyNamesToSkip'); | ||
| 9 | has Principal => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'principal'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'TestAuthorization'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/test-authorization'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::TestAuthorizationResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::IoT::TestAuthorization - Arguments for method TestAuthorization on L<Paws::IoT> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method TestAuthorization on the | ||
| 28 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 29 | as arguments to method TestAuthorization. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TestAuthorization. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $iot = Paws->service('IoT'); | ||
| 36 | my $TestAuthorizationResponse = $iot->TestAuthorization( | ||
| 37 | AuthInfos => [ | ||
| 38 | { | ||
| 39 | Resources => [ | ||
| 40 | 'MyResource', ... # max: 2048 | ||
| 41 | ], | ||
| 42 | ActionType => | ||
| 43 | 'PUBLISH', # values: PUBLISH, SUBSCRIBE, RECEIVE, CONNECT; OPTIONAL | ||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], | ||
| 47 | ClientId => 'MyClientId', # OPTIONAL | ||
| 48 | CognitoIdentityPoolId => 'MyCognitoIdentityPoolId', # OPTIONAL | ||
| 49 | PolicyNamesToAdd => [ | ||
| 50 | 'MyPolicyName', ... # min: 1, max: 128 | ||
| 51 | ], # OPTIONAL | ||
| 52 | PolicyNamesToSkip => [ | ||
| 53 | 'MyPolicyName', ... # min: 1, max: 128 | ||
| 54 | ], # OPTIONAL | ||
| 55 | Principal => 'MyPrincipal', # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $AuthResults = $TestAuthorizationResponse->AuthResults; | ||
| 60 | |||
| 61 | # Returns a L<Paws::IoT::TestAuthorizationResponse> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/TestAuthorization> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> AuthInfos => ArrayRef[L<Paws::IoT::AuthInfo>] | ||
| 70 | |||
| 71 | A list of authorization info objects. Simulating authorization will | ||
| 72 | create a response for each C<authInfo> object in the list. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 ClientId => Str | ||
| 77 | |||
| 78 | The MQTT client ID. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 CognitoIdentityPoolId => Str | ||
| 83 | |||
| 84 | The Cognito identity pool ID. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 PolicyNamesToAdd => ArrayRef[Str|Undef] | ||
| 89 | |||
| 90 | When testing custom authorization, the policies specified here are | ||
| 91 | treated as if they are attached to the principal being authorized. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 PolicyNamesToSkip => ArrayRef[Str|Undef] | ||
| 96 | |||
| 97 | When testing custom authorization, the policies specified here are | ||
| 98 | treated as if they are not attached to the principal being authorized. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 Principal => Str | ||
| 103 | |||
| 104 | The principal. Valid principals are CertificateArn | ||
| 105 | (arn:aws:iot:I<region>:I<accountId>:cert/I<certificateId>), | ||
| 106 | thingGroupArn | ||
| 107 | (arn:aws:iot:I<region>:I<accountId>:thinggroup/I<groupName>) and | ||
| 108 | CognitoId (I<region>:I<id>). | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, documenting arguments for method TestAuthorization in L<Paws::IoT> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |