@pulumi/aws-native/smsvoice/getPool.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::Pool
 */
export declare function getPool(args: GetPoolArgs, opts?: pulumi.InvokeOptions): Promise<GetPoolResult>;
export interface GetPoolArgs {
    /**
     * The unique identifier for the pool.
     */
    poolId: string;
}
export interface GetPoolResult {
    /**
     * The Amazon Resource Name of the `Pool` .
     */
    readonly arn?: string;
    /**
     * When set to true the pool 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 pool. 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.PoolOptionalKeyword[];
    /**
     * The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn and it's IsoCountryCode.
     */
    readonly originationIdentities?: string[];
    /**
     * The unique identifier for the pool.
     */
    readonly poolId?: 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;
    /**
     * Indicates whether shared routes are enabled for the pool.
     */
    readonly sharedRoutesEnabled?: 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::Pool
 */
export declare function getPoolOutput(args: GetPoolOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPoolResult>;
export interface GetPoolOutputArgs {
    /**
     * The unique identifier for the pool.
     */
    poolId: pulumi.Input<string>;
}