NAME

Paws::IoT::TestAuthorization - Arguments for method TestAuthorization on Paws::IoT

DESCRIPTION

This class represents the parameters used for calling the method TestAuthorization on the AWS IoT service. Use the attributes of this class as arguments to method TestAuthorization.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TestAuthorization.

SYNOPSIS

my $iot = Paws->service('IoT');
my $TestAuthorizationResponse = $iot->TestAuthorization(
  AuthInfos => [
    {
      Resources => [
        'MyResource', ...    # max: 2048
      ],
      ActionType =>
        'PUBLISH',  # values: PUBLISH, SUBSCRIBE, RECEIVE, CONNECT; OPTIONAL
    },
    ...
  ],
  ClientId              => 'MyClientId',                 # OPTIONAL
  CognitoIdentityPoolId => 'MyCognitoIdentityPoolId',    # OPTIONAL
  PolicyNamesToAdd      => [
    'MyPolicyName', ...                                  # min: 1, max: 128
  ],    # OPTIONAL
  PolicyNamesToSkip => [
    'MyPolicyName', ...    # min: 1, max: 128
  ],    # OPTIONAL
  Principal => 'MyPrincipal',    # OPTIONAL
);

# Results:
my $AuthResults = $TestAuthorizationResponse->AuthResults;

# Returns a L<Paws::IoT::TestAuthorizationResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/iot/TestAuthorization

ATTRIBUTES

REQUIRED AuthInfos => ArrayRef[Paws::IoT::AuthInfo]

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

ClientId => Str

The MQTT client ID.

CognitoIdentityPoolId => Str

The Cognito identity pool ID.

PolicyNamesToAdd => ArrayRef[Str|Undef]

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

PolicyNamesToSkip => ArrayRef[Str|Undef]

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

Principal => Str

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

SEE ALSO

This class forms part of Paws, documenting arguments for method TestAuthorization in Paws::IoT

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues