@pulumi/aws-native/smsvoice/getPhoneNumber.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Resource Type definition for AWS::SMSVOICE::PhoneNumber
 */
export declare function getPhoneNumber(args: GetPhoneNumberArgs, opts?: pulumi.InvokeOptions): Promise<GetPhoneNumberResult>;
export interface GetPhoneNumberArgs {
    /**
     * The unique identifier for the phone number.
     */
    phoneNumberId: string;
}
export interface GetPhoneNumberResult {
    /**
     * The `PhoneNumber` 's Amazon Resource Name (ARN)
     */
    readonly arn?: string;
    /**
     * When set to true the sender ID can't be deleted. By default this is set to false.
     */
    readonly deletionProtectionEnabled?: boolean;
    /**
     * A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
     */
    readonly mandatoryKeywords?: outputs.smsvoice.MandatoryKeywordsProperties;
    /**
     * The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
     */
    readonly optOutListName?: string;
    /**
     * A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
     */
    readonly optionalKeywords?: outputs.smsvoice.PhoneNumberOptionalKeyword[];
    /**
     * The phone number in E.164 format.
     */
    readonly phoneNumber?: string;
    /**
     * The unique identifier for the phone number.
     */
    readonly phoneNumberId?: string;
    /**
     * By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
     */
    readonly selfManagedOptOutsEnabled?: boolean;
    /**
     * An array of key-value pairs to apply to this resource.
     */
    readonly tags?: outputs.Tag[];
    /**
     * When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
     */
    readonly twoWay?: outputs.smsvoice.TwoWayProperties;
}
/**
 * Resource Type definition for AWS::SMSVOICE::PhoneNumber
 */
export declare function getPhoneNumberOutput(args: GetPhoneNumberOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPhoneNumberResult>;
export interface GetPhoneNumberOutputArgs {
    /**
     * The unique identifier for the phone number.
     */
    phoneNumberId: pulumi.Input<string>;
}