An AWS RCS Agent in AWS End User Messaging SMS. The RCS agent is the top-level resource representing your brand for RCS messaging, and serves as an origination identity for sending RCS messages. A newly created agent is in CREATED status; it advances through TESTING, PARTIAL and ACTIVE only as testing and country launch registrations are submitted and approved by carriers.
Using getRcsAgent
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.
def get_rcs_agent(rcs_agent_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRcsAgentResult
def get_rcs_agent_output(rcs_agent_arn: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetRcsAgentResult]
> Note: This function is named LookupRcsAgent in the Go SDK.
public static CompletableFuture<GetRcsAgentResult> getRcsAgent(GetRcsAgentArgs args, InvokeOptions options)
public static Output<GetRcsAgentResult> getRcsAgent(GetRcsAgentArgs args, InvokeOptions options)
public static Output<GetRcsAgentResult> getRcsAgent(GetRcsAgentArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:smsvoice:getRcsAgent
arguments:
# arguments dictionary
data "aws-native_smsvoice_get_rcs_agent" "name" {
# arguments
}
The following arguments are supported:
- RcsAgentArn
string
- The Amazon Resource Name (ARN) of the RCS agent.
- RcsAgentArn
string
- The Amazon Resource Name (ARN) of the RCS agent.
- rcs_agent_arn
string
- The Amazon Resource Name (ARN) of the RCS agent.
- rcsAgentArn
String
- The Amazon Resource Name (ARN) of the RCS agent.
- rcsAgentArn
string
- The Amazon Resource Name (ARN) of the RCS agent.
- rcs_agent_arn
str
- The Amazon Resource Name (ARN) of the RCS agent.
- rcsAgentArn
String
- The Amazon Resource Name (ARN) of the RCS agent.
getRcsAgent Result
The following output properties are available:
- CreatedTimestamp
string
- The time when the RCS agent was created.
- DeletionProtectionEnabled
bool
- When set to true the RCS agent can't be deleted. By default this is false.
- OptOutListName
string
- The name of the opt-out list associated with the RCS agent.
- PoolId
string
- The unique identifier of the pool associated with the RCS agent. This is populated only while the agent is associated with a pool, which is done through the pool APIs rather than through this resource.
- RcsAgentArn
string
- The Amazon Resource Name (ARN) of the RCS agent.
- RcsAgentId
string
- The unique identifier for the RCS agent, in the format rcs- followed by a hexadecimal string.
- SelfManagedOptOutsEnabled
bool
- When set to true you're responsible for responding to HELP and STOP requests, and for tracking and honoring opt-out requests. By default this is false.
- Status
Pulumi.AwsNative.Smsvoice.RcsAgentStatus
- The current status of the RCS agent. CREATED means the agent exists but no registration has been submitted. PENDING means a registration is awaiting processing. TESTING means the testing registration is approved and the agent can message registered test devices. PARTIAL means at least one country launch is active. ACTIVE means all submitted country launches are active. DELETED means the agent has been deleted.
- Tags
List<Pulumi.AwsNative.Outputs.Tag>
- An array of key-value pairs to apply to the RCS agent.
- TestingAgent
Pulumi.AwsNative.Smsvoice.Outputs.RcsAgentTestingAgentInformation
- TwoWayChannelArn
string
- The Amazon Resource Name (ARN) of the two way channel where inbound messages are delivered.
- TwoWayChannelRole
string
- The Amazon Resource Name (ARN) of an IAM role for the service to assume in order to post inbound messages to the two way channel.
- TwoWayEnabled
bool
- When set to true two-way messaging is enabled for the RCS agent.
- TwoWayMediaS3BucketName
string
- The name of the Amazon S3 bucket where inbound RCS media objects are written.
- TwoWayMediaS3KeyPrefix
string
- The key prefix used for inbound RCS media objects in the Amazon S3 bucket.
- TwoWayMediaS3Role
string
- The Amazon Resource Name (ARN) of the IAM role used to write inbound RCS media files to the Amazon S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
- TwoWayRcsEventsEnabled
List<string>
- The list of RCS event types enabled for two-way messaging. An empty list disables all event types. The special value ALL enables all current and future event types and must be the only element if used. Requires TwoWayEnabled to be true.
- CreatedTimestamp
string
- The time when the RCS agent was created.
- DeletionProtectionEnabled
bool
- When set to true the RCS agent can't be deleted. By default this is false.
- OptOutListName
string
- The name of the opt-out list associated with the RCS agent.
- PoolId
string
- The unique identifier of the pool associated with the RCS agent. This is populated only while the agent is associated with a pool, which is done through the pool APIs rather than through this resource.
- RcsAgentArn
string
- The Amazon Resource Name (ARN) of the RCS agent.
- RcsAgentId
string
- The unique identifier for the RCS agent, in the format rcs- followed by a hexadecimal string.
- SelfManagedOptOutsEnabled
bool
- When set to true you're responsible for responding to HELP and STOP requests, and for tracking and honoring opt-out requests. By default this is false.
- Status
RcsAgentStatus
- The current status of the RCS agent. CREATED means the agent exists but no registration has been submitted. PENDING means a registration is awaiting processing. TESTING means the testing registration is approved and the agent can message registered test devices. PARTIAL means at least one country launch is active. ACTIVE means all submitted country launches are active. DELETED means the agent has been deleted.
- Tags
Tag
- An array of key-value pairs to apply to the RCS agent.
- TestingAgent
RcsAgentTestingAgentInformation
- TwoWayChannelArn
string
- The Amazon Resource Name (ARN) of the two way channel where inbound messages are delivered.
- TwoWayChannelRole
string
- The Amazon Resource Name (ARN) of an IAM role for the service to assume in order to post inbound messages to the two way channel.
- TwoWayEnabled
bool
- When set to true two-way messaging is enabled for the RCS agent.
- TwoWayMediaS3BucketName
string
- The name of the Amazon S3 bucket where inbound RCS media objects are written.
- TwoWayMediaS3KeyPrefix
string
- The key prefix used for inbound RCS media objects in the Amazon S3 bucket.
- TwoWayMediaS3Role
string
- The Amazon Resource Name (ARN) of the IAM role used to write inbound RCS media files to the Amazon S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
- TwoWayRcsEventsEnabled
[]string
- The list of RCS event types enabled for two-way messaging. An empty list disables all event types. The special value ALL enables all current and future event types and must be the only element if used. Requires TwoWayEnabled to be true.
- created_timestamp
string
- The time when the RCS agent was created.
- deletion_protection_enabled
bool
- When set to true the RCS agent can't be deleted. By default this is false.
- opt_out_list_name
string
- The name of the opt-out list associated with the RCS agent.
- pool_id
string
- The unique identifier of the pool associated with the RCS agent. This is populated only while the agent is associated with a pool, which is done through the pool APIs rather than through this resource.
- rcs_agent_arn
string
- The Amazon Resource Name (ARN) of the RCS agent.
- rcs_agent_id
string
- The unique identifier for the RCS agent, in the format rcs- followed by a hexadecimal string.
- self_managed_opt_outs_enabled
bool
- When set to true you're responsible for responding to HELP and STOP requests, and for tracking and honoring opt-out requests. By default this is false.
- status
"CREATED" | "PENDING" | "TESTING" | "PARTIAL" | "ACTIVE" | "DELETED"
- The current status of the RCS agent. CREATED means the agent exists but no registration has been submitted. PENDING means a registration is awaiting processing. TESTING means the testing registration is approved and the agent can message registered test devices. PARTIAL means at least one country launch is active. ACTIVE means all submitted country launches are active. DELETED means the agent has been deleted.
- tags
list(object)
- An array of key-value pairs to apply to the RCS agent.
- testing_agent
object
- two_way_channel_arn
string
- The Amazon Resource Name (ARN) of the two way channel where inbound messages are delivered.
- two_way_channel_role
string
- The Amazon Resource Name (ARN) of an IAM role for the service to assume in order to post inbound messages to the two way channel.
- two_way_enabled
bool
- When set to true two-way messaging is enabled for the RCS agent.
- two_way_media_s3_bucket_name
string
- The name of the Amazon S3 bucket where inbound RCS media objects are written.
- two_way_media_s3_key_prefix
string
- The key prefix used for inbound RCS media objects in the Amazon S3 bucket.
- two_way_media_s3_role
string
- The Amazon Resource Name (ARN) of the IAM role used to write inbound RCS media files to the Amazon S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
- two_way_rcs_events_enabled
list(string)
- The list of RCS event types enabled for two-way messaging. An empty list disables all event types. The special value ALL enables all current and future event types and must be the only element if used. Requires TwoWayEnabled to be true.
- createdTimestamp
String
- The time when the RCS agent was created.
- deletionProtectionEnabled
Boolean
- When set to true the RCS agent can't be deleted. By default this is false.
- optOutListName
String
- The name of the opt-out list associated with the RCS agent.
- poolId
String
- The unique identifier of the pool associated with the RCS agent. This is populated only while the agent is associated with a pool, which is done through the pool APIs rather than through this resource.
- rcsAgentArn
String
- The Amazon Resource Name (ARN) of the RCS agent.
- rcsAgentId
String
- The unique identifier for the RCS agent, in the format rcs- followed by a hexadecimal string.
- selfManagedOptOutsEnabled
Boolean
- When set to true you're responsible for responding to HELP and STOP requests, and for tracking and honoring opt-out requests. By default this is false.
- status
RcsAgentStatus
- The current status of the RCS agent. CREATED means the agent exists but no registration has been submitted. PENDING means a registration is awaiting processing. TESTING means the testing registration is approved and the agent can message registered test devices. PARTIAL means at least one country launch is active. ACTIVE means all submitted country launches are active. DELETED means the agent has been deleted.
- tags
List<Tag>
- An array of key-value pairs to apply to the RCS agent.
- testingAgent
RcsAgentTestingAgentInformation
- twoWayChannelArn
String
- The Amazon Resource Name (ARN) of the two way channel where inbound messages are delivered.
- twoWayChannelRole
String
- The Amazon Resource Name (ARN) of an IAM role for the service to assume in order to post inbound messages to the two way channel.
- twoWayEnabled
Boolean
- When set to true two-way messaging is enabled for the RCS agent.
- twoWayMediaS3BucketName
String
- The name of the Amazon S3 bucket where inbound RCS media objects are written.
- twoWayMediaS3KeyPrefix
String
- The key prefix used for inbound RCS media objects in the Amazon S3 bucket.
- twoWayMediaS3Role
String
- The Amazon Resource Name (ARN) of the IAM role used to write inbound RCS media files to the Amazon S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
- twoWayRcsEventsEnabled
List<String>
- The list of RCS event types enabled for two-way messaging. An empty list disables all event types. The special value ALL enables all current and future event types and must be the only element if used. Requires TwoWayEnabled to be true.
- createdTimestamp
string
- The time when the RCS agent was created.
- deletionProtectionEnabled
boolean
- When set to true the RCS agent can't be deleted. By default this is false.
- optOutListName
string
- The name of the opt-out list associated with the RCS agent.
- poolId
string
- The unique identifier of the pool associated with the RCS agent. This is populated only while the agent is associated with a pool, which is done through the pool APIs rather than through this resource.
- rcsAgentArn
string
- The Amazon Resource Name (ARN) of the RCS agent.
- rcsAgentId
string
- The unique identifier for the RCS agent, in the format rcs- followed by a hexadecimal string.
- selfManagedOptOutsEnabled
boolean
- When set to true you're responsible for responding to HELP and STOP requests, and for tracking and honoring opt-out requests. By default this is false.
- status
RcsAgentStatus
- The current status of the RCS agent. CREATED means the agent exists but no registration has been submitted. PENDING means a registration is awaiting processing. TESTING means the testing registration is approved and the agent can message registered test devices. PARTIAL means at least one country launch is active. ACTIVE means all submitted country launches are active. DELETED means the agent has been deleted.
- tags
Tag[]
- An array of key-value pairs to apply to the RCS agent.
- testingAgent
RcsAgentTestingAgentInformation
- twoWayChannelArn
string
- The Amazon Resource Name (ARN) of the two way channel where inbound messages are delivered.
- twoWayChannelRole
string
- The Amazon Resource Name (ARN) of an IAM role for the service to assume in order to post inbound messages to the two way channel.
- twoWayEnabled
boolean
- When set to true two-way messaging is enabled for the RCS agent.
- twoWayMediaS3BucketName
string
- The name of the Amazon S3 bucket where inbound RCS media objects are written.
- twoWayMediaS3KeyPrefix
string
- The key prefix used for inbound RCS media objects in the Amazon S3 bucket.
- twoWayMediaS3Role
string
- The Amazon Resource Name (ARN) of the IAM role used to write inbound RCS media files to the Amazon S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
- twoWayRcsEventsEnabled
string[]
- The list of RCS event types enabled for two-way messaging. An empty list disables all event types. The special value ALL enables all current and future event types and must be the only element if used. Requires TwoWayEnabled to be true.
- created_timestamp
str
- The time when the RCS agent was created.
- deletion_protection_enabled
bool
- When set to true the RCS agent can't be deleted. By default this is false.
- opt_out_list_name
str
- The name of the opt-out list associated with the RCS agent.
- pool_id
str
- The unique identifier of the pool associated with the RCS agent. This is populated only while the agent is associated with a pool, which is done through the pool APIs rather than through this resource.
- rcs_agent_arn
str
- The Amazon Resource Name (ARN) of the RCS agent.
- rcs_agent_id
str
- The unique identifier for the RCS agent, in the format rcs- followed by a hexadecimal string.
- self_managed_opt_outs_enabled
bool
- When set to true you're responsible for responding to HELP and STOP requests, and for tracking and honoring opt-out requests. By default this is false.
- status
RcsAgentStatus
- The current status of the RCS agent. CREATED means the agent exists but no registration has been submitted. PENDING means a registration is awaiting processing. TESTING means the testing registration is approved and the agent can message registered test devices. PARTIAL means at least one country launch is active. ACTIVE means all submitted country launches are active. DELETED means the agent has been deleted.
- tags
Sequence[root_Tag]
- An array of key-value pairs to apply to the RCS agent.
- testing_agent
RcsAgentTestingAgentInformation
- two_way_channel_arn
str
- The Amazon Resource Name (ARN) of the two way channel where inbound messages are delivered.
- two_way_channel_role
str
- The Amazon Resource Name (ARN) of an IAM role for the service to assume in order to post inbound messages to the two way channel.
- two_way_enabled
bool
- When set to true two-way messaging is enabled for the RCS agent.
- two_way_media_s3_bucket_name
str
- The name of the Amazon S3 bucket where inbound RCS media objects are written.
- two_way_media_s3_key_prefix
str
- The key prefix used for inbound RCS media objects in the Amazon S3 bucket.
- two_way_media_s3_role
str
- The Amazon Resource Name (ARN) of the IAM role used to write inbound RCS media files to the Amazon S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
- two_way_rcs_events_enabled
Sequence[str]
- The list of RCS event types enabled for two-way messaging. An empty list disables all event types. The special value ALL enables all current and future event types and must be the only element if used. Requires TwoWayEnabled to be true.
- createdTimestamp
String
- The time when the RCS agent was created.
- deletionProtectionEnabled
Boolean
- When set to true the RCS agent can't be deleted. By default this is false.
- optOutListName
String
- The name of the opt-out list associated with the RCS agent.
- poolId
String
- The unique identifier of the pool associated with the RCS agent. This is populated only while the agent is associated with a pool, which is done through the pool APIs rather than through this resource.
- rcsAgentArn
String
- The Amazon Resource Name (ARN) of the RCS agent.
- rcsAgentId
String
- The unique identifier for the RCS agent, in the format rcs- followed by a hexadecimal string.
- selfManagedOptOutsEnabled
Boolean
- When set to true you're responsible for responding to HELP and STOP requests, and for tracking and honoring opt-out requests. By default this is false.
- status
"CREATED" | "PENDING" | "TESTING" | "PARTIAL" | "ACTIVE" | "DELETED"
- The current status of the RCS agent. CREATED means the agent exists but no registration has been submitted. PENDING means a registration is awaiting processing. TESTING means the testing registration is approved and the agent can message registered test devices. PARTIAL means at least one country launch is active. ACTIVE means all submitted country launches are active. DELETED means the agent has been deleted.
- tags
List<Property Map>
- An array of key-value pairs to apply to the RCS agent.
- testingAgent
Property Map
- twoWayChannelArn
String
- The Amazon Resource Name (ARN) of the two way channel where inbound messages are delivered.
- twoWayChannelRole
String
- The Amazon Resource Name (ARN) of an IAM role for the service to assume in order to post inbound messages to the two way channel.
- twoWayEnabled
Boolean
- When set to true two-way messaging is enabled for the RCS agent.
- twoWayMediaS3BucketName
String
- The name of the Amazon S3 bucket where inbound RCS media objects are written.
- twoWayMediaS3KeyPrefix
String
- The key prefix used for inbound RCS media objects in the Amazon S3 bucket.
- twoWayMediaS3Role
String
- The Amazon Resource Name (ARN) of the IAM role used to write inbound RCS media files to the Amazon S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
- twoWayRcsEventsEnabled
List<String>
- The list of RCS event types enabled for two-way messaging. An empty list disables all event types. The special value ALL enables all current and future event types and must be the only element if used. Requires TwoWayEnabled to be true.
Supporting Types
RcsAgentStatus
| Name | Value |
|---|
| Created | CREATED |
| Pending | PENDING |
| Testing | TESTING |
| Partial | PARTIAL |
| Active | ACTIVE |
| Deleted | DELETED |
| Name | Value |
|---|
| RcsAgentStatusCreated | CREATED |
| RcsAgentStatusPending | PENDING |
| RcsAgentStatusTesting | TESTING |
| RcsAgentStatusPartial | PARTIAL |
| RcsAgentStatusActive | ACTIVE |
| RcsAgentStatusDeleted | DELETED |
| Value |
|---|
CREATED |
PENDING |
TESTING |
PARTIAL |
ACTIVE |
DELETED |
| Name | Value |
|---|
| Created | CREATED |
| Pending | PENDING |
| Testing | TESTING |
| Partial | PARTIAL |
| Active | ACTIVE |
| Deleted | DELETED |
| Name | Value |
|---|
| Created | CREATED |
| Pending | PENDING |
| Testing | TESTING |
| Partial | PARTIAL |
| Active | ACTIVE |
| Deleted | DELETED |
| Name | Value |
|---|
| CREATED | CREATED |
| PENDING | PENDING |
| TESTING | TESTING |
| PARTIAL | PARTIAL |
| ACTIVE | ACTIVE |
| DELETED | DELETED |
| Value |
|---|
CREATED |
PENDING |
TESTING |
PARTIAL |
ACTIVE |
DELETED |
| Name | Value |
|---|
| Created | CREATED |
| Pending | PENDING |
| Active | ACTIVE |
| Name | Value |
|---|
| RcsAgentTestingAgentInformationTestingAgentStatusCreated | CREATED |
| RcsAgentTestingAgentInformationTestingAgentStatusPending | PENDING |
| RcsAgentTestingAgentInformationTestingAgentStatusActive | ACTIVE |
| Value |
|---|
CREATED |
PENDING |
ACTIVE |
| Name | Value |
|---|
| Created | CREATED |
| Pending | PENDING |
| Active | ACTIVE |
| Name | Value |
|---|
| Created | CREATED |
| Pending | PENDING |
| Active | ACTIVE |
| Name | Value |
|---|
| CREATED | CREATED |
| PENDING | PENDING |
| ACTIVE | ACTIVE |
| Value |
|---|
CREATED |
PENDING |
ACTIVE |
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
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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0