Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . alexaforbusiness ]

send-announcement

Description

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  send-announcement
--room-filters <value>
--content <value>
[--time-to-live-in-seconds <value>]
[--client-request-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--room-filters (list)

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Shorthand Syntax:

Key=string,Values=string,string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--content (structure)

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

Shorthand Syntax:

TextList=[{Locale=string,Value=string},{Locale=string,Value=string}],SsmlList=[{Locale=string,Value=string},{Locale=string,Value=string}],AudioList=[{Locale=string,Location=string},{Locale=string,Location=string}]

JSON Syntax:

{
  "TextList": [
    {
      "Locale": "en-US",
      "Value": "string"
    }
    ...
  ],
  "SsmlList": [
    {
      "Locale": "en-US",
      "Value": "string"
    }
    ...
  ],
  "AudioList": [
    {
      "Locale": "en-US",
      "Location": "string"
    }
    ...
  ]
}

--time-to-live-in-seconds (integer)

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

--client-request-token (string)

The unique, user-specified identifier for the request that ensures idempotency.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

AnnouncementArn -> (string)

The identifier of the announcement.