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 helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage 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 also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/a4b-2017-11-09

METHODS

ApproveSkill

SkillId => Str

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

Returns: a Paws::AlexaForBusiness::ApproveSkillResponse instance

Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.

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.

AssociateDeviceWithNetworkProfile

DeviceArn => Str
NetworkProfileArn => Str

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

Returns: a Paws::AlexaForBusiness::AssociateDeviceWithNetworkProfileResponse instance

Associates a device with the specified network profile.

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.

AssociateSkillWithSkillGroup

SkillId => Str
[SkillGroupArn => Str]

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

Returns: a Paws::AlexaForBusiness::AssociateSkillWithSkillGroupResponse instance

Associates a skill with a skill group.

AssociateSkillWithUsers

SkillId => Str

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

Returns: a Paws::AlexaForBusiness::AssociateSkillWithUsersResponse instance

Makes a private skill available for enrolled users to enable on their devices.

CreateAddressBook

Name => Str
[ClientRequestToken => Str]
[Description => Str]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

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

Returns: a Paws::AlexaForBusiness::CreateAddressBookResponse instance

Creates an address book with the specified details.

CreateBusinessReportSchedule

ContentRange => Paws::AlexaForBusiness::BusinessReportContentRange
Format => Str
[ClientRequestToken => Str]
[Recurrence => Paws::AlexaForBusiness::BusinessReportRecurrence]
[S3BucketName => Str]
[S3KeyPrefix => Str]
[ScheduleName => Str]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

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

Returns: a Paws::AlexaForBusiness::CreateBusinessReportScheduleResponse instance

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

CreateConferenceProvider

ConferenceProviderName => Str
ConferenceProviderType => Str
MeetingSetting => Paws::AlexaForBusiness::MeetingSetting
[ClientRequestToken => Str]
[IPDialIn => Paws::AlexaForBusiness::IPDialIn]
[PSTNDialIn => Paws::AlexaForBusiness::PSTNDialIn]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

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

Returns: a Paws::AlexaForBusiness::CreateConferenceProviderResponse instance

Adds a new conference provider under the user's AWS account.

CreateContact

FirstName => Str
[ClientRequestToken => Str]
[DisplayName => Str]
[LastName => Str]
[PhoneNumber => Str]
[PhoneNumbers => ArrayRef[Paws::AlexaForBusiness::PhoneNumber]]
[SipAddresses => ArrayRef[Paws::AlexaForBusiness::SipAddress]]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

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

Returns: a Paws::AlexaForBusiness::CreateContactResponse instance

Creates a contact with the specified details.

CreateGatewayGroup

ClientRequestToken => Str
Name => Str
[Description => Str]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

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

Returns: a Paws::AlexaForBusiness::CreateGatewayGroupResponse instance

Creates a gateway group with the specified details.

CreateNetworkProfile

ClientRequestToken => Str
NetworkProfileName => Str
SecurityType => Str
Ssid => Str
[CertificateAuthorityArn => Str]
[CurrentPassword => Str]
[Description => Str]
[EapMethod => Str]
[NextPassword => Str]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]
[TrustAnchors => ArrayRef[Str|Undef]]

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

Returns: a Paws::AlexaForBusiness::CreateNetworkProfileResponse instance

Creates a network profile with the specified details.

CreateProfile

Address => Str
DistanceUnit => Str
ProfileName => Str
TemperatureUnit => Str
Timezone => Str
WakeWord => Str
[ClientRequestToken => Str]
[DataRetentionOptIn => Bool]
[Locale => Str]
[MaxVolumeLimit => Int]
[MeetingRoomConfiguration => Paws::AlexaForBusiness::CreateMeetingRoomConfiguration]
[PSTNEnabled => Bool]
[SetupModeDisabled => Bool]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

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]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

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.

DeleteBusinessReportSchedule

ScheduleArn => Str

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

Returns: a Paws::AlexaForBusiness::DeleteBusinessReportScheduleResponse instance

Deletes the recurring report delivery schedule with the specified schedule ARN.

DeleteConferenceProvider

ConferenceProviderArn => Str

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

Returns: a Paws::AlexaForBusiness::DeleteConferenceProviderResponse instance

Deletes a conference provider.

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.

DeleteDevice

DeviceArn => Str

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

Returns: a Paws::AlexaForBusiness::DeleteDeviceResponse instance

Removes a device from Alexa For Business.

DeleteDeviceUsageData

DeviceArn => Str
DeviceUsageType => Str

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

Returns: a Paws::AlexaForBusiness::DeleteDeviceUsageDataResponse instance

When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.

DeleteGatewayGroup

GatewayGroupArn => Str

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

Returns: a Paws::AlexaForBusiness::DeleteGatewayGroupResponse instance

Deletes a gateway group.

DeleteNetworkProfile

NetworkProfileArn => Str

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

Returns: a Paws::AlexaForBusiness::DeleteNetworkProfileResponse instance

Deletes a network profile by the network profile 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.

DeleteSkillAuthorization

SkillId => Str
[RoomArn => Str]

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

Returns: a Paws::AlexaForBusiness::DeleteSkillAuthorizationResponse instance

Unlinks a third-party account from a skill.

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.

DisassociateSkillFromSkillGroup

SkillId => Str
[SkillGroupArn => Str]

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

Returns: a Paws::AlexaForBusiness::DisassociateSkillFromSkillGroupResponse instance

Disassociates a skill from a skill group.

DisassociateSkillFromUsers

SkillId => Str

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

Returns: a Paws::AlexaForBusiness::DisassociateSkillFromUsersResponse instance

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

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.

ForgetSmartHomeAppliances

RoomArn => Str

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

Returns: a Paws::AlexaForBusiness::ForgetSmartHomeAppliancesResponse instance

Forgets smart home appliances associated to a 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.

GetConferencePreference

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

Returns: a Paws::AlexaForBusiness::GetConferencePreferenceResponse instance

Retrieves the existing conference preferences.

GetConferenceProvider

ConferenceProviderArn => Str

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

Returns: a Paws::AlexaForBusiness::GetConferenceProviderResponse instance

Gets details about a specific conference provider.

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.

GetGateway

GatewayArn => Str

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

Returns: a Paws::AlexaForBusiness::GetGatewayResponse instance

Retrieves the details of a gateway.

GetGatewayGroup

GatewayGroupArn => Str

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

Returns: a Paws::AlexaForBusiness::GetGatewayGroupResponse instance

Retrieves the details of a gateway group.

GetInvitationConfiguration

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

Returns: a Paws::AlexaForBusiness::GetInvitationConfigurationResponse instance

Retrieves the configured values for the user enrollment invitation email template.

GetNetworkProfile

NetworkProfileArn => Str

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

Returns: a Paws::AlexaForBusiness::GetNetworkProfileResponse instance

Gets the network profile details by the network profile 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.

ListBusinessReportSchedules

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

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

Returns: a Paws::AlexaForBusiness::ListBusinessReportSchedulesResponse instance

Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.

ListConferenceProviders

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

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

Returns: a Paws::AlexaForBusiness::ListConferenceProvidersResponse instance

Lists conference providers under a specific AWS account.

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, including device connection status, for up to 30 days.

ListGatewayGroups

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

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

Returns: a Paws::AlexaForBusiness::ListGatewayGroupsResponse instance

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

ListGateways

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

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

Returns: a Paws::AlexaForBusiness::ListGatewaysResponse instance

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

ListSkills

[EnablementType => Str]
[MaxResults => Int]
[NextToken => Str]
[SkillGroupArn => Str]
[SkillType => 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.

ListSkillsStoreCategories

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

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

Returns: a Paws::AlexaForBusiness::ListSkillsStoreCategoriesResponse instance

Lists all categories in the Alexa skill store.

ListSkillsStoreSkillsByCategory

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

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

Returns: a Paws::AlexaForBusiness::ListSkillsStoreSkillsByCategoryResponse instance

Lists all skills in the Alexa skill store by category.

ListSmartHomeAppliances

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

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

Returns: a Paws::AlexaForBusiness::ListSmartHomeAppliancesResponse instance

Lists all of the smart home appliances associated with a room.

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 the specified resource.

PutConferencePreference

ConferencePreference => Paws::AlexaForBusiness::ConferencePreference

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

Returns: a Paws::AlexaForBusiness::PutConferencePreferenceResponse instance

Sets the conference preferences on a specific conference provider at the account level.

PutInvitationConfiguration

OrganizationName => Str
[ContactEmail => Str]
[PrivateSkillIds => ArrayRef[Str|Undef]]

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

Returns: a Paws::AlexaForBusiness::PutInvitationConfigurationResponse instance

Configures the email template for the user enrollment invitation with the specified attributes.

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.

PutSkillAuthorization

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

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

Returns: a Paws::AlexaForBusiness::PutSkillAuthorizationResponse instance

Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.

RegisterAVSDevice

AmazonId => Str
ClientId => Str
ProductId => Str
UserCode => Str
[DeviceSerialNumber => Str]
[RoomArn => Str]
[Tags => ArrayRef[Paws::AlexaForBusiness::Tag]]

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

Returns: a Paws::AlexaForBusiness::RegisterAVSDeviceResponse instance

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

RejectSkill

SkillId => Str

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

Returns: a Paws::AlexaForBusiness::RejectSkillResponse instance

Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.

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.

To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.

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.

SearchNetworkProfiles

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

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

Returns: a Paws::AlexaForBusiness::SearchNetworkProfilesResponse instance

Searches network profiles and lists the ones that meet a set of filter and sort 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.

SendAnnouncement

ClientRequestToken => Str
Content => Paws::AlexaForBusiness::Content
RoomFilters => ArrayRef[Paws::AlexaForBusiness::Filter]
[TimeToLiveInSeconds => Int]

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

Returns: a Paws::AlexaForBusiness::SendAnnouncementResponse instance

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

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 30 days 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. This clears all information and settings set by previous users in the following ways:

Bluetooth - This unpairs all bluetooth devices paired with your echo device.
Volume - This resets the echo device's volume to the default value.
Notifications - This clears all notifications from your echo device.
Lists - This clears all to-do items from your echo device.
Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).

StartSmartHomeApplianceDiscovery

RoomArn => Str

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

Returns: a Paws::AlexaForBusiness::StartSmartHomeApplianceDiscoveryResponse instance

Initiates the discovery of any smart home appliances associated with the room.

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.

UpdateBusinessReportSchedule

ScheduleArn => Str
[Format => Str]
[Recurrence => Paws::AlexaForBusiness::BusinessReportRecurrence]
[S3BucketName => Str]
[S3KeyPrefix => Str]
[ScheduleName => Str]

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

Returns: a Paws::AlexaForBusiness::UpdateBusinessReportScheduleResponse instance

Updates the configuration of the report delivery schedule with the specified schedule ARN.

UpdateConferenceProvider

ConferenceProviderArn => Str
ConferenceProviderType => Str
MeetingSetting => Paws::AlexaForBusiness::MeetingSetting
[IPDialIn => Paws::AlexaForBusiness::IPDialIn]
[PSTNDialIn => Paws::AlexaForBusiness::PSTNDialIn]

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

Returns: a Paws::AlexaForBusiness::UpdateConferenceProviderResponse instance

Updates an existing conference provider's settings.

UpdateContact

ContactArn => Str
[DisplayName => Str]
[FirstName => Str]
[LastName => Str]
[PhoneNumber => Str]
[PhoneNumbers => ArrayRef[Paws::AlexaForBusiness::PhoneNumber]]
[SipAddresses => ArrayRef[Paws::AlexaForBusiness::SipAddress]]

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.

UpdateGateway

GatewayArn => Str
[Description => Str]
[Name => Str]
[SoftwareVersion => Str]

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

Returns: a Paws::AlexaForBusiness::UpdateGatewayResponse instance

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

UpdateGatewayGroup

GatewayGroupArn => Str
[Description => Str]
[Name => Str]

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

Returns: a Paws::AlexaForBusiness::UpdateGatewayGroupResponse instance

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

UpdateNetworkProfile

NetworkProfileArn => Str
[CertificateAuthorityArn => Str]
[CurrentPassword => Str]
[Description => Str]
[NetworkProfileName => Str]
[NextPassword => Str]
[TrustAnchors => ArrayRef[Str|Undef]]

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

Returns: a Paws::AlexaForBusiness::UpdateNetworkProfileResponse instance

Updates a network profile by the network profile ARN.

UpdateProfile

[Address => Str]
[DataRetentionOptIn => Bool]
[DistanceUnit => Str]
[IsDefault => Bool]
[Locale => Str]
[MaxVolumeLimit => Int]
[MeetingRoomConfiguration => Paws::AlexaForBusiness::UpdateMeetingRoomConfiguration]
[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