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 Chime SDK Messaging SendChannelMessage API operation.

Syntax

Send-CHMMGChannelMessage
-ChannelArn <String>
-PushNotification_Body <String>
-ChimeBearer <String>
-ClientRequestToken <String>
-Content <String>
-ContentType <String>
-MessageAttribute <Hashtable>
-Metadata <String>
-Persistence <ChannelMessagePersistenceType>
-SubChannelId <String>
-Target <Target[]>
-PushNotification_Title <String>
-PushNotification_Type <PushNotificationType>
-Type <ChannelMessageType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonChimeSDKMessagingConfig>

Description

Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header. Also, STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment. CONTROL messages are limited to 30 bytes and do not contain metadata.

Parameters

-ChannelArn <String>
The ARN of the channel.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ChimeBearer <String>
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonChimeSDKMessagingConfig>
Amazon.PowerShell.Cmdlets.CHMMG.AmazonChimeSDKMessagingClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
The Idempotency token for each client request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content <String>
The content of the channel message.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContentType <String>
The content type of the channel message.
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)
-MessageAttribute <Hashtable>
The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageAttributes
-Metadata <String>
The optional metadata for each message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Persistence <ChannelMessagePersistenceType>
Boolean that controls whether the message is persisted on the back end. Required.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PushNotification_Body <String>
The body of the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PushNotification_Title <String>
The title of the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PushNotification_Type <PushNotificationType>
Enum value that indicates the type of the push notification for a message. DEFAULT: Normal mobile push notification. VOIP: VOIP mobile push notification.
Required?False
Position?Named
Accept pipeline input?True (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.ChimeSDKMessaging.Model.SendChannelMessageResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.SendChannelMessageResponse 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)
-SubChannelId <String>
The ID of the SubChannel in the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Target <Target[]>
The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <ChannelMessageType>
The type of message, STANDARD or CONTROL.STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.CONTROL messages are limited to 30 bytes and do not contain metadata.
Required?True
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.ChimeSDKMessaging.Model.SendChannelMessageResponse
This cmdlet returns an Amazon.ChimeSDKMessaging.Model.SendChannelMessageResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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