import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CheckIfPhoneNumberIsOptedOutInput, CheckIfPhoneNumberIsOptedOutResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CheckIfPhoneNumberIsOptedOutCommand}. */ export interface CheckIfPhoneNumberIsOptedOutCommandInput extends CheckIfPhoneNumberIsOptedOutInput { } /** * @public * * The output of {@link CheckIfPhoneNumberIsOptedOutCommand}. */ export interface CheckIfPhoneNumberIsOptedOutCommandOutput extends CheckIfPhoneNumberIsOptedOutResponse, __MetadataBearer { } declare const CheckIfPhoneNumberIsOptedOutCommand_base: { new (input: CheckIfPhoneNumberIsOptedOutCommandInput): import("@smithy/core/client").CommandImpl; new (input: CheckIfPhoneNumberIsOptedOutCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Accepts a phone number and indicates whether the phone holder has opted out of * receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number * that is opted out.

*

To resume sending messages, you can opt in the number by using the * OptInPhoneNumber action.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SNSClient, CheckIfPhoneNumberIsOptedOutCommand } from "@aws-sdk/client-sns"; // ES Modules import * // const { SNSClient, CheckIfPhoneNumberIsOptedOutCommand } = require("@aws-sdk/client-sns"); // CommonJS import * // import type { SNSClientConfig } from "@aws-sdk/client-sns"; * const config = {}; // type is SNSClientConfig * const client = new SNSClient(config); * const input = { // CheckIfPhoneNumberIsOptedOutInput * phoneNumber: "STRING_VALUE", // required * }; * const command = new CheckIfPhoneNumberIsOptedOutCommand(input); * const response = await client.send(command); * // { // CheckIfPhoneNumberIsOptedOutResponse * // isOptedOut: true || false, * // }; * * ``` * * @param CheckIfPhoneNumberIsOptedOutCommandInput - {@link CheckIfPhoneNumberIsOptedOutCommandInput} * @returns {@link CheckIfPhoneNumberIsOptedOutCommandOutput} * @see {@link CheckIfPhoneNumberIsOptedOutCommandInput} for command's `input` shape. * @see {@link CheckIfPhoneNumberIsOptedOutCommandOutput} for command's `response` shape. * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape. * * @throws {@link AuthorizationErrorException} (client fault) *

Indicates that the user has been denied access to the requested resource.

* * @throws {@link InternalErrorException} (server fault) *

Indicates an internal service error.

* * @throws {@link InvalidParameterException} (client fault) *

Indicates that a request parameter does not comply with the associated * constraints.

* * @throws {@link ThrottledException} (client fault) *

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.

* * @throws {@link SNSServiceException} *

Base exception class for all service exceptions from SNS service.

* * * @public */ export declare class CheckIfPhoneNumberIsOptedOutCommand extends CheckIfPhoneNumberIsOptedOutCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CheckIfPhoneNumberIsOptedOutInput; output: CheckIfPhoneNumberIsOptedOutResponse; }; sdk: { input: CheckIfPhoneNumberIsOptedOutCommandInput; output: CheckIfPhoneNumberIsOptedOutCommandOutput; }; }; }