Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. pinpoint
  6. Smsvoicev2Keyword
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.pinpoint.Smsvoicev2Keyword

aws logo aws logo
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Manages an AWS End User Messaging SMS Keyword.

    Note: The mandatory keywords HELP and STOP exist on every origination identity and cannot be created or deleted independently of it. For these mandatory keywords only, this resource adopts and manages the keywordMessage in place, while keywordAction is managed by AWS and cannot be set. Destroying a resource that manages a mandatory keyword does not delete or reset it in AWS; the keyword remains on the origination identity with its last-applied message. Non-mandatory keywords are created and deleted normally.

    Example Usage

    Phone Number

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.pinpoint.Smsvoicev2PhoneNumber("example", {
    isoCountryCode: "US",
    messageType: "TRANSACTIONAL",
    numberType: "SIMULATOR",
    numberCapabilities: ["SMS"],
});
const exampleSmsvoicev2Keyword = new aws.pinpoint.Smsvoicev2Keyword("example", {
    originationIdentityArn: example.arn,
    keyword: "EXAMPLE",
    keywordMessage: "Thanks for messaging our example number.",
});

    import pulumi
import pulumi_aws as aws

example = aws.pinpoint.Smsvoicev2PhoneNumber("example",
    iso_country_code="US",
    message_type="TRANSACTIONAL",
    number_type="SIMULATOR",
    number_capabilities=["SMS"])
example_smsvoicev2_keyword = aws.pinpoint.Smsvoicev2Keyword("example",
    origination_identity_arn=example.arn,
    keyword="EXAMPLE",
    keyword_message="Thanks for messaging our example number.")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := pinpoint.NewSmsvoicev2PhoneNumber(ctx, "example", &pinpoint.Smsvoicev2PhoneNumberArgs{
			IsoCountryCode: pulumi.String("US"),
			MessageType:    pulumi.String("TRANSACTIONAL"),
			NumberType:     pulumi.String("SIMULATOR"),
			NumberCapabilities: pulumi.StringArray{
				pulumi.String("SMS"),
			},
		})
		if err != nil {
			return err
		}
		_, err = pinpoint.NewSmsvoicev2Keyword(ctx, "example", &pinpoint.Smsvoicev2KeywordArgs{
			OriginationIdentityArn: example.Arn,
			Keyword:                pulumi.String("EXAMPLE"),
			KeywordMessage:         pulumi.String("Thanks for messaging our example number."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Pinpoint.Smsvoicev2PhoneNumber("example", new()
    {
        IsoCountryCode = "US",
        MessageType = "TRANSACTIONAL",
        NumberType = "SIMULATOR",
        NumberCapabilities = new[]
        {
            "SMS",
        },
    });

    var exampleSmsvoicev2Keyword = new Aws.Pinpoint.Smsvoicev2Keyword("example", new()
    {
        OriginationIdentityArn = example.Arn,
        Keyword = "EXAMPLE",
        KeywordMessage = "Thanks for messaging our example number.",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.Smsvoicev2PhoneNumber;
import com.pulumi.aws.pinpoint.Smsvoicev2PhoneNumberArgs;
import com.pulumi.aws.pinpoint.Smsvoicev2Keyword;
import com.pulumi.aws.pinpoint.Smsvoicev2KeywordArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Smsvoicev2PhoneNumber("example", Smsvoicev2PhoneNumberArgs.builder()
            .isoCountryCode("US")
            .messageType("TRANSACTIONAL")
            .numberType("SIMULATOR")
            .numberCapabilities("SMS")
            .build());

        var exampleSmsvoicev2Keyword = new Smsvoicev2Keyword("exampleSmsvoicev2Keyword", Smsvoicev2KeywordArgs.builder()
            .originationIdentityArn(example.arn())
            .keyword("EXAMPLE")
            .keywordMessage("Thanks for messaging our example number.")
            .build());

    }
}

    resources:
  example:
    type: aws:pinpoint:Smsvoicev2PhoneNumber
    properties:
      isoCountryCode: US
      messageType: TRANSACTIONAL
      numberType: SIMULATOR
      numberCapabilities:
        - SMS
  exampleSmsvoicev2Keyword:
    type: aws:pinpoint:Smsvoicev2Keyword
    name: example
    properties:
      originationIdentityArn: ${example.arn}
      keyword: EXAMPLE
      keywordMessage: Thanks for messaging our example number.

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_pinpoint_smsvoicev2phonenumber" "example" {
  iso_country_code    = "US"
  message_type        = "TRANSACTIONAL"
  number_type         = "SIMULATOR"
  number_capabilities = ["SMS"]
}
resource "aws_pinpoint_smsvoicev2keyword" "example" {
  origination_identity_arn = aws_pinpoint_smsvoicev2phonenumber.example.arn
  keyword                  = "EXAMPLE"
  keyword_message          = "Thanks for messaging our example number."
}

    Pool

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.pinpoint.Smsvoicev2PhoneNumber("example", {
    isoCountryCode: "US",
    messageType: "TRANSACTIONAL",
    numberType: "SIMULATOR",
    numberCapabilities: ["SMS"],
});
const exampleSmsvoicev2Pool = new aws.pinpoint.Smsvoicev2Pool("example", {
    isoCountryCode: "US",
    messageType: "TRANSACTIONAL",
    originationIdentities: [example.arn],
});
const exampleSmsvoicev2Keyword = new aws.pinpoint.Smsvoicev2Keyword("example", {
    originationIdentityArn: exampleSmsvoicev2Pool.arn,
    keyword: "OPTOUT",
    keywordMessage: "You have been unsubscribed.",
    keywordAction: "OPT_OUT",
});

    import pulumi
import pulumi_aws as aws

example = aws.pinpoint.Smsvoicev2PhoneNumber("example",
    iso_country_code="US",
    message_type="TRANSACTIONAL",
    number_type="SIMULATOR",
    number_capabilities=["SMS"])
example_smsvoicev2_pool = aws.pinpoint.Smsvoicev2Pool("example",
    iso_country_code="US",
    message_type="TRANSACTIONAL",
    origination_identities=[example.arn])
example_smsvoicev2_keyword = aws.pinpoint.Smsvoicev2Keyword("example",
    origination_identity_arn=example_smsvoicev2_pool.arn,
    keyword="OPTOUT",
    keyword_message="You have been unsubscribed.",
    keyword_action="OPT_OUT")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := pinpoint.NewSmsvoicev2PhoneNumber(ctx, "example", &pinpoint.Smsvoicev2PhoneNumberArgs{
			IsoCountryCode: pulumi.String("US"),
			MessageType:    pulumi.String("TRANSACTIONAL"),
			NumberType:     pulumi.String("SIMULATOR"),
			NumberCapabilities: pulumi.StringArray{
				pulumi.String("SMS"),
			},
		})
		if err != nil {
			return err
		}
		exampleSmsvoicev2Pool, err := pinpoint.NewSmsvoicev2Pool(ctx, "example", &pinpoint.Smsvoicev2PoolArgs{
			IsoCountryCode: pulumi.String("US"),
			MessageType:    pulumi.String("TRANSACTIONAL"),
			OriginationIdentities: pulumi.StringArray{
				example.Arn,
			},
		})
		if err != nil {
			return err
		}
		_, err = pinpoint.NewSmsvoicev2Keyword(ctx, "example", &pinpoint.Smsvoicev2KeywordArgs{
			OriginationIdentityArn: exampleSmsvoicev2Pool.Arn,
			Keyword:                pulumi.String("OPTOUT"),
			KeywordMessage:         pulumi.String("You have been unsubscribed."),
			KeywordAction:          pulumi.String("OPT_OUT"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Pinpoint.Smsvoicev2PhoneNumber("example", new()
    {
        IsoCountryCode = "US",
        MessageType = "TRANSACTIONAL",
        NumberType = "SIMULATOR",
        NumberCapabilities = new[]
        {
            "SMS",
        },
    });

    var exampleSmsvoicev2Pool = new Aws.Pinpoint.Smsvoicev2Pool("example", new()
    {
        IsoCountryCode = "US",
        MessageType = "TRANSACTIONAL",
        OriginationIdentities = new[]
        {
            example.Arn,
        },
    });

    var exampleSmsvoicev2Keyword = new Aws.Pinpoint.Smsvoicev2Keyword("example", new()
    {
        OriginationIdentityArn = exampleSmsvoicev2Pool.Arn,
        Keyword = "OPTOUT",
        KeywordMessage = "You have been unsubscribed.",
        KeywordAction = "OPT_OUT",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.Smsvoicev2PhoneNumber;
import com.pulumi.aws.pinpoint.Smsvoicev2PhoneNumberArgs;
import com.pulumi.aws.pinpoint.Smsvoicev2Pool;
import com.pulumi.aws.pinpoint.Smsvoicev2PoolArgs;
import com.pulumi.aws.pinpoint.Smsvoicev2Keyword;
import com.pulumi.aws.pinpoint.Smsvoicev2KeywordArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Smsvoicev2PhoneNumber("example", Smsvoicev2PhoneNumberArgs.builder()
            .isoCountryCode("US")
            .messageType("TRANSACTIONAL")
            .numberType("SIMULATOR")
            .numberCapabilities("SMS")
            .build());

        var exampleSmsvoicev2Pool = new Smsvoicev2Pool("exampleSmsvoicev2Pool", Smsvoicev2PoolArgs.builder()
            .isoCountryCode("US")
            .messageType("TRANSACTIONAL")
            .originationIdentities(example.arn())
            .build());

        var exampleSmsvoicev2Keyword = new Smsvoicev2Keyword("exampleSmsvoicev2Keyword", Smsvoicev2KeywordArgs.builder()
            .originationIdentityArn(exampleSmsvoicev2Pool.arn())
            .keyword("OPTOUT")
            .keywordMessage("You have been unsubscribed.")
            .keywordAction("OPT_OUT")
            .build());

    }
}

    resources:
  example:
    type: aws:pinpoint:Smsvoicev2PhoneNumber
    properties:
      isoCountryCode: US
      messageType: TRANSACTIONAL
      numberType: SIMULATOR
      numberCapabilities:
        - SMS
  exampleSmsvoicev2Pool:
    type: aws:pinpoint:Smsvoicev2Pool
    name: example
    properties:
      isoCountryCode: US
      messageType: TRANSACTIONAL
      originationIdentities:
        - ${example.arn}
  exampleSmsvoicev2Keyword:
    type: aws:pinpoint:Smsvoicev2Keyword
    name: example
    properties:
      originationIdentityArn: ${exampleSmsvoicev2Pool.arn}
      keyword: OPTOUT
      keywordMessage: You have been unsubscribed.
      keywordAction: OPT_OUT

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_pinpoint_smsvoicev2phonenumber" "example" {
  iso_country_code    = "US"
  message_type        = "TRANSACTIONAL"
  number_type         = "SIMULATOR"
  number_capabilities = ["SMS"]
}
resource "aws_pinpoint_smsvoicev2pool" "example" {
  iso_country_code       = "US"
  message_type           = "TRANSACTIONAL"
  origination_identities = [aws_pinpoint_smsvoicev2phonenumber.example.arn]
}
resource "aws_pinpoint_smsvoicev2keyword" "example" {
  origination_identity_arn = aws_pinpoint_smsvoicev2pool.example.arn
  keyword                  = "OPTOUT"
  keyword_message          = "You have been unsubscribed."
  keyword_action           = "OPT_OUT"
}

    Mandatory Keyword

    The mandatory HELP and STOP keywords are adopted rather than created. Omit keywordAction; AWS manages it.

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.pinpoint.Smsvoicev2PhoneNumber("example", {
    isoCountryCode: "US",
    messageType: "TRANSACTIONAL",
    numberType: "SIMULATOR",
    numberCapabilities: ["SMS"],
});
const help = new aws.pinpoint.Smsvoicev2Keyword("help", {
    originationIdentityArn: example.arn,
    keyword: "HELP",
    keywordMessage: "Reply STOP to unsubscribe. Message and data rates may apply.",
});

    import pulumi
import pulumi_aws as aws

example = aws.pinpoint.Smsvoicev2PhoneNumber("example",
    iso_country_code="US",
    message_type="TRANSACTIONAL",
    number_type="SIMULATOR",
    number_capabilities=["SMS"])
help = aws.pinpoint.Smsvoicev2Keyword("help",
    origination_identity_arn=example.arn,
    keyword="HELP",
    keyword_message="Reply STOP to unsubscribe. Message and data rates may apply.")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := pinpoint.NewSmsvoicev2PhoneNumber(ctx, "example", &pinpoint.Smsvoicev2PhoneNumberArgs{
			IsoCountryCode: pulumi.String("US"),
			MessageType:    pulumi.String("TRANSACTIONAL"),
			NumberType:     pulumi.String("SIMULATOR"),
			NumberCapabilities: pulumi.StringArray{
				pulumi.String("SMS"),
			},
		})
		if err != nil {
			return err
		}
		_, err = pinpoint.NewSmsvoicev2Keyword(ctx, "help", &pinpoint.Smsvoicev2KeywordArgs{
			OriginationIdentityArn: example.Arn,
			Keyword:                pulumi.String("HELP"),
			KeywordMessage:         pulumi.String("Reply STOP to unsubscribe. Message and data rates may apply."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Pinpoint.Smsvoicev2PhoneNumber("example", new()
    {
        IsoCountryCode = "US",
        MessageType = "TRANSACTIONAL",
        NumberType = "SIMULATOR",
        NumberCapabilities = new[]
        {
            "SMS",
        },
    });

    var help = new Aws.Pinpoint.Smsvoicev2Keyword("help", new()
    {
        OriginationIdentityArn = example.Arn,
        Keyword = "HELP",
        KeywordMessage = "Reply STOP to unsubscribe. Message and data rates may apply.",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.Smsvoicev2PhoneNumber;
import com.pulumi.aws.pinpoint.Smsvoicev2PhoneNumberArgs;
import com.pulumi.aws.pinpoint.Smsvoicev2Keyword;
import com.pulumi.aws.pinpoint.Smsvoicev2KeywordArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Smsvoicev2PhoneNumber("example", Smsvoicev2PhoneNumberArgs.builder()
            .isoCountryCode("US")
            .messageType("TRANSACTIONAL")
            .numberType("SIMULATOR")
            .numberCapabilities("SMS")
            .build());

        var help = new Smsvoicev2Keyword("help", Smsvoicev2KeywordArgs.builder()
            .originationIdentityArn(example.arn())
            .keyword("HELP")
            .keywordMessage("Reply STOP to unsubscribe. Message and data rates may apply.")
            .build());

    }
}

    resources:
  example:
    type: aws:pinpoint:Smsvoicev2PhoneNumber
    properties:
      isoCountryCode: US
      messageType: TRANSACTIONAL
      numberType: SIMULATOR
      numberCapabilities:
        - SMS
  help:
    type: aws:pinpoint:Smsvoicev2Keyword
    properties:
      originationIdentityArn: ${example.arn}
      keyword: HELP
      keywordMessage: Reply STOP to unsubscribe. Message and data rates may apply.

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_pinpoint_smsvoicev2phonenumber" "example" {
  iso_country_code    = "US"
  message_type        = "TRANSACTIONAL"
  number_type         = "SIMULATOR"
  number_capabilities = ["SMS"]
}
resource "aws_pinpoint_smsvoicev2keyword" "help" {
  origination_identity_arn = aws_pinpoint_smsvoicev2phonenumber.example.arn
  keyword                  = "HELP"
  keyword_message          = "Reply STOP to unsubscribe. Message and data rates may apply."
}

    Create Smsvoicev2Keyword Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Smsvoicev2Keyword(name: string, args: Smsvoicev2KeywordArgs, opts?: CustomResourceOptions);
    @overload
def Smsvoicev2Keyword(resource_name: str,
                      args: Smsvoicev2KeywordArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def Smsvoicev2Keyword(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      keyword: Optional[str] = None,
                      keyword_message: Optional[str] = None,
                      origination_identity_arn: Optional[str] = None,
                      keyword_action: Optional[str] = None,
                      region: Optional[str] = None)
    func NewSmsvoicev2Keyword(ctx *Context, name string, args Smsvoicev2KeywordArgs, opts ...ResourceOption) (*Smsvoicev2Keyword, error)
    public Smsvoicev2Keyword(string name, Smsvoicev2KeywordArgs args, CustomResourceOptions? opts = null)
    public Smsvoicev2Keyword(String name, Smsvoicev2KeywordArgs args)
public Smsvoicev2Keyword(String name, Smsvoicev2KeywordArgs args, CustomResourceOptions options)

    type: aws:pinpoint:Smsvoicev2Keyword
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_pinpoint_smsvoicev2_keyword" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args Smsvoicev2KeywordArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args Smsvoicev2KeywordArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args Smsvoicev2KeywordArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Smsvoicev2KeywordArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Smsvoicev2KeywordArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var smsvoicev2KeywordResource = new Aws.Pinpoint.Smsvoicev2Keyword("smsvoicev2KeywordResource", new()
{
    Keyword = "string",
    KeywordMessage = "string",
    OriginationIdentityArn = "string",
    KeywordAction = "string",
    Region = "string",
});

    example, err := pinpoint.NewSmsvoicev2Keyword(ctx, "smsvoicev2KeywordResource", &pinpoint.Smsvoicev2KeywordArgs{
	Keyword:                pulumi.String("string"),
	KeywordMessage:         pulumi.String("string"),
	OriginationIdentityArn: pulumi.String("string"),
	KeywordAction:          pulumi.String("string"),
	Region:                 pulumi.String("string"),
})

    resource "aws_pinpoint_smsvoicev2_keyword" "smsvoicev2KeywordResource" {
  lifecycle {
    create_before_destroy = true
  }
  keyword                  = "string"
  keyword_message          = "string"
  origination_identity_arn = "string"
  keyword_action           = "string"
  region                   = "string"
}

    var smsvoicev2KeywordResource = new Smsvoicev2Keyword("smsvoicev2KeywordResource", Smsvoicev2KeywordArgs.builder()
    .keyword("string")
    .keywordMessage("string")
    .originationIdentityArn("string")
    .keywordAction("string")
    .region("string")
    .build());

    smsvoicev2_keyword_resource = aws.pinpoint.Smsvoicev2Keyword("smsvoicev2KeywordResource",
    keyword="string",
    keyword_message="string",
    origination_identity_arn="string",
    keyword_action="string",
    region="string")

    const smsvoicev2KeywordResource = new aws.pinpoint.Smsvoicev2Keyword("smsvoicev2KeywordResource", {
    keyword: "string",
    keywordMessage: "string",
    originationIdentityArn: "string",
    keywordAction: "string",
    region: "string",
});

    type: aws:pinpoint:Smsvoicev2Keyword
properties:
    keyword: string
    keywordAction: string
    keywordMessage: string
    originationIdentityArn: string
    region: string

    Smsvoicev2Keyword Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Smsvoicev2Keyword resource accepts the following input properties:

    Keyword string
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    KeywordMessage string
    Message to send when the keyword is received.
    OriginationIdentityArn string

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    KeywordAction string
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Keyword string
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    KeywordMessage string
    Message to send when the keyword is received.
    OriginationIdentityArn string

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    KeywordAction string
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword string
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keyword_message string
    Message to send when the keyword is received.
    origination_identity_arn string

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    keyword_action string
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword String
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keywordMessage String
    Message to send when the keyword is received.
    originationIdentityArn String

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    keywordAction String
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword string
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keywordMessage string
    Message to send when the keyword is received.
    originationIdentityArn string

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    keywordAction string
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword str
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keyword_message str
    Message to send when the keyword is received.
    origination_identity_arn str

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    keyword_action str
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword String
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keywordMessage String
    Message to send when the keyword is received.
    originationIdentityArn String

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    keywordAction String
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Smsvoicev2Keyword resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Smsvoicev2Keyword Resource

    Get an existing Smsvoicev2Keyword resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: Smsvoicev2KeywordState, opts?: CustomResourceOptions): Smsvoicev2Keyword
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        keyword: Optional[str] = None,
        keyword_action: Optional[str] = None,
        keyword_message: Optional[str] = None,
        origination_identity_arn: Optional[str] = None,
        region: Optional[str] = None) -> Smsvoicev2Keyword
    func GetSmsvoicev2Keyword(ctx *Context, name string, id IDInput, state *Smsvoicev2KeywordState, opts ...ResourceOption) (*Smsvoicev2Keyword, error)
    public static Smsvoicev2Keyword Get(string name, Input<string> id, Smsvoicev2KeywordState? state, CustomResourceOptions? opts = null)
    public static Smsvoicev2Keyword get(String name, Output<String> id, Smsvoicev2KeywordState state, CustomResourceOptions options)
    resources:  _:    type: aws:pinpoint:Smsvoicev2Keyword    get:      id: ${id}
    import {
  to = aws_pinpoint_smsvoicev2_keyword.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Keyword string
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    KeywordAction string
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    KeywordMessage string
    Message to send when the keyword is received.
    OriginationIdentityArn string

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Keyword string
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    KeywordAction string
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    KeywordMessage string
    Message to send when the keyword is received.
    OriginationIdentityArn string

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword string
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keyword_action string
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    keyword_message string
    Message to send when the keyword is received.
    origination_identity_arn string

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword String
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keywordAction String
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    keywordMessage String
    Message to send when the keyword is received.
    originationIdentityArn String

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword string
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keywordAction string
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    keywordMessage string
    Message to send when the keyword is received.
    originationIdentityArn string

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword str
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keyword_action str
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    keyword_message str
    Message to send when the keyword is received.
    origination_identity_arn str

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    keyword String
    Keyword to configure. Must be upper-case; AWS stores keywords in upper-case. 1-30 characters and cannot start or end with a space. Changing this forces a new resource.
    keywordAction String
    Action to perform when the keyword is received. Valid values: AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN. Defaults to AUTOMATIC_RESPONSE. Must not be set for mandatory keywords, whose action is managed by AWS.
    keywordMessage String
    Message to send when the keyword is received.
    originationIdentityArn String

    ARN of the origination identity (phone number or pool) to attach the keyword to. Changing this forces a new resource.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Import

    Identity Schema

    Required

    • originationIdentityArn (String) ARN of the origination identity the keyword is attached to.
    • keyword (String) Keyword text.

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • region (String) Region where this resource is managed.

    Using pulumi import, import a keyword using the originationIdentityArn and keyword, separated by a comma. For example:

    $ pulumi import aws:pinpoint/smsvoicev2Keyword:Smsvoicev2Keyword example "arn:aws:sms-voice:us-east-1:123456789012:phone-number/phone-abcdef0123456789abcdef0123456789,EXAMPLE"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.46.0
    published on Thursday, Sep 10, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial