Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. smsvoice
  5. getPhoneNumber

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.35.0 published on Monday, Sep 22, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.smsvoice.getPhoneNumber

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.35.0 published on Monday, Sep 22, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SMSVOICE::PhoneNumber

    Using getPhoneNumber

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPhoneNumber(args: GetPhoneNumberArgs, opts?: InvokeOptions): Promise<GetPhoneNumberResult>
function getPhoneNumberOutput(args: GetPhoneNumberOutputArgs, opts?: InvokeOptions): Output<GetPhoneNumberResult>
    def get_phone_number(phone_number_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPhoneNumberResult
def get_phone_number_output(phone_number_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPhoneNumberResult]
    func LookupPhoneNumber(ctx *Context, args *LookupPhoneNumberArgs, opts ...InvokeOption) (*LookupPhoneNumberResult, error)
func LookupPhoneNumberOutput(ctx *Context, args *LookupPhoneNumberOutputArgs, opts ...InvokeOption) LookupPhoneNumberResultOutput

    > Note: This function is named LookupPhoneNumber in the Go SDK.

    public static class GetPhoneNumber 
{
    public static Task<GetPhoneNumberResult> InvokeAsync(GetPhoneNumberArgs args, InvokeOptions? opts = null)
    public static Output<GetPhoneNumberResult> Invoke(GetPhoneNumberInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPhoneNumberResult> getPhoneNumber(GetPhoneNumberArgs args, InvokeOptions options)
public static Output<GetPhoneNumberResult> getPhoneNumber(GetPhoneNumberArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:smsvoice:getPhoneNumber
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PhoneNumberId string
    The unique identifier for the phone number.
    PhoneNumberId string
    The unique identifier for the phone number.
    phoneNumberId String
    The unique identifier for the phone number.
    phoneNumberId string
    The unique identifier for the phone number.
    phone_number_id str
    The unique identifier for the phone number.
    phoneNumberId String
    The unique identifier for the phone number.

    getPhoneNumber Result

    The following output properties are available:

    Arn string
    The PhoneNumber 's Amazon Resource Name (ARN)
    DeletionProtectionEnabled bool
    When set to true the sender ID can't be deleted. By default this is set to false.
    MandatoryKeywords Pulumi.AwsNative.Smsvoice.Outputs.MandatoryKeywordsProperties
    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
    OptOutListName string
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    OptionalKeywords List<Pulumi.AwsNative.Smsvoice.Outputs.PhoneNumberOptionalKeyword>
    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.
    PhoneNumberId string
    The unique identifier for the phone number.
    PhoneNumberValue string
    The phone number in E.164 format.
    SelfManagedOptOutsEnabled bool
    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.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    TwoWay Pulumi.AwsNative.Smsvoice.Outputs.TwoWayProperties
    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.
    Arn string
    The PhoneNumber 's Amazon Resource Name (ARN)
    DeletionProtectionEnabled bool
    When set to true the sender ID can't be deleted. By default this is set to false.
    MandatoryKeywords MandatoryKeywordsProperties
    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
    OptOutListName string
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    OptionalKeywords []PhoneNumberOptionalKeyword
    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.
    PhoneNumber string
    The phone number in E.164 format.
    PhoneNumberId string
    The unique identifier for the phone number.
    SelfManagedOptOutsEnabled bool
    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.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    TwoWay TwoWayProperties
    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.
    arn String
    The PhoneNumber 's Amazon Resource Name (ARN)
    deletionProtectionEnabled Boolean
    When set to true the sender ID can't be deleted. By default this is set to false.
    mandatoryKeywords MandatoryKeywordsProperties
    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
    optOutListName String
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    optionalKeywords List<PhoneNumberOptionalKeyword>
    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.
    phoneNumber String
    The phone number in E.164 format.
    phoneNumberId String
    The unique identifier for the phone number.
    selfManagedOptOutsEnabled Boolean
    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.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    twoWay TwoWayProperties
    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.
    arn string
    The PhoneNumber 's Amazon Resource Name (ARN)
    deletionProtectionEnabled boolean
    When set to true the sender ID can't be deleted. By default this is set to false.
    mandatoryKeywords MandatoryKeywordsProperties
    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
    optOutListName string
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    optionalKeywords PhoneNumberOptionalKeyword[]
    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.
    phoneNumber string
    The phone number in E.164 format.
    phoneNumberId string
    The unique identifier for the phone number.
    selfManagedOptOutsEnabled boolean
    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.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    twoWay TwoWayProperties
    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.
    arn str
    The PhoneNumber 's Amazon Resource Name (ARN)
    deletion_protection_enabled bool
    When set to true the sender ID can't be deleted. By default this is set to false.
    mandatory_keywords MandatoryKeywordsProperties
    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
    opt_out_list_name str
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    optional_keywords Sequence[PhoneNumberOptionalKeyword]
    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.
    phone_number str
    The phone number in E.164 format.
    phone_number_id str
    The unique identifier for the phone number.
    self_managed_opt_outs_enabled bool
    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.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    two_way TwoWayProperties
    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.
    arn String
    The PhoneNumber 's Amazon Resource Name (ARN)
    deletionProtectionEnabled Boolean
    When set to true the sender ID can't be deleted. By default this is set to false.
    mandatoryKeywords Property Map
    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
    optOutListName String
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    optionalKeywords List<Property Map>
    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.
    phoneNumber String
    The phone number in E.164 format.
    phoneNumberId String
    The unique identifier for the phone number.
    selfManagedOptOutsEnabled Boolean
    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.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    twoWay Property Map
    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.

    Supporting Types

    MandatoryKeywordsProperties

    Help Pulumi.AwsNative.Smsvoice.Inputs.PoolMandatoryKeyword
    Specifies the pool's HELP keyword. For more information, see Opt out list required keywords in the End User Messaging User Guide.
    Stop Pulumi.AwsNative.Smsvoice.Inputs.PoolMandatoryKeyword
    Specifies the pool's opt-out keyword. For more information, see Required opt-out keywords in the End User Messaging User Guide.
    Help PoolMandatoryKeyword
    Specifies the pool's HELP keyword. For more information, see Opt out list required keywords in the End User Messaging User Guide.
    Stop PoolMandatoryKeyword
    Specifies the pool's opt-out keyword. For more information, see Required opt-out keywords in the End User Messaging User Guide.
    help PoolMandatoryKeyword
    Specifies the pool's HELP keyword. For more information, see Opt out list required keywords in the End User Messaging User Guide.
    stop PoolMandatoryKeyword
    Specifies the pool's opt-out keyword. For more information, see Required opt-out keywords in the End User Messaging User Guide.
    help PoolMandatoryKeyword
    Specifies the pool's HELP keyword. For more information, see Opt out list required keywords in the End User Messaging User Guide.
    stop PoolMandatoryKeyword
    Specifies the pool's opt-out keyword. For more information, see Required opt-out keywords in the End User Messaging User Guide.
    help PoolMandatoryKeyword
    Specifies the pool's HELP keyword. For more information, see Opt out list required keywords in the End User Messaging User Guide.
    stop PoolMandatoryKeyword
    Specifies the pool's opt-out keyword. For more information, see Required opt-out keywords in the End User Messaging User Guide.
    help Property Map
    Specifies the pool's HELP keyword. For more information, see Opt out list required keywords in the End User Messaging User Guide.
    stop Property Map
    Specifies the pool's opt-out keyword. For more information, see Required opt-out keywords in the End User Messaging User Guide.

    PhoneNumberOptionalKeyword

    Action Pulumi.AwsNative.Smsvoice.PhoneNumberOptionalKeywordAction
    The action to perform when the keyword is used.
    Keyword string
    The new keyword to add.
    Message string
    The message associated with the keyword.
    Action PhoneNumberOptionalKeywordAction
    The action to perform when the keyword is used.
    Keyword string
    The new keyword to add.
    Message string
    The message associated with the keyword.
    action PhoneNumberOptionalKeywordAction
    The action to perform when the keyword is used.
    keyword String
    The new keyword to add.
    message String
    The message associated with the keyword.
    action PhoneNumberOptionalKeywordAction
    The action to perform when the keyword is used.
    keyword string
    The new keyword to add.
    message string
    The message associated with the keyword.
    action PhoneNumberOptionalKeywordAction
    The action to perform when the keyword is used.
    keyword str
    The new keyword to add.
    message str
    The message associated with the keyword.
    action "AUTOMATIC_RESPONSE" | "OPT_OUT" | "OPT_IN"
    The action to perform when the keyword is used.
    keyword String
    The new keyword to add.
    message String
    The message associated with the keyword.

    PhoneNumberOptionalKeywordAction

    PoolMandatoryKeyword

    Message string
    The message associated with the keyword.
    Message string
    The message associated with the keyword.
    message String
    The message associated with the keyword.
    message string
    The message associated with the keyword.
    message str
    The message associated with the keyword.
    message String
    The message associated with the keyword.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TwoWayProperties

    Enabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    ChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    ChannelRole string
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    Enabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    ChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    ChannelRole string
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    enabled Boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    channelArn String
    The Amazon Resource Name (ARN) of the two way channel.
    channelRole String
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    enabled boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    channelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    channelRole string
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    enabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    channel_arn str
    The Amazon Resource Name (ARN) of the two way channel.
    channel_role str
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    enabled Boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    channelArn String
    The Amazon Resource Name (ARN) of the two way channel.
    channelRole String
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.35.0 published on Monday, Sep 22, 2025 by Pulumi
    pulumi/pulumi-aws-native