AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Pinpoint SMS Voice V2 UpdateRcsAgent API operation.

Syntax

Update-SMSVRcsAgent
-RcsAgentId <String>
-DeletionProtectionEnabled <Boolean>
-OptOutListName <String>
-SelfManagedOptOutsEnabled <Boolean>
-TwoWayChannelArn <String>
-TwoWayChannelRole <String>
-TwoWayEnabled <Boolean>
-TwoWayMediaS3BucketName <String>
-TwoWayMediaS3KeyPrefix <String>
-TwoWayMediaS3Role <String>
-TwoWayRcsEventsEnabled <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPinpointSMSVoiceV2Config>

Description

Updates the configuration of an existing RCS agent. You can update the opt-out list, deletion protection, two-way messaging settings, and self-managed opt-outs configuration.

Parameters

-ClientConfig <AmazonPinpointSMSVoiceV2Config>
Amazon.PowerShell.Cmdlets.SMSV.AmazonPinpointSMSVoiceV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtectionEnabled <Boolean>
By default this is set to false. When set to true the RCS agent can't be deleted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptOutListName <String>
The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsAgentId <String>
The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointSMSVoiceV2.Model.UpdateRcsAgentResponse). Specifying the name of a property of type Amazon.PinpointSMSVoiceV2.Model.UpdateRcsAgentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SelfManagedOptOutsEnabled <Boolean>
By default this is set to false. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TwoWayChannelArn <String>
The Amazon Resource Name (ARN) of the two way channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TwoWayChannelRole <String>
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TwoWayEnabled <Boolean>
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TwoWayMediaS3BucketName <String>
The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3Role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TwoWayMediaS3KeyPrefix <String>
The key prefix used for inbound RCS media objects in the S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TwoWayMediaS3Role <String>
The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3BucketName.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TwoWayRcsEventsEnabled <String[]>
The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.PinpointSMSVoiceV2.Model.UpdateRcsAgentResponse
This cmdlet returns an Amazon.PinpointSMSVoiceV2.Model.UpdateRcsAgentResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z