AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the TestAuthorization operation. Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.

Requires permission to access the TestAuthorization action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoT.AmazonIoTRequest
      Amazon.IoT.Model.TestAuthorizationRequest

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C# 
public class TestAuthorizationRequest : AmazonIoTRequest
         IAmazonWebServiceRequest

The TestAuthorizationRequest type exposes the following members

Constructors

NameDescription
Public Method TestAuthorizationRequest()

Properties

NameTypeDescription
Public Property AuthInfos System.Collections.Generic.List<Amazon.IoT.Model.AuthInfo>

Gets and sets the property AuthInfos.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property ClientId System.String

Gets and sets the property ClientId.

The MQTT client ID.

Public Property CognitoIdentityPoolId System.String

Gets and sets the property CognitoIdentityPoolId.

The Cognito identity pool ID.

Public Property PolicyNamesToAdd System.Collections.Generic.List<System.String>

Gets and sets the property PolicyNamesToAdd.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property PolicyNamesToSkip System.Collections.Generic.List<System.String>

Gets and sets the property PolicyNamesToSkip.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property Principal System.String

Gets and sets the property Principal.

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).

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer