5.0.0 • Published 7 years ago

@datafire/amazonaws_a4b v5.0.0

Weekly downloads
27
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_a4b

Client library for Alexa For Business

Installation and Usage

npm install --save @datafire/amazonaws_a4b
let amazonaws_a4b = require('@datafire/amazonaws_a4b').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_a4b.AssociateDeviceWithRoom({}).then(data => {
  console.log(data);
});

Description

Alexa for Business makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need 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 APIs, and you can make these available as private skills for your organization. Alexa for Business also makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.

Actions

AssociateDeviceWithRoom

amazonaws_a4b.AssociateDeviceWithRoom({}, context)

Input

  • input object

Output

AssociateSkillGroupWithRoom

amazonaws_a4b.AssociateSkillGroupWithRoom({}, context)

Input

  • input object

Output

CreateProfile

amazonaws_a4b.CreateProfile({
  "ProfileName": "",
  "Timezone": "",
  "Address": "",
  "DistanceUnit": "",
  "TemperatureUnit": "",
  "WakeWord": ""
}, context)

Input

Output

CreateRoom

amazonaws_a4b.CreateRoom({
  "RoomName": ""
}, context)

Input

Output

CreateSkillGroup

amazonaws_a4b.CreateSkillGroup({
  "SkillGroupName": ""
}, context)

Input

Output

CreateUser

amazonaws_a4b.CreateUser({
  "UserId": ""
}, context)

Input

Output

DeleteProfile

amazonaws_a4b.DeleteProfile({}, context)

Input

  • input object

Output

DeleteRoom

amazonaws_a4b.DeleteRoom({}, context)

Input

  • input object

Output

DeleteRoomSkillParameter

amazonaws_a4b.DeleteRoomSkillParameter({
  "SkillId": "",
  "ParameterKey": ""
}, context)

Input

Output

DeleteSkillGroup

amazonaws_a4b.DeleteSkillGroup({}, context)

Input

  • input object
    • SkillGroupArn Arn

Output

DeleteUser

amazonaws_a4b.DeleteUser({
  "EnrollmentId": ""
}, context)

Input

Output

DisassociateDeviceFromRoom

amazonaws_a4b.DisassociateDeviceFromRoom({}, context)

Input

  • input object

Output

DisassociateSkillGroupFromRoom

amazonaws_a4b.DisassociateSkillGroupFromRoom({}, context)

Input

  • input object

Output

GetDevice

amazonaws_a4b.GetDevice({}, context)

Input

  • input object

Output

GetProfile

amazonaws_a4b.GetProfile({}, context)

Input

  • input object

Output

GetRoom

amazonaws_a4b.GetRoom({}, context)

Input

  • input object

Output

GetRoomSkillParameter

amazonaws_a4b.GetRoomSkillParameter({
  "SkillId": "",
  "ParameterKey": ""
}, context)

Input

Output

GetSkillGroup

amazonaws_a4b.GetSkillGroup({}, context)

Input

  • input object
    • SkillGroupArn Arn

Output

ListSkills

amazonaws_a4b.ListSkills({}, context)

Input

Output

ListTags

amazonaws_a4b.ListTags({
  "Arn": ""
}, context)

Input

Output

PutRoomSkillParameter

amazonaws_a4b.PutRoomSkillParameter({
  "SkillId": "",
  "RoomSkillParameter": {
    "ParameterKey": "",
    "ParameterValue": ""
  }
}, context)

Input

Output

ResolveRoom

amazonaws_a4b.ResolveRoom({
  "UserId": "",
  "SkillId": ""
}, context)

Input

Output

RevokeInvitation

amazonaws_a4b.RevokeInvitation({}, context)

Input

Output

SearchDevices

amazonaws_a4b.SearchDevices({}, context)

Input

Output

SearchProfiles

amazonaws_a4b.SearchProfiles({}, context)

Input

Output

SearchRooms

amazonaws_a4b.SearchRooms({}, context)

Input

Output

SearchSkillGroups

amazonaws_a4b.SearchSkillGroups({}, context)

Input

Output

SearchUsers

amazonaws_a4b.SearchUsers({}, context)

Input

Output

SendInvitation

amazonaws_a4b.SendInvitation({}, context)

Input

  • input object

Output

StartDeviceSync

amazonaws_a4b.StartDeviceSync({
  "Features": []
}, context)

Input

Output

TagResource

amazonaws_a4b.TagResource({
  "Arn": "",
  "Tags": []
}, context)

Input

Output

UntagResource

amazonaws_a4b.UntagResource({
  "Arn": "",
  "TagKeys": []
}, context)

Input

Output

UpdateDevice

amazonaws_a4b.UpdateDevice({}, context)

Input

Output

UpdateProfile

amazonaws_a4b.UpdateProfile({}, context)

Input

Output

UpdateRoom

amazonaws_a4b.UpdateRoom({}, context)

Input

Output

UpdateSkillGroup

amazonaws_a4b.UpdateSkillGroup({}, context)

Input

Output

Definitions

Address

  • Address string

AlreadyExistsException

  • AlreadyExistsException object: The resource being created already exists. HTTP Status Code: 400

Arn

  • Arn string

AssociateDeviceWithRoomRequest

  • AssociateDeviceWithRoomRequest object

AssociateDeviceWithRoomResponse

  • AssociateDeviceWithRoomResponse object

AssociateSkillGroupWithRoomRequest

  • AssociateSkillGroupWithRoomRequest object

AssociateSkillGroupWithRoomResponse

  • AssociateSkillGroupWithRoomResponse object

Boolean

  • Boolean boolean

ClientRequestToken

  • ClientRequestToken string: User specified token that is used to support idempotency during Create Resource

CreateProfileRequest

CreateProfileResponse

  • CreateProfileResponse object

CreateRoomRequest

CreateRoomResponse

  • CreateRoomResponse object

CreateSkillGroupRequest

CreateSkillGroupResponse

  • CreateSkillGroupResponse object
    • SkillGroupArn Arn

CreateUserRequest

CreateUserResponse

  • CreateUserResponse object

DeleteProfileRequest

  • DeleteProfileRequest object

DeleteProfileResponse

  • DeleteProfileResponse object

DeleteRoomRequest

  • DeleteRoomRequest object

DeleteRoomResponse

  • DeleteRoomResponse object

DeleteRoomSkillParameterRequest

DeleteRoomSkillParameterResponse

  • DeleteRoomSkillParameterResponse object

DeleteSkillGroupRequest

  • DeleteSkillGroupRequest object
    • SkillGroupArn Arn

DeleteSkillGroupResponse

  • DeleteSkillGroupResponse object

DeleteUserRequest

DeleteUserResponse

  • DeleteUserResponse object

Device

DeviceData

DeviceDataList

DeviceName

  • DeviceName string

DeviceSerialNumber

  • DeviceSerialNumber string

DeviceStatus

  • DeviceStatus string (values: READY, PENDING, WAS_OFFLINE)

DeviceStatusDetail

DeviceStatusDetailCode

  • DeviceStatusDetailCode string (values: DEVICE_SOFTWARE_UPDATE_NEEDED, DEVICE_WAS_OFFLINE)

DeviceStatusDetails

DeviceStatusInfo

  • DeviceStatusInfo object: Detailed information about a device's status.

DeviceType

  • DeviceType string

DisassociateDeviceFromRoomRequest

  • DisassociateDeviceFromRoomRequest object

DisassociateDeviceFromRoomResponse

  • DisassociateDeviceFromRoomResponse object

DisassociateSkillGroupFromRoomRequest

  • DisassociateSkillGroupFromRoomRequest object

DisassociateSkillGroupFromRoomResponse

  • DisassociateSkillGroupFromRoomResponse object

DistanceUnit

  • DistanceUnit string (values: METRIC, IMPERIAL)

Email

  • Email string

EnrollmentId

  • EnrollmentId string

EnrollmentStatus

  • EnrollmentStatus string (values: INITIALIZED, PENDING, REGISTERED, DEREGISTERING)

ErrorMessage

  • ErrorMessage string

Feature

  • Feature string (values: BLUETOOTH, VOLUME, NOTIFICATIONS, LISTS, SKILLS, ALL)

Features

Filter

  • Filter object: A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

FilterKey

  • FilterKey string

FilterList

FilterValue

  • FilterValue string

FilterValueList

GetDeviceRequest

  • GetDeviceRequest object

GetDeviceResponse

  • GetDeviceResponse object

GetProfileRequest

  • GetProfileRequest object

GetProfileResponse

  • GetProfileResponse object

GetRoomRequest

  • GetRoomRequest object

GetRoomResponse

  • GetRoomResponse object

GetRoomSkillParameterRequest

GetRoomSkillParameterResponse

GetSkillGroupRequest

  • GetSkillGroupRequest object
    • SkillGroupArn Arn

GetSkillGroupResponse

InvalidUserStatusException

  • InvalidUserStatusException object: The attempt to update a user is invalid due to the user's current status. HTTP Status Code: 400

LimitExceededException

  • LimitExceededException object: You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400

ListSkillsRequest

ListSkillsResponse

ListTagsRequest

ListTagsResponse

MacAddress

  • MacAddress string

MaxResults

  • MaxResults integer

MaxVolumeLimit

  • MaxVolumeLimit integer

NameInUseException

  • NameInUseException object: The name sent in the request is already in use. HTTP Status Code: 400

NextToken

  • NextToken string

NotFoundException

  • NotFoundException object: The resource is not found. HTTP Status Code: 400

Profile

ProfileData

ProfileDataList

ProfileName

  • ProfileName string

ProviderCalendarId

  • ProviderCalendarId string

PutRoomSkillParameterRequest

PutRoomSkillParameterResponse

  • PutRoomSkillParameterResponse object

ResolveRoomRequest

  • ResolveRoomRequest object

ResolveRoomResponse

ResourceInUseException

  • ResourceInUseException object: The resource in the request is already in use. HTTP Status Code: 400

RevokeInvitationRequest

RevokeInvitationResponse

  • RevokeInvitationResponse object

Room

RoomData

RoomDataList

RoomDescription

  • RoomDescription string

RoomName

  • RoomName string

RoomSkillParameter

RoomSkillParameterKey

  • RoomSkillParameterKey string

RoomSkillParameterValue

  • RoomSkillParameterValue string

RoomSkillParameters

SearchDevicesRequest

SearchDevicesResponse

SearchProfilesRequest

SearchProfilesResponse

SearchRoomsRequest

SearchRoomsResponse

SearchSkillGroupsRequest

SearchSkillGroupsResponse

SearchUsersRequest

SearchUsersResponse

SendInvitationRequest

  • SendInvitationRequest object

SendInvitationResponse

  • SendInvitationResponse object

SkillGroup

SkillGroupData

SkillGroupDataList

SkillGroupDescription

  • SkillGroupDescription string

SkillGroupName

  • SkillGroupName string

SkillId

  • SkillId string

SkillListMaxResults

  • SkillListMaxResults integer

SkillName

  • SkillName string

SkillSummary

SkillSummaryList

SoftwareVersion

  • SoftwareVersion string

Sort

  • Sort object: An object representing a sort criteria.

SortKey

  • SortKey string

SortList

  • SortList array

SortValue

  • SortValue string (values: ASC, DESC)

StartDeviceSyncRequest

  • StartDeviceSyncRequest object

StartDeviceSyncResponse

  • StartDeviceSyncResponse object

Tag

  • Tag object: A key-value pair that can be associated with a resource.

TagKey

  • TagKey string

TagKeyList

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

TemperatureUnit

  • TemperatureUnit string (values: FAHRENHEIT, CELSIUS)

Timezone

  • Timezone string

TotalCount

  • TotalCount integer

UntagResourceRequest

  • UntagResourceRequest object

UntagResourceResponse

  • UntagResourceResponse object

UpdateDeviceRequest

UpdateDeviceResponse

  • UpdateDeviceResponse object

UpdateProfileRequest

UpdateProfileResponse

  • UpdateProfileResponse object

UpdateRoomRequest

UpdateRoomResponse

  • UpdateRoomResponse object

UpdateSkillGroupRequest

UpdateSkillGroupResponse

  • UpdateSkillGroupResponse object

UserData

UserDataList

UserId

  • UserId string

WakeWord

  • WakeWord string (values: ALEXA, AMAZON, ECHO, COMPUTER)

boolean

  • boolean boolean

user_FirstName

  • user_FirstName string

user_LastName

  • user_LastName string

user_UserId

  • user_UserId string