@aws-sdk/client-iot/dist-types/commands/TestAuthorizationCommand.d.ts

AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native

import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { TestAuthorizationRequest, TestAuthorizationResponse } from "../models/models_2";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link TestAuthorizationCommand}.
 */
export interface TestAuthorizationCommandInput extends TestAuthorizationRequest {
}
/**
 * @public
 *
 * The output of {@link TestAuthorizationCommand}.
 */
export interface TestAuthorizationCommandOutput extends TestAuthorizationResponse, __MetadataBearer {
}
declare const TestAuthorizationCommand_base: {
    new (input: TestAuthorizationCommandInput): import("@smithy/smithy-client").CommandImpl<TestAuthorizationCommandInput, TestAuthorizationCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (input: TestAuthorizationCommandInput): import("@smithy/smithy-client").CommandImpl<TestAuthorizationCommandInput, TestAuthorizationCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
 * <p>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.</p>
 *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TestAuthorization</a> action.</p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { IoTClient, TestAuthorizationCommand } from "@aws-sdk/client-iot"; // ES Modules import
 * // const { IoTClient, TestAuthorizationCommand } = require("@aws-sdk/client-iot"); // CommonJS import
 * const client = new IoTClient(config);
 * const input = { // TestAuthorizationRequest
 *   principal: "STRING_VALUE",
 *   cognitoIdentityPoolId: "STRING_VALUE",
 *   authInfos: [ // AuthInfos // required
 *     { // AuthInfo
 *       actionType: "PUBLISH" || "SUBSCRIBE" || "RECEIVE" || "CONNECT",
 *       resources: [ // Resources // required
 *         "STRING_VALUE",
 *       ],
 *     },
 *   ],
 *   clientId: "STRING_VALUE",
 *   policyNamesToAdd: [ // PolicyNames
 *     "STRING_VALUE",
 *   ],
 *   policyNamesToSkip: [
 *     "STRING_VALUE",
 *   ],
 * };
 * const command = new TestAuthorizationCommand(input);
 * const response = await client.send(command);
 * // { // TestAuthorizationResponse
 * //   authResults: [ // AuthResults
 * //     { // AuthResult
 * //       authInfo: { // AuthInfo
 * //         actionType: "PUBLISH" || "SUBSCRIBE" || "RECEIVE" || "CONNECT",
 * //         resources: [ // Resources // required
 * //           "STRING_VALUE",
 * //         ],
 * //       },
 * //       allowed: { // Allowed
 * //         policies: [ // Policies
 * //           { // Policy
 * //             policyName: "STRING_VALUE",
 * //             policyArn: "STRING_VALUE",
 * //           },
 * //         ],
 * //       },
 * //       denied: { // Denied
 * //         implicitDeny: { // ImplicitDeny
 * //           policies: [
 * //             {
 * //               policyName: "STRING_VALUE",
 * //               policyArn: "STRING_VALUE",
 * //             },
 * //           ],
 * //         },
 * //         explicitDeny: { // ExplicitDeny
 * //           policies: [
 * //             {
 * //               policyName: "STRING_VALUE",
 * //               policyArn: "STRING_VALUE",
 * //             },
 * //           ],
 * //         },
 * //       },
 * //       authDecision: "ALLOWED" || "EXPLICIT_DENY" || "IMPLICIT_DENY",
 * //       missingContextValues: [ // MissingContextValues
 * //         "STRING_VALUE",
 * //       ],
 * //     },
 * //   ],
 * // };
 *
 * ```
 *
 * @param TestAuthorizationCommandInput - {@link TestAuthorizationCommandInput}
 * @returns {@link TestAuthorizationCommandOutput}
 * @see {@link TestAuthorizationCommandInput} for command's `input` shape.
 * @see {@link TestAuthorizationCommandOutput} for command's `response` shape.
 * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape.
 *
 * @throws {@link InternalFailureException} (server fault)
 *  <p>An unexpected error has occurred.</p>
 *
 * @throws {@link InvalidRequestException} (client fault)
 *  <p>The request is not valid.</p>
 *
 * @throws {@link LimitExceededException} (client fault)
 *  <p>A limit has been exceeded.</p>
 *
 * @throws {@link ResourceNotFoundException} (client fault)
 *  <p>The specified resource does not exist.</p>
 *
 * @throws {@link ServiceUnavailableException} (server fault)
 *  <p>The service is temporarily unavailable.</p>
 *
 * @throws {@link ThrottlingException} (client fault)
 *  <p>The rate exceeds the limit.</p>
 *
 * @throws {@link UnauthorizedException} (client fault)
 *  <p>You are not authorized to perform this operation.</p>
 *
 * @throws {@link IoTServiceException}
 * <p>Base exception class for all service exceptions from IoT service.</p>
 *
 *
 * @public
 */
export declare class TestAuthorizationCommand extends TestAuthorizationCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: TestAuthorizationRequest;
            output: TestAuthorizationResponse;
        };
        sdk: {
            input: TestAuthorizationCommandInput;
            output: TestAuthorizationCommandOutput;
        };
    };
}