AWS.Tools.SocialMessaging.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SocialMessaging</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.AddSOCIALResourceTagCmdlet"> <summary> Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.AddSOCIALResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.AddSOCIALResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to add to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.AddSOCIALResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StatusCode'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SocialMessaging.Model.TagResourceResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.TagResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.AddSOCIALResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.AddSOCIALResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet"> <summary> This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet.SignupCallback_AccessToken"> <summary> <para> <para>The access token for your WhatsApp Business Account. The <c>accessToken</c> value is provided by Meta.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet.SetupFinalization_AssociateInProgressToken"> <summary> <para> <para>An Amazon Web Services access token generated by <c>WhatsAppSignupCallback</c> and used by <c>WhatsAppSetupFinalization</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet.Waba_EventDestination"> <summary> <para> <para>The event destinations for the linked WhatsApp Business Account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet.Waba_Id"> <summary> <para> <para>The ID of the linked WhatsApp Business Account, formatted as <c>waba-01234567890123456789012345678901</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet.SetupFinalization_PhoneNumberParent"> <summary> <para> <para>Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when the <c>waba</c> field is present.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet.SetupFinalization_PhoneNumber"> <summary> <para> <para>An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet.Waba_Tag"> <summary> <para> <para>An array of key and value pair tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet.Select"> <summary> 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.SocialMessaging.Model.AssociateWhatsAppBusinessAccountResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.AssociateWhatsAppBusinessAccountResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.ConnectSOCIALWhatsAppBusinessAccountCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.DisconnectSOCIALWhatsAppBusinessAccountCmdlet"> <summary> Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.DisconnectSOCIALWhatsAppBusinessAccountCmdlet.Id"> <summary> <para> <para>The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as <c>waba-01234567890123456789012345678901</c>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html">ListLinkedWhatsAppBusinessAccounts</a> to list all WABAs and their details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.DisconnectSOCIALWhatsAppBusinessAccountCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SocialMessaging.Model.DisassociateWhatsAppBusinessAccountResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.DisconnectSOCIALWhatsAppBusinessAccountCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.DisconnectSOCIALWhatsAppBusinessAccountCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountCmdlet"> <summary> Get the details of your linked WhatsApp Business Account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountCmdlet.Id"> <summary> <para> <para>The unique identifier, from Amazon Web Services, of the linked WhatsApp Business Account. WABA identifiers are formatted as <c>waba-01234567890123456789012345678901</c>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html">ListLinkedWhatsAppBusinessAccounts</a> to list all WABAs and their details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Account'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SocialMessaging.Model.GetLinkedWhatsAppBusinessAccountResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.GetLinkedWhatsAppBusinessAccountResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountListCmdlet"> <summary> List all WhatsApp Business Accounts linked to your Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountListCmdlet.NextToken"> <summary> <para> <para>The next token for pagination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LinkedAccounts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SocialMessaging.Model.ListLinkedWhatsAppBusinessAccountsResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.ListLinkedWhatsAppBusinessAccountsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountPhoneNumberCmdlet"> <summary> Use your WhatsApp phone number id to get the WABA account id and phone number details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountPhoneNumberCmdlet.Id"> <summary> <para> <para>The unique identifier of the phone number. Phone number identifiers are formatted as <c>phone-number-id-01234567890123456789012345678901</c>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountPhoneNumberCmdlet.Select"> <summary> 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.SocialMessaging.Model.GetLinkedWhatsAppBusinessAccountPhoneNumberResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.GetLinkedWhatsAppBusinessAccountPhoneNumberResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALLinkedWhatsAppBusinessAccountPhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALResourceTagCmdlet"> <summary> List all tags associated with a resource, such as a phone number or WABA. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to retrieve the tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALResourceTagCmdlet.Select"> <summary> 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.SocialMessaging.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet"> <summary> Get a media file from the WhatsApp service. On successful completion the media file is retrieved from Meta and stored in the specified Amazon S3 bucket. Use either <c>destinationS3File</c> or <c>destinationS3PresignedUrl</c> for the destination. If both are used then an <c>InvalidParameterException</c> is returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet.DestinationS3File_BucketName"> <summary> <para> <para>The bucket name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet.DestinationS3PresignedUrl_Header"> <summary> <para> <para>A map of headers and their values. You must specify the <c>Content-Type</c> header when using <c>PostWhatsAppMessageMedia</c>. For a list of common headers, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common Request Headers</a> in the <i>Amazon S3 API Reference</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet.DestinationS3File_Key"> <summary> <para> <para>The object key of the media file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet.MediaId"> <summary> <para> <para>The unique identifier for the media file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet.MetadataOnly"> <summary> <para> <para>Set to <c>True</c> to get only the metadata for the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet.OriginationPhoneNumberId"> <summary> <para> <para>The unique identifier of the originating phone number for the WhatsApp message media. The phone number identifiers are formatted as <c>phone-number-id-01234567890123456789012345678901</c>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet.DestinationS3PresignedUrl_Url"> <summary> <para> <para>The presign url to the object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet.Select"> <summary> 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.SocialMessaging.Model.GetWhatsAppMessageMediaResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.GetWhatsAppMessageMediaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.GetSOCIALWhatsAppMessageMediaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OriginationPhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^OriginationPhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALResourceTagCmdlet"> <summary> Removes the specified tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StatusCode'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SocialMessaging.Model.UntagResourceResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.UntagResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALWhatsAppMessageMediaCmdlet"> <summary> Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALWhatsAppMessageMediaCmdlet.MediaId"> <summary> <para> <para>The unique identifier of the media file to delete. Use the <c>mediaId</c> returned from <a href="https://console.aws.amazon.com/social-messaging/latest/APIReference/API_PostWhatsAppMessageMedia.html">PostWhatsAppMessageMedia</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALWhatsAppMessageMediaCmdlet.OriginationPhoneNumberId"> <summary> <para> <para>The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as <c>phone-number-id-01234567890123456789012345678901</c>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALWhatsAppMessageMediaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Success'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SocialMessaging.Model.DeleteWhatsAppMessageMediaResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.DeleteWhatsAppMessageMediaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALWhatsAppMessageMediaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OriginationPhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^OriginationPhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.RemoveSOCIALWhatsAppMessageMediaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageCmdlet"> <summary> Send a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/social-messaging/latest/userguide/send-message.html">Sending messages</a> in the <i><i>Amazon Web Services End User Messaging Social User Guide</i></i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageCmdlet.Message"> <summary> <para> <para>The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp Message object, see <a href="https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages">Messages</a> in the <i>WhatsApp Business Platform Cloud API Reference</i>.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageCmdlet.MetaApiVersion"> <summary> <para> <para>The API version for the request formatted as <c>v{VersionNumber}</c>. For a list of supported API versions and Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/end-user-messaging.html"><i>Amazon Web Services End User Messaging Social API</i> Service Endpoints</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageCmdlet.OriginationPhoneNumberId"> <summary> <para> <para>The ID of the phone number used to send the WhatsApp message. If you are sending a media file only the <c>originationPhoneNumberId</c> used to upload the file can be used. Phone number identifiers are formatted as <c>phone-number-id-01234567890123456789012345678901</c>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SocialMessaging.Model.SendWhatsAppMessageResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.SendWhatsAppMessageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OriginationPhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^OriginationPhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageMediaCmdlet"> <summary> Upload a media file to the WhatsApp service. Only the specified <c>originationPhoneNumberId</c> has the permissions to send the media file when using <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_SendWhatsAppMessage.html">SendWhatsAppMessage</a>. You must use either <c>sourceS3File</c> or <c>sourceS3PresignedUrl</c> for the source. If both or neither are specified then an <c>InvalidParameterException</c> is returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageMediaCmdlet.SourceS3File_BucketName"> <summary> <para> <para>The bucket name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageMediaCmdlet.SourceS3PresignedUrl_Header"> <summary> <para> <para>A map of headers and their values. You must specify the <c>Content-Type</c> header when using <c>PostWhatsAppMessageMedia</c>. For a list of common headers, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common Request Headers</a> in the <i>Amazon S3 API Reference</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageMediaCmdlet.SourceS3File_Key"> <summary> <para> <para>The object key of the media file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageMediaCmdlet.OriginationPhoneNumberId"> <summary> <para> <para>The ID of the phone number to associate with the WhatsApp media file. The phone number identifiers are formatted as <c>phone-number-id-01234567890123456789012345678901</c>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageMediaCmdlet.SourceS3PresignedUrl_Url"> <summary> <para> <para>The presign url to the object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageMediaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SocialMessaging.Model.PostWhatsAppMessageMediaResponse). Specifying the name of a property of type Amazon.SocialMessaging.Model.PostWhatsAppMessageMediaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageMediaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OriginationPhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^OriginationPhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.SendSOCIALWhatsAppMessageMediaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SOCIAL.WriteSOCIALWhatsAppBusinessAccountEventDestinationCmdlet"> <summary> Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.WriteSOCIALWhatsAppBusinessAccountEventDestinationCmdlet.EventDestination"> <summary> <para> <para>An array of <c>WhatsAppBusinessAccountEventDestination</c> event destinations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.WriteSOCIALWhatsAppBusinessAccountEventDestinationCmdlet.Id"> <summary> <para> <para>The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as <c>waba-01234567890123456789012345678901</c>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html">ListLinkedWhatsAppBusinessAccounts</a> to list all WABAs and their details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.WriteSOCIALWhatsAppBusinessAccountEventDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SocialMessaging.Model.PutWhatsAppBusinessAccountEventDestinationsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.WriteSOCIALWhatsAppBusinessAccountEventDestinationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SOCIAL.WriteSOCIALWhatsAppBusinessAccountEventDestinationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |