NAME

Paws::AlexaForBusiness::SendAnnouncement - Arguments for method SendAnnouncement on Paws::AlexaForBusiness

DESCRIPTION

This class represents the parameters used for calling the method SendAnnouncement on the Alexa For Business service. Use the attributes of this class as arguments to method SendAnnouncement.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendAnnouncement.

SYNOPSIS

    my $a4b = Paws->service('AlexaForBusiness');
    my $SendAnnouncementResponse = $a4b->SendAnnouncement(
      ClientRequestToken => 'MyClientRequestToken',
      Content            => {
        AudioList => [
          {
            Locale   => 'en-US',              # values: en-US
            Location => 'MyAudioLocation',    # max: 1200

          },
          ...
        ],                                    # max: 1; OPTIONAL
        SsmlList => [
          {
            Locale => 'en-US',                # values: en-US
            Value  => 'MySsmlValue',          # max: 4096

          },
          ...
        ],                                    # max: 1; OPTIONAL
        TextList => [
          {
            Locale => 'en-US',                # values: en-US
            Value  => 'MyTextValue',          # max: 4096

          },
          ...
        ],                                    # max: 1; OPTIONAL
      },
      RoomFilters => [
        {
          Key    => 'MyFilterKey',            # min: 1, max: 500
          Values => [
            'MyFilterValue', ...              # min: 1, max: 500
          ],                                  # max: 50

        },
        ...
      ],
      TimeToLiveInSeconds => 1,               # OPTIONAL
    );

    # Results:
    my $AnnouncementArn = $SendAnnouncementResponse->AnnouncementArn;

    # Returns a L<Paws::AlexaForBusiness::SendAnnouncementResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/a4b/SendAnnouncement

ATTRIBUTES

REQUIRED ClientRequestToken => Str

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

REQUIRED Content => Paws::AlexaForBusiness::Content

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

REQUIRED RoomFilters => ArrayRef[Paws::AlexaForBusiness::Filter]

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.

TimeToLiveInSeconds => Int

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

SEE ALSO

This class forms part of Paws, documenting arguments for method SendAnnouncement in Paws::AlexaForBusiness

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues