Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- SearchUsers (Paginated)
- AssociateSkillGroupWithRoom
- DeleteProfile
- UpdateProfile
- SearchRooms (Paginated)
- DisassociateContactFromAddressBook
- CreateAddressBook
- DeleteAddressBook
- UpdateAddressBook
- UpdateRoom
- DeleteRoom
- GetDevice
- GetContact
- AssociateDeviceWithRoom
- GetRoomSkillParameter
- DeleteContact
- UpdateContact
- GetAddressBook
- CreateContact
- CreateProfile
- DeleteSkillGroup
- UpdateSkillGroup
- StartDeviceSync
- SearchAddressBooks
- CreateSkillGroup
- GetProfile
- DisassociateSkillGroupFromRoom
- SendInvitation
- ListDeviceEvents
- CreateUser
- SearchDevices (Paginated)
- SearchContacts
- DeleteUser
- GetSkillGroup
- ListSkills (Paginated)
- TagResource
- DisassociateDeviceFromRoom
- SearchSkillGroups (Paginated)
- ListTags (Paginated)
- UntagResource
- ResolveRoom
- CreateRoom
- DeleteRoomSkillParameter
- PutRoomSkillParameter
- SearchProfiles (Paginated)
- RevokeInvitation
- UpdateDevice
- GetRoom
- AssociateContactWithAddressBook
- Types
- ConnectionStatus
- DeviceEventType
- DeviceStatus
- DeviceStatusDetailCode
- DistanceUnit
- EnrollmentStatus
- Feature
- SortValue
- TemperatureUnit
- WakeWord
- AddressBook
- AddressBookData
- Contact
- ContactData
- Device
- DeviceData
- DeviceEvent
- DeviceStatusDetail
- DeviceStatusInfo
- Filter
- Profile
- ProfileData
- Room
- RoomData
- RoomSkillParameter
- SkillGroup
- SkillGroupData
- SkillSummary
- Sort
- Tag
- UserData
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.
- alexaBusiness :: Service
- _InvalidUserStatusException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _NameInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.AlexaBusiness.SearchUsers
- module Network.AWS.AlexaBusiness.AssociateSkillGroupWithRoom
- module Network.AWS.AlexaBusiness.DeleteProfile
- module Network.AWS.AlexaBusiness.UpdateProfile
- module Network.AWS.AlexaBusiness.SearchRooms
- module Network.AWS.AlexaBusiness.DisassociateContactFromAddressBook
- module Network.AWS.AlexaBusiness.CreateAddressBook
- module Network.AWS.AlexaBusiness.DeleteAddressBook
- module Network.AWS.AlexaBusiness.UpdateAddressBook
- module Network.AWS.AlexaBusiness.UpdateRoom
- module Network.AWS.AlexaBusiness.DeleteRoom
- module Network.AWS.AlexaBusiness.GetDevice
- module Network.AWS.AlexaBusiness.GetContact
- module Network.AWS.AlexaBusiness.AssociateDeviceWithRoom
- module Network.AWS.AlexaBusiness.GetRoomSkillParameter
- module Network.AWS.AlexaBusiness.DeleteContact
- module Network.AWS.AlexaBusiness.UpdateContact
- module Network.AWS.AlexaBusiness.GetAddressBook
- module Network.AWS.AlexaBusiness.CreateContact
- module Network.AWS.AlexaBusiness.CreateProfile
- module Network.AWS.AlexaBusiness.DeleteSkillGroup
- module Network.AWS.AlexaBusiness.UpdateSkillGroup
- module Network.AWS.AlexaBusiness.StartDeviceSync
- module Network.AWS.AlexaBusiness.SearchAddressBooks
- module Network.AWS.AlexaBusiness.CreateSkillGroup
- module Network.AWS.AlexaBusiness.GetProfile
- module Network.AWS.AlexaBusiness.DisassociateSkillGroupFromRoom
- module Network.AWS.AlexaBusiness.SendInvitation
- module Network.AWS.AlexaBusiness.ListDeviceEvents
- module Network.AWS.AlexaBusiness.CreateUser
- module Network.AWS.AlexaBusiness.SearchDevices
- module Network.AWS.AlexaBusiness.SearchContacts
- module Network.AWS.AlexaBusiness.DeleteUser
- module Network.AWS.AlexaBusiness.GetSkillGroup
- module Network.AWS.AlexaBusiness.ListSkills
- module Network.AWS.AlexaBusiness.TagResource
- module Network.AWS.AlexaBusiness.DisassociateDeviceFromRoom
- module Network.AWS.AlexaBusiness.SearchSkillGroups
- module Network.AWS.AlexaBusiness.ListTags
- module Network.AWS.AlexaBusiness.UntagResource
- module Network.AWS.AlexaBusiness.ResolveRoom
- module Network.AWS.AlexaBusiness.CreateRoom
- module Network.AWS.AlexaBusiness.DeleteRoomSkillParameter
- module Network.AWS.AlexaBusiness.PutRoomSkillParameter
- module Network.AWS.AlexaBusiness.SearchProfiles
- module Network.AWS.AlexaBusiness.RevokeInvitation
- module Network.AWS.AlexaBusiness.UpdateDevice
- module Network.AWS.AlexaBusiness.GetRoom
- module Network.AWS.AlexaBusiness.AssociateContactWithAddressBook
- data ConnectionStatus
- data DeviceEventType
- data DeviceStatus
- data DeviceStatusDetailCode
- data DistanceUnit
- data EnrollmentStatus
- data Feature
- data SortValue
- data TemperatureUnit
- data WakeWord
- data AddressBook
- addressBook :: AddressBook
- abAddressBookARN :: Lens' AddressBook (Maybe Text)
- abName :: Lens' AddressBook (Maybe Text)
- abDescription :: Lens' AddressBook (Maybe Text)
- data AddressBookData
- addressBookData :: AddressBookData
- abdAddressBookARN :: Lens' AddressBookData (Maybe Text)
- abdName :: Lens' AddressBookData (Maybe Text)
- abdDescription :: Lens' AddressBookData (Maybe Text)
- data Contact
- contact :: Contact
- cLastName :: Lens' Contact (Maybe Text)
- cContactARN :: Lens' Contact (Maybe Text)
- cPhoneNumber :: Lens' Contact (Maybe Text)
- cFirstName :: Lens' Contact (Maybe Text)
- cDisplayName :: Lens' Contact (Maybe Text)
- data ContactData
- contactData :: ContactData
- cdLastName :: Lens' ContactData (Maybe Text)
- cdContactARN :: Lens' ContactData (Maybe Text)
- cdPhoneNumber :: Lens' ContactData (Maybe Text)
- cdFirstName :: Lens' ContactData (Maybe Text)
- cdDisplayName :: Lens' ContactData (Maybe Text)
- data Device
- device :: Device
- dDeviceStatus :: Lens' Device (Maybe DeviceStatus)
- dDeviceStatusInfo :: Lens' Device (Maybe DeviceStatusInfo)
- dDeviceARN :: Lens' Device (Maybe Text)
- dMACAddress :: Lens' Device (Maybe Text)
- dDeviceName :: Lens' Device (Maybe Text)
- dRoomARN :: Lens' Device (Maybe Text)
- dSoftwareVersion :: Lens' Device (Maybe Text)
- dDeviceType :: Lens' Device (Maybe Text)
- dDeviceSerialNumber :: Lens' Device (Maybe Text)
- data DeviceData
- deviceData :: DeviceData
- ddDeviceStatus :: Lens' DeviceData (Maybe DeviceStatus)
- ddDeviceStatusInfo :: Lens' DeviceData (Maybe DeviceStatusInfo)
- ddDeviceARN :: Lens' DeviceData (Maybe Text)
- ddMACAddress :: Lens' DeviceData (Maybe Text)
- ddDeviceName :: Lens' DeviceData (Maybe Text)
- ddRoomARN :: Lens' DeviceData (Maybe Text)
- ddSoftwareVersion :: Lens' DeviceData (Maybe Text)
- ddDeviceType :: Lens' DeviceData (Maybe Text)
- ddRoomName :: Lens' DeviceData (Maybe Text)
- ddDeviceSerialNumber :: Lens' DeviceData (Maybe Text)
- data DeviceEvent
- deviceEvent :: DeviceEvent
- deValue :: Lens' DeviceEvent (Maybe Text)
- deType :: Lens' DeviceEvent (Maybe DeviceEventType)
- deTimestamp :: Lens' DeviceEvent (Maybe UTCTime)
- data DeviceStatusDetail
- deviceStatusDetail :: DeviceStatusDetail
- dsdCode :: Lens' DeviceStatusDetail (Maybe DeviceStatusDetailCode)
- data DeviceStatusInfo
- deviceStatusInfo :: DeviceStatusInfo
- dsiDeviceStatusDetails :: Lens' DeviceStatusInfo [DeviceStatusDetail]
- dsiConnectionStatus :: Lens' DeviceStatusInfo (Maybe ConnectionStatus)
- data Filter
- filter' :: Text -> Filter
- fKey :: Lens' Filter Text
- fValues :: Lens' Filter [Text]
- data Profile
- profile :: Profile
- pSetupModeDisabled :: Lens' Profile (Maybe Bool)
- pPSTNEnabled :: Lens' Profile (Maybe Bool)
- pDistanceUnit :: Lens' Profile (Maybe DistanceUnit)
- pAddress :: Lens' Profile (Maybe Text)
- pProfileARN :: Lens' Profile (Maybe Text)
- pWakeWord :: Lens' Profile (Maybe WakeWord)
- pProfileName :: Lens' Profile (Maybe Text)
- pTemperatureUnit :: Lens' Profile (Maybe TemperatureUnit)
- pTimezone :: Lens' Profile (Maybe Text)
- pMaxVolumeLimit :: Lens' Profile (Maybe Int)
- data ProfileData
- profileData :: ProfileData
- pdDistanceUnit :: Lens' ProfileData (Maybe DistanceUnit)
- pdAddress :: Lens' ProfileData (Maybe Text)
- pdProfileARN :: Lens' ProfileData (Maybe Text)
- pdWakeWord :: Lens' ProfileData (Maybe WakeWord)
- pdProfileName :: Lens' ProfileData (Maybe Text)
- pdTemperatureUnit :: Lens' ProfileData (Maybe TemperatureUnit)
- pdTimezone :: Lens' ProfileData (Maybe Text)
- data Room
- room :: Room
- rProfileARN :: Lens' Room (Maybe Text)
- rProviderCalendarId :: Lens' Room (Maybe Text)
- rRoomARN :: Lens' Room (Maybe Text)
- rRoomName :: Lens' Room (Maybe Text)
- rDescription :: Lens' Room (Maybe Text)
- data RoomData
- roomData :: RoomData
- rdProfileARN :: Lens' RoomData (Maybe Text)
- rdProviderCalendarId :: Lens' RoomData (Maybe Text)
- rdProfileName :: Lens' RoomData (Maybe Text)
- rdRoomARN :: Lens' RoomData (Maybe Text)
- rdRoomName :: Lens' RoomData (Maybe Text)
- rdDescription :: Lens' RoomData (Maybe Text)
- data RoomSkillParameter
- roomSkillParameter :: Text -> Text -> RoomSkillParameter
- rspParameterKey :: Lens' RoomSkillParameter Text
- rspParameterValue :: Lens' RoomSkillParameter Text
- data SkillGroup
- skillGroup :: SkillGroup
- sgSkillGroupARN :: Lens' SkillGroup (Maybe Text)
- sgDescription :: Lens' SkillGroup (Maybe Text)
- sgSkillGroupName :: Lens' SkillGroup (Maybe Text)
- data SkillGroupData
- skillGroupData :: SkillGroupData
- sgdSkillGroupARN :: Lens' SkillGroupData (Maybe Text)
- sgdDescription :: Lens' SkillGroupData (Maybe Text)
- sgdSkillGroupName :: Lens' SkillGroupData (Maybe Text)
- data SkillSummary
- skillSummary :: SkillSummary
- ssSkillId :: Lens' SkillSummary (Maybe Text)
- ssSupportsLinking :: Lens' SkillSummary (Maybe Bool)
- ssSkillName :: Lens' SkillSummary (Maybe Text)
- data Sort
- sort :: Text -> SortValue -> Sort
- sKey :: Lens' Sort Text
- sValue :: Lens' Sort SortValue
- data Tag
- tag :: Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag (Maybe Text)
- data UserData
- userData :: UserData
- udEmail :: Lens' UserData (Maybe Text)
- udLastName :: Lens' UserData (Maybe Text)
- udEnrollmentId :: Lens' UserData (Maybe Text)
- udUserARN :: Lens' UserData (Maybe Text)
- udFirstName :: Lens' UserData (Maybe Text)
- udEnrollmentStatus :: Lens' UserData (Maybe EnrollmentStatus)
Service Configuration
alexaBusiness :: Service Source #
API version 2017-11-09
of the Amazon Alexa For Business SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AlexaBusiness
.
InvalidUserStatusException
_InvalidUserStatusException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The attempt to update a user is invalid due to the user's current status. HTTP Status Code: 400
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is not found. HTTP Status Code: 400
NameInUseException
_NameInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The name sent in the request is already in use. HTTP Status Code: 400
AlreadyExistsException
_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource being created already exists. HTTP Status Code: 400
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource in the request is already in use. HTTP Status Code: 400
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
SearchUsers (Paginated)
AssociateSkillGroupWithRoom
DeleteProfile
UpdateProfile
SearchRooms (Paginated)
DisassociateContactFromAddressBook
CreateAddressBook
DeleteAddressBook
UpdateAddressBook
UpdateRoom
DeleteRoom
GetDevice
GetContact
AssociateDeviceWithRoom
GetRoomSkillParameter
DeleteContact
UpdateContact
GetAddressBook
CreateContact
CreateProfile
DeleteSkillGroup
UpdateSkillGroup
StartDeviceSync
SearchAddressBooks
CreateSkillGroup
GetProfile
DisassociateSkillGroupFromRoom
SendInvitation
ListDeviceEvents
CreateUser
SearchDevices (Paginated)
SearchContacts
DeleteUser
GetSkillGroup
ListSkills (Paginated)
TagResource
DisassociateDeviceFromRoom
SearchSkillGroups (Paginated)
ListTags (Paginated)
UntagResource
ResolveRoom
CreateRoom
DeleteRoomSkillParameter
PutRoomSkillParameter
SearchProfiles (Paginated)
RevokeInvitation
UpdateDevice
GetRoom
AssociateContactWithAddressBook
Types
ConnectionStatus
data ConnectionStatus Source #
DeviceEventType
data DeviceEventType Source #
DeviceStatus
data DeviceStatus Source #
DeviceStatusDetailCode
data DeviceStatusDetailCode Source #
DistanceUnit
data DistanceUnit Source #
EnrollmentStatus
data EnrollmentStatus Source #
Feature
SortValue
TemperatureUnit
data TemperatureUnit Source #
WakeWord
AddressBook
data AddressBook Source #
An address book with attributes.
See: addressBook
smart constructor.
addressBook :: AddressBook Source #
Creates a value of AddressBook
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
abAddressBookARN
- The ARN of the address book.abName
- The name of the address book.abDescription
- The description of the address book.
abAddressBookARN :: Lens' AddressBook (Maybe Text) Source #
The ARN of the address book.
abDescription :: Lens' AddressBook (Maybe Text) Source #
The description of the address book.
AddressBookData
data AddressBookData Source #
Information related to an address book.
See: addressBookData
smart constructor.
addressBookData :: AddressBookData Source #
Creates a value of AddressBookData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
abdAddressBookARN
- The ARN of the address book.abdName
- The name of the address book.abdDescription
- The description of the address book.
abdAddressBookARN :: Lens' AddressBookData (Maybe Text) Source #
The ARN of the address book.
abdDescription :: Lens' AddressBookData (Maybe Text) Source #
The description of the address book.
Contact
A contact with attributes.
See: contact
smart constructor.
Creates a value of Contact
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cLastName
- The last name of the contact, used to call the contact on the device.cContactARN
- The ARN of the contact.cPhoneNumber
- The phone number of the contact.cFirstName
- The first name of the contact, used to call the contact on the device.cDisplayName
- The name of the contact to display on the console.
cLastName :: Lens' Contact (Maybe Text) Source #
The last name of the contact, used to call the contact on the device.
cFirstName :: Lens' Contact (Maybe Text) Source #
The first name of the contact, used to call the contact on the device.
cDisplayName :: Lens' Contact (Maybe Text) Source #
The name of the contact to display on the console.
ContactData
data ContactData Source #
Information related to a contact.
See: contactData
smart constructor.
contactData :: ContactData Source #
Creates a value of ContactData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdLastName
- The last name of the contact, used to call the contact on the device.cdContactARN
- The ARN of the contact.cdPhoneNumber
- The phone number of the contact.cdFirstName
- The first name of the contact, used to call the contact on the device.cdDisplayName
- The name of the contact to display on the console.
cdLastName :: Lens' ContactData (Maybe Text) Source #
The last name of the contact, used to call the contact on the device.
cdContactARN :: Lens' ContactData (Maybe Text) Source #
The ARN of the contact.
cdPhoneNumber :: Lens' ContactData (Maybe Text) Source #
The phone number of the contact.
cdFirstName :: Lens' ContactData (Maybe Text) Source #
The first name of the contact, used to call the contact on the device.
cdDisplayName :: Lens' ContactData (Maybe Text) Source #
The name of the contact to display on the console.
Device
A device with attributes.
See: device
smart constructor.
Creates a value of Device
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dDeviceStatus
- The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.dDeviceStatusInfo
- Detailed information about a device's status.dDeviceARN
- The ARN of a device.dMACAddress
- The MAC address of a device.dDeviceName
- The name of a device.dRoomARN
- The room ARN of a device.dSoftwareVersion
- The software version of a device.dDeviceType
- The type of a device.dDeviceSerialNumber
- The serial number of a device.
dDeviceStatus :: Lens' Device (Maybe DeviceStatus) Source #
The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
dDeviceStatusInfo :: Lens' Device (Maybe DeviceStatusInfo) Source #
Detailed information about a device's status.
DeviceData
data DeviceData Source #
Device attributes.
See: deviceData
smart constructor.
deviceData :: DeviceData Source #
Creates a value of DeviceData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddDeviceStatus
- The status of a device.ddDeviceStatusInfo
- Detailed information about a device's status.ddDeviceARN
- The ARN of a device.ddMACAddress
- The MAC address of a device.ddDeviceName
- The name of a device.ddRoomARN
- The room ARN associated with a device.ddSoftwareVersion
- The software version of a device.ddDeviceType
- The type of a device.ddRoomName
- The name of the room associated with a device.ddDeviceSerialNumber
- The serial number of a device.
ddDeviceStatus :: Lens' DeviceData (Maybe DeviceStatus) Source #
The status of a device.
ddDeviceStatusInfo :: Lens' DeviceData (Maybe DeviceStatusInfo) Source #
Detailed information about a device's status.
ddDeviceARN :: Lens' DeviceData (Maybe Text) Source #
The ARN of a device.
ddMACAddress :: Lens' DeviceData (Maybe Text) Source #
The MAC address of a device.
ddDeviceName :: Lens' DeviceData (Maybe Text) Source #
The name of a device.
ddSoftwareVersion :: Lens' DeviceData (Maybe Text) Source #
The software version of a device.
ddDeviceType :: Lens' DeviceData (Maybe Text) Source #
The type of a device.
ddRoomName :: Lens' DeviceData (Maybe Text) Source #
The name of the room associated with a device.
ddDeviceSerialNumber :: Lens' DeviceData (Maybe Text) Source #
The serial number of a device.
DeviceEvent
data DeviceEvent Source #
The list of device events.
See: deviceEvent
smart constructor.
deviceEvent :: DeviceEvent Source #
Creates a value of DeviceEvent
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
deValue
- The value of the event.deType
- The type of device event.deTimestamp
- The time (in epoch) when the event occurred.
deType :: Lens' DeviceEvent (Maybe DeviceEventType) Source #
The type of device event.
deTimestamp :: Lens' DeviceEvent (Maybe UTCTime) Source #
The time (in epoch) when the event occurred.
DeviceStatusDetail
data DeviceStatusDetail Source #
Details of a device’s status.
See: deviceStatusDetail
smart constructor.
deviceStatusDetail :: DeviceStatusDetail Source #
Creates a value of DeviceStatusDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsdCode
- The device status detail code.
dsdCode :: Lens' DeviceStatusDetail (Maybe DeviceStatusDetailCode) Source #
The device status detail code.
DeviceStatusInfo
data DeviceStatusInfo Source #
Detailed information about a device's status.
See: deviceStatusInfo
smart constructor.
deviceStatusInfo :: DeviceStatusInfo Source #
Creates a value of DeviceStatusInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsiDeviceStatusDetails
- One or more device status detail descriptions.dsiConnectionStatus
- The latest available information about the connection status of a device.
dsiDeviceStatusDetails :: Lens' DeviceStatusInfo [DeviceStatusDetail] Source #
One or more device status detail descriptions.
dsiConnectionStatus :: Lens' DeviceStatusInfo (Maybe ConnectionStatus) Source #
The latest available information about the connection status of a device.
Filter
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.
See: filter'
smart constructor.
Profile
A room profile with attributes.
See: profile
smart constructor.
Creates a value of Profile
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pSetupModeDisabled
- The setup mode of a room profile.pPSTNEnabled
- The PSTN setting of a room profile.pDistanceUnit
- The distance unit of a room profile.pAddress
- The address of a room profile.pProfileARN
- The ARN of a room profile.pWakeWord
- The wake word of a room profile.pProfileName
- The name of a room profile.pTemperatureUnit
- The temperature unit of a room profile.pTimezone
- The time zone of a room profile.pMaxVolumeLimit
- The max volume limit of a room profile.
pDistanceUnit :: Lens' Profile (Maybe DistanceUnit) Source #
The distance unit of a room profile.
pTemperatureUnit :: Lens' Profile (Maybe TemperatureUnit) Source #
The temperature unit of a room profile.
ProfileData
data ProfileData Source #
The data of a room profile.
See: profileData
smart constructor.
profileData :: ProfileData Source #
Creates a value of ProfileData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdDistanceUnit
- The distance unit of a room profile.pdAddress
- The address of a room profile.pdProfileARN
- The ARN of a room profile.pdWakeWord
- The wake word of a room profile.pdProfileName
- The name of a room profile.pdTemperatureUnit
- The temperature unit of a room profile.pdTimezone
- The timezone of a room profile.
pdDistanceUnit :: Lens' ProfileData (Maybe DistanceUnit) Source #
The distance unit of a room profile.
pdProfileARN :: Lens' ProfileData (Maybe Text) Source #
The ARN of a room profile.
pdWakeWord :: Lens' ProfileData (Maybe WakeWord) Source #
The wake word of a room profile.
pdProfileName :: Lens' ProfileData (Maybe Text) Source #
The name of a room profile.
pdTemperatureUnit :: Lens' ProfileData (Maybe TemperatureUnit) Source #
The temperature unit of a room profile.
pdTimezone :: Lens' ProfileData (Maybe Text) Source #
The timezone of a room profile.
Room
A room with attributes.
See: room
smart constructor.
Creates a value of Room
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rProfileARN
- The profile ARN of a room.rProviderCalendarId
- The provider calendar ARN of a room.rRoomARN
- The ARN of a room.rRoomName
- The name of a room.rDescription
- The description of a room.
RoomData
The data of a room.
See: roomData
smart constructor.
Creates a value of RoomData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdProfileARN
- The profile ARN of a room.rdProviderCalendarId
- The provider calendar ARN of a room.rdProfileName
- The profile name of a room.rdRoomARN
- The ARN of a room.rdRoomName
- The name of a room.rdDescription
- The description of a room.
RoomSkillParameter
data RoomSkillParameter Source #
A skill parameter associated with a room.
See: roomSkillParameter
smart constructor.
Creates a value of RoomSkillParameter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rspParameterKey
- The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.rspParameterValue
- The parameter value of a room skill parameter.
rspParameterKey :: Lens' RoomSkillParameter Text Source #
The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
rspParameterValue :: Lens' RoomSkillParameter Text Source #
The parameter value of a room skill parameter.
SkillGroup
data SkillGroup Source #
A skill group with attributes.
See: skillGroup
smart constructor.
skillGroup :: SkillGroup Source #
Creates a value of SkillGroup
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sgSkillGroupARN
- The ARN of a skill group.sgDescription
- The description of a skill group.sgSkillGroupName
- The name of a skill group.
sgSkillGroupARN :: Lens' SkillGroup (Maybe Text) Source #
The ARN of a skill group.
sgDescription :: Lens' SkillGroup (Maybe Text) Source #
The description of a skill group.
sgSkillGroupName :: Lens' SkillGroup (Maybe Text) Source #
The name of a skill group.
SkillGroupData
data SkillGroupData Source #
The attributes of a skill group.
See: skillGroupData
smart constructor.
skillGroupData :: SkillGroupData Source #
Creates a value of SkillGroupData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sgdSkillGroupARN
- The skill group ARN of a skill group.sgdDescription
- The description of a skill group.sgdSkillGroupName
- The skill group name of a skill group.
sgdSkillGroupARN :: Lens' SkillGroupData (Maybe Text) Source #
The skill group ARN of a skill group.
sgdDescription :: Lens' SkillGroupData (Maybe Text) Source #
The description of a skill group.
sgdSkillGroupName :: Lens' SkillGroupData (Maybe Text) Source #
The skill group name of a skill group.
SkillSummary
data SkillSummary Source #
The summary of skills.
See: skillSummary
smart constructor.
skillSummary :: SkillSummary Source #
Creates a value of SkillSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssSkillId
- The ARN of the skill summary.ssSupportsLinking
- Linking support for a skill.ssSkillName
- The name of the skill.
ssSupportsLinking :: Lens' SkillSummary (Maybe Bool) Source #
Linking support for a skill.
ssSkillName :: Lens' SkillSummary (Maybe Text) Source #
The name of the skill.
Sort
An object representing a sort criteria.
See: sort
smart constructor.
Tag
A key-value pair that can be associated with a resource.
See: tag
smart constructor.
tagValue :: Lens' Tag (Maybe Text) Source #
The value of a tag. Tag values are case-sensitive and can be null.
UserData
Information related to a user.
See: userData
smart constructor.
Creates a value of UserData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udEmail
- The email of a user.udLastName
- The last name of a user.udEnrollmentId
- The enrollment ARN of a user.udUserARN
- The ARN of a user.udFirstName
- The first name of a user.udEnrollmentStatus
- The enrollment status of a user.
udEnrollmentStatus :: Lens' UserData (Maybe EnrollmentStatus) Source #
The enrollment status of a user.