++ed by:
TIMB LUKEC REISINGE CAFEGRATZ DBOOK

17 PAUSE users
15 non-PAUSE users.

Jose Luis Martinez Torres
and 1 contributors

NAME

Paws::AlexaForBusiness - Perl Interface to AWS Alexa For Business

SYNOPSIS

  use Paws;

  my $obj = Paws->service('AlexaForBusiness');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Alexa for Business makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need for managing Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can make also these available as private skills for your organization. Alexa for Business makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.

For the AWS API documentation, see https://aws.amazon.com/documentation/

METHODS

AssociateContactWithAddressBook

AddressBookArn => Str
ContactArn => Str

Each argument is described in detail in: Paws::AlexaForBusiness::AssociateContactWithAddressBook

Returns: a Paws::AlexaForBusiness::AssociateContactWithAddressBookResponse instance

Associates a contact with a given address book.

AssociateDeviceWithRoom

[DeviceArn => Str]
[RoomArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::AssociateDeviceWithRoom

Returns: a Paws::AlexaForBusiness::AssociateDeviceWithRoomResponse instance

Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.

AssociateSkillGroupWithRoom

[RoomArn => Str]
[SkillGroupArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::AssociateSkillGroupWithRoom

Returns: a Paws::AlexaForBusiness::AssociateSkillGroupWithRoomResponse instance

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

CreateAddressBook

Name => Str
[ClientRequestToken => Str]
[Description => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::CreateAddressBook

Returns: a Paws::AlexaForBusiness::CreateAddressBookResponse instance

Creates an address book with the specified details.

CreateContact

FirstName => Str
PhoneNumber => Str
[ClientRequestToken => Str]
[DisplayName => Str]
[LastName => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::CreateContact

Returns: a Paws::AlexaForBusiness::CreateContactResponse instance

Creates a contact with the specified details.

CreateProfile

Address => Str
DistanceUnit => Str
ProfileName => Str
TemperatureUnit => Str
Timezone => Str
WakeWord => Str
[ClientRequestToken => Str]
[MaxVolumeLimit => Int]
[PSTNEnabled => Bool]
[SetupModeDisabled => Bool]

Each argument is described in detail in: Paws::AlexaForBusiness::CreateProfile

Returns: a Paws::AlexaForBusiness::CreateProfileResponse instance

Creates a new room profile with the specified details.

CreateRoom

RoomName => Str
[ClientRequestToken => Str]
[Description => Str]
[ProfileArn => Str]
[ProviderCalendarId => Str]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

Each argument is described in detail in: Paws::AlexaForBusiness::CreateRoom

Returns: a Paws::AlexaForBusiness::CreateRoomResponse instance

Creates a room with the specified details.

CreateSkillGroup

SkillGroupName => Str
[ClientRequestToken => Str]
[Description => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::CreateSkillGroup

Returns: a Paws::AlexaForBusiness::CreateSkillGroupResponse instance

Creates a skill group with a specified name and description.

CreateUser

UserId => Str
[ClientRequestToken => Str]
[Email => Str]
[FirstName => Str]
[LastName => Str]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

Each argument is described in detail in: Paws::AlexaForBusiness::CreateUser

Returns: a Paws::AlexaForBusiness::CreateUserResponse instance

Creates a user.

DeleteAddressBook

AddressBookArn => Str

Each argument is described in detail in: Paws::AlexaForBusiness::DeleteAddressBook

Returns: a Paws::AlexaForBusiness::DeleteAddressBookResponse instance

Deletes an address book by the address book ARN.

DeleteContact

ContactArn => Str

Each argument is described in detail in: Paws::AlexaForBusiness::DeleteContact

Returns: a Paws::AlexaForBusiness::DeleteContactResponse instance

Deletes a contact by the contact ARN.

DeleteProfile

[ProfileArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::DeleteProfile

Returns: a Paws::AlexaForBusiness::DeleteProfileResponse instance

Deletes a room profile by the profile ARN.

DeleteRoom

[RoomArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::DeleteRoom

Returns: a Paws::AlexaForBusiness::DeleteRoomResponse instance

Deletes a room by the room ARN.

DeleteRoomSkillParameter

ParameterKey => Str
SkillId => Str
[RoomArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::DeleteRoomSkillParameter

Returns: a Paws::AlexaForBusiness::DeleteRoomSkillParameterResponse instance

Deletes room skill parameter details by room, skill, and parameter key ID.

DeleteSkillGroup

[SkillGroupArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::DeleteSkillGroup

Returns: a Paws::AlexaForBusiness::DeleteSkillGroupResponse instance

Deletes a skill group by skill group ARN.

DeleteUser

EnrollmentId => Str
[UserArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::DeleteUser

Returns: a Paws::AlexaForBusiness::DeleteUserResponse instance

Deletes a specified user by user ARN and enrollment ARN.

DisassociateContactFromAddressBook

AddressBookArn => Str
ContactArn => Str

Each argument is described in detail in: Paws::AlexaForBusiness::DisassociateContactFromAddressBook

Returns: a Paws::AlexaForBusiness::DisassociateContactFromAddressBookResponse instance

Disassociates a contact from a given address book.

DisassociateDeviceFromRoom

[DeviceArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::DisassociateDeviceFromRoom

Returns: a Paws::AlexaForBusiness::DisassociateDeviceFromRoomResponse instance

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

DisassociateSkillGroupFromRoom

[RoomArn => Str]
[SkillGroupArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::DisassociateSkillGroupFromRoom

Returns: a Paws::AlexaForBusiness::DisassociateSkillGroupFromRoomResponse instance

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

GetAddressBook

AddressBookArn => Str

Each argument is described in detail in: Paws::AlexaForBusiness::GetAddressBook

Returns: a Paws::AlexaForBusiness::GetAddressBookResponse instance

Gets address the book details by the address book ARN.

GetContact

ContactArn => Str

Each argument is described in detail in: Paws::AlexaForBusiness::GetContact

Returns: a Paws::AlexaForBusiness::GetContactResponse instance

Gets the contact details by the contact ARN.

GetDevice

[DeviceArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::GetDevice

Returns: a Paws::AlexaForBusiness::GetDeviceResponse instance

Gets the details of a device by device ARN.

GetProfile

[ProfileArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::GetProfile

Returns: a Paws::AlexaForBusiness::GetProfileResponse instance

Gets the details of a room profile by profile ARN.

GetRoom

[RoomArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::GetRoom

Returns: a Paws::AlexaForBusiness::GetRoomResponse instance

Gets room details by room ARN.

GetRoomSkillParameter

ParameterKey => Str
SkillId => Str
[RoomArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::GetRoomSkillParameter

Returns: a Paws::AlexaForBusiness::GetRoomSkillParameterResponse instance

Gets room skill parameter details by room, skill, and parameter key ARN.

GetSkillGroup

[SkillGroupArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::GetSkillGroup

Returns: a Paws::AlexaForBusiness::GetSkillGroupResponse instance

Gets skill group details by skill group ARN.

ListDeviceEvents

DeviceArn => Str
[EventType => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::ListDeviceEvents

Returns: a Paws::AlexaForBusiness::ListDeviceEventsResponse instance

Lists the Device Event history for up to 30 days. If EventType isn't specified in the request, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

ListSkills

[MaxResults => Int]
[NextToken => Str]
[SkillGroupArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::ListSkills

Returns: a Paws::AlexaForBusiness::ListSkillsResponse instance

Lists all enabled skills in a specific skill group.

ListTags

Arn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::ListTags

Returns: a Paws::AlexaForBusiness::ListTagsResponse instance

Lists all tags for a specific resource.

PutRoomSkillParameter

RoomSkillParameter => Paws::AlexaForBusiness::RoomSkillParameter
SkillId => Str
[RoomArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::PutRoomSkillParameter

Returns: a Paws::AlexaForBusiness::PutRoomSkillParameterResponse instance

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

ResolveRoom

SkillId => Str
UserId => Str

Each argument is described in detail in: Paws::AlexaForBusiness::ResolveRoom

Returns: a Paws::AlexaForBusiness::ResolveRoomResponse instance

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

RevokeInvitation

[EnrollmentId => Str]
[UserArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::RevokeInvitation

Returns: a Paws::AlexaForBusiness::RevokeInvitationResponse instance

Revokes an invitation and invalidates the enrollment URL.

SearchAddressBooks

[Filters => ArrayRef[Paws::AlexaForBusiness::Filter]]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]]

Each argument is described in detail in: Paws::AlexaForBusiness::SearchAddressBooks

Returns: a Paws::AlexaForBusiness::SearchAddressBooksResponse instance

Searches address books and lists the ones that meet a set of filter and sort criteria.

SearchContacts

[Filters => ArrayRef[Paws::AlexaForBusiness::Filter]]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]]

Each argument is described in detail in: Paws::AlexaForBusiness::SearchContacts

Returns: a Paws::AlexaForBusiness::SearchContactsResponse instance

Searches contacts and lists the ones that meet a set of filter and sort criteria.

SearchDevices

[Filters => ArrayRef[Paws::AlexaForBusiness::Filter]]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]]

Each argument is described in detail in: Paws::AlexaForBusiness::SearchDevices

Returns: a Paws::AlexaForBusiness::SearchDevicesResponse instance

Searches devices and lists the ones that meet a set of filter criteria.

SearchProfiles

[Filters => ArrayRef[Paws::AlexaForBusiness::Filter]]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]]

Each argument is described in detail in: Paws::AlexaForBusiness::SearchProfiles

Returns: a Paws::AlexaForBusiness::SearchProfilesResponse instance

Searches room profiles and lists the ones that meet a set of filter criteria.

SearchRooms

[Filters => ArrayRef[Paws::AlexaForBusiness::Filter]]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]]

Each argument is described in detail in: Paws::AlexaForBusiness::SearchRooms

Returns: a Paws::AlexaForBusiness::SearchRoomsResponse instance

Searches rooms and lists the ones that meet a set of filter and sort criteria.

SearchSkillGroups

[Filters => ArrayRef[Paws::AlexaForBusiness::Filter]]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]]

Each argument is described in detail in: Paws::AlexaForBusiness::SearchSkillGroups

Returns: a Paws::AlexaForBusiness::SearchSkillGroupsResponse instance

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

SearchUsers

[Filters => ArrayRef[Paws::AlexaForBusiness::Filter]]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]]

Each argument is described in detail in: Paws::AlexaForBusiness::SearchUsers

Returns: a Paws::AlexaForBusiness::SearchUsersResponse instance

Searches users and lists the ones that meet a set of filter and sort criteria.

SendInvitation

[UserArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::SendInvitation

Returns: a Paws::AlexaForBusiness::SendInvitationResponse instance

Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.

StartDeviceSync

Features => ArrayRef[Str|Undef]
[DeviceArn => Str]
[RoomArn => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::StartDeviceSync

Returns: a Paws::AlexaForBusiness::StartDeviceSyncResponse instance

Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.

TagResource

Arn => Str
Tags => ArrayRef[Paws::AlexaForBusiness::Tag]

Each argument is described in detail in: Paws::AlexaForBusiness::TagResource

Returns: a Paws::AlexaForBusiness::TagResourceResponse instance

Adds metadata tags to a specified resource.

UntagResource

Arn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::AlexaForBusiness::UntagResource

Returns: a Paws::AlexaForBusiness::UntagResourceResponse instance

Removes metadata tags from a specified resource.

UpdateAddressBook

AddressBookArn => Str
[Description => Str]
[Name => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::UpdateAddressBook

Returns: a Paws::AlexaForBusiness::UpdateAddressBookResponse instance

Updates address book details by the address book ARN.

UpdateContact

ContactArn => Str
[DisplayName => Str]
[FirstName => Str]
[LastName => Str]
[PhoneNumber => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::UpdateContact

Returns: a Paws::AlexaForBusiness::UpdateContactResponse instance

Updates the contact details by the contact ARN.

UpdateDevice

[DeviceArn => Str]
[DeviceName => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::UpdateDevice

Returns: a Paws::AlexaForBusiness::UpdateDeviceResponse instance

Updates the device name by device ARN.

UpdateProfile

[Address => Str]
[DistanceUnit => Str]
[MaxVolumeLimit => Int]
[ProfileArn => Str]
[ProfileName => Str]
[PSTNEnabled => Bool]
[SetupModeDisabled => Bool]
[TemperatureUnit => Str]
[Timezone => Str]
[WakeWord => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::UpdateProfile

Returns: a Paws::AlexaForBusiness::UpdateProfileResponse instance

Updates an existing room profile by room profile ARN.

UpdateRoom

[Description => Str]
[ProfileArn => Str]
[ProviderCalendarId => Str]
[RoomArn => Str]
[RoomName => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::UpdateRoom

Returns: a Paws::AlexaForBusiness::UpdateRoomResponse instance

Updates room details by room ARN.

UpdateSkillGroup

[Description => Str]
[SkillGroupArn => Str]
[SkillGroupName => Str]

Each argument is described in detail in: Paws::AlexaForBusiness::UpdateSkillGroup

Returns: a Paws::AlexaForBusiness::UpdateSkillGroupResponse instance

Updates skill group details by skill group ARN.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllSkills(sub { },[MaxResults => Int, NextToken => Str, SkillGroupArn => Str])

ListAllSkills([MaxResults => Int, NextToken => Str, SkillGroupArn => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - SkillSummaries, passing the object as the first parameter, and the string 'SkillSummaries' as the second parameter 

If not, it will return a a Paws::AlexaForBusiness::ListSkillsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTags(sub { },Arn => Str, [MaxResults => Int, NextToken => Str])

ListAllTags(Arn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Tags, passing the object as the first parameter, and the string 'Tags' as the second parameter 

If not, it will return a a Paws::AlexaForBusiness::ListTagsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SearchAllDevices(sub { },[Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

SearchAllDevices([Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Devices, passing the object as the first parameter, and the string 'Devices' as the second parameter 

If not, it will return a a Paws::AlexaForBusiness::SearchDevicesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SearchAllProfiles(sub { },[Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

SearchAllProfiles([Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Profiles, passing the object as the first parameter, and the string 'Profiles' as the second parameter 

If not, it will return a a Paws::AlexaForBusiness::SearchProfilesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SearchAllRooms(sub { },[Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

SearchAllRooms([Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Rooms, passing the object as the first parameter, and the string 'Rooms' as the second parameter 

If not, it will return a a Paws::AlexaForBusiness::SearchRoomsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SearchAllSkillGroups(sub { },[Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

SearchAllSkillGroups([Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - SkillGroups, passing the object as the first parameter, and the string 'SkillGroups' as the second parameter 

If not, it will return a a Paws::AlexaForBusiness::SearchSkillGroupsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SearchAllUsers(sub { },[Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

SearchAllUsers([Filters => ArrayRef[Paws::AlexaForBusiness::Filter], MaxResults => Int, NextToken => Str, SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Users, passing the object as the first parameter, and the string 'Users' as the second parameter 

If not, it will return a a Paws::AlexaForBusiness::SearchUsersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

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