Alexa For Business 2017-11-09
- Client: Aws\AlexaForBusiness\AlexaForBusinessClient
- Service ID: alexaforbusiness
- Version: 2017-11-09
This page describes the parameters and results for the operations of the Alexa For Business (2017-11-09), and shows how to use the Aws\AlexaForBusiness\AlexaForBusinessClient object to call the described operations. This documentation is specific to the 2017-11-09 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- ApproveSkill ( array $params = [] )
Associates a skill with the organization under the customer's AWS account.
- AssociateContactWithAddressBook ( array $params = [] )
Associates a contact with a given address book.
- AssociateDeviceWithNetworkProfile ( array $params = [] )
Associates a device with the specified network profile.
- AssociateDeviceWithRoom ( array $params = [] )
Associates a device with a given room.
- AssociateSkillGroupWithRoom ( array $params = [] )
Associates a skill group with a given room.
- AssociateSkillWithSkillGroup ( array $params = [] )
Associates a skill with a skill group.
- AssociateSkillWithUsers ( array $params = [] )
Makes a private skill available for enrolled users to enable on their devices.
- CreateAddressBook ( array $params = [] )
Creates an address book with the specified details.
- CreateBusinessReportSchedule ( array $params = [] )
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
- CreateConferenceProvider ( array $params = [] )
Adds a new conference provider under the user's AWS account.
- CreateContact ( array $params = [] )
Creates a contact with the specified details.
- CreateGatewayGroup ( array $params = [] )
Creates a gateway group with the specified details.
- CreateNetworkProfile ( array $params = [] )
Creates a network profile with the specified details.
- CreateProfile ( array $params = [] )
Creates a new room profile with the specified details.
- CreateRoom ( array $params = [] )
Creates a room with the specified details.
- CreateSkillGroup ( array $params = [] )
Creates a skill group with a specified name and description.
- CreateUser ( array $params = [] )
Creates a user.
- DeleteAddressBook ( array $params = [] )
Deletes an address book by the address book ARN.
- DeleteBusinessReportSchedule ( array $params = [] )
Deletes the recurring report delivery schedule with the specified schedule ARN.
- DeleteConferenceProvider ( array $params = [] )
Deletes a conference provider.
- DeleteContact ( array $params = [] )
Deletes a contact by the contact ARN.
- DeleteDevice ( array $params = [] )
Removes a device from Alexa For Business.
- DeleteDeviceUsageData ( array $params = [] )
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.
- DeleteGatewayGroup ( array $params = [] )
Deletes a gateway group.
- DeleteNetworkProfile ( array $params = [] )
Deletes a network profile by the network profile ARN.
- DeleteProfile ( array $params = [] )
Deletes a room profile by the profile ARN.
- DeleteRoom ( array $params = [] )
Deletes a room by the room ARN.
- DeleteRoomSkillParameter ( array $params = [] )
Deletes room skill parameter details by room, skill, and parameter key ID.
- DeleteSkillAuthorization ( array $params = [] )
Unlinks a third-party account from a skill.
- DeleteSkillGroup ( array $params = [] )
Deletes a skill group by skill group ARN.
- DeleteUser ( array $params = [] )
Deletes a specified user by user ARN and enrollment ARN.
- DisassociateContactFromAddressBook ( array $params = [] )
Disassociates a contact from a given address book.
- DisassociateDeviceFromRoom ( array $params = [] )
Disassociates a device from its current room.
- DisassociateSkillFromSkillGroup ( array $params = [] )
Disassociates a skill from a skill group.
- DisassociateSkillFromUsers ( array $params = [] )
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
- DisassociateSkillGroupFromRoom ( array $params = [] )
Disassociates a skill group from a specified room.
- ForgetSmartHomeAppliances ( array $params = [] )
Forgets smart home appliances associated to a room.
- GetAddressBook ( array $params = [] )
Gets address the book details by the address book ARN.
- GetConferencePreference ( array $params = [] )
Retrieves the existing conference preferences.
- GetConferenceProvider ( array $params = [] )
Gets details about a specific conference provider.
- GetContact ( array $params = [] )
Gets the contact details by the contact ARN.
- GetDevice ( array $params = [] )
Gets the details of a device by device ARN.
- GetGateway ( array $params = [] )
Retrieves the details of a gateway.
- GetGatewayGroup ( array $params = [] )
Retrieves the details of a gateway group.
- GetInvitationConfiguration ( array $params = [] )
Retrieves the configured values for the user enrollment invitation email template.
- GetNetworkProfile ( array $params = [] )
Gets the network profile details by the network profile ARN.
- GetProfile ( array $params = [] )
Gets the details of a room profile by profile ARN.
- GetRoom ( array $params = [] )
Gets room details by room ARN.
- GetRoomSkillParameter ( array $params = [] )
Gets room skill parameter details by room, skill, and parameter key ARN.
- GetSkillGroup ( array $params = [] )
Gets skill group details by skill group ARN.
- ListBusinessReportSchedules ( array $params = [] )
Lists the details of the schedules that a user configured.
- ListConferenceProviders ( array $params = [] )
Lists conference providers under a specific AWS account.
- ListDeviceEvents ( array $params = [] )
Lists the device event history, including device connection status, for up to 30 days.
- ListGatewayGroups ( array $params = [] )
Retrieves a list of gateway group summaries.
- ListGateways ( array $params = [] )
Retrieves a list of gateway summaries.
- ListSkills ( array $params = [] )
Lists all enabled skills in a specific skill group.
- ListSkillsStoreCategories ( array $params = [] )
Lists all categories in the Alexa skill store.
- ListSkillsStoreSkillsByCategory ( array $params = [] )
Lists all skills in the Alexa skill store by category.
- ListSmartHomeAppliances ( array $params = [] )
Lists all of the smart home appliances associated with a room.
- ListTags ( array $params = [] )
Lists all tags for the specified resource.
- PutConferencePreference ( array $params = [] )
Sets the conference preferences on a specific conference provider at the account level.
- PutInvitationConfiguration ( array $params = [] )
Configures the email template for the user enrollment invitation with the specified attributes.
- PutRoomSkillParameter ( array $params = [] )
Updates room skill parameter details by room, skill, and parameter key ID.
- PutSkillAuthorization ( array $params = [] )
Links a user's account to a third-party skill provider.
- RegisterAVSDevice ( array $params = [] )
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
- RejectSkill ( array $params = [] )
Disassociates a skill from the organization under a user's AWS account.
- ResolveRoom ( array $params = [] )
Determines the details for the room from which a skill request was invoked.
- RevokeInvitation ( array $params = [] )
Revokes an invitation and invalidates the enrollment URL.
- SearchAddressBooks ( array $params = [] )
Searches address books and lists the ones that meet a set of filter and sort criteria.
- SearchContacts ( array $params = [] )
Searches contacts and lists the ones that meet a set of filter and sort criteria.
- SearchDevices ( array $params = [] )
Searches devices and lists the ones that meet a set of filter criteria.
- SearchNetworkProfiles ( array $params = [] )
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
- SearchProfiles ( array $params = [] )
Searches room profiles and lists the ones that meet a set of filter criteria.
- SearchRooms ( array $params = [] )
Searches rooms and lists the ones that meet a set of filter and sort criteria.
- SearchSkillGroups ( array $params = [] )
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
- SearchUsers ( array $params = [] )
Searches users and lists the ones that meet a set of filter and sort criteria.
- SendAnnouncement ( array $params = [] )
Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
- SendInvitation ( array $params = [] )
Sends an enrollment invitation email with a URL to a user.
- StartDeviceSync ( array $params = [] )
Resets a device and its account to the known default settings.
- StartSmartHomeApplianceDiscovery ( array $params = [] )
Initiates the discovery of any smart home appliances associated with the room.
- TagResource ( array $params = [] )
Adds metadata tags to a specified resource.
- UntagResource ( array $params = [] )
Removes metadata tags from a specified resource.
- UpdateAddressBook ( array $params = [] )
Updates address book details by the address book ARN.
- UpdateBusinessReportSchedule ( array $params = [] )
Updates the configuration of the report delivery schedule with the specified schedule ARN.
- UpdateConferenceProvider ( array $params = [] )
Updates an existing conference provider's settings.
- UpdateContact ( array $params = [] )
Updates the contact details by the contact ARN.
- UpdateDevice ( array $params = [] )
Updates the device name by device ARN.
- UpdateGateway ( array $params = [] )
Updates the details of a gateway.
- UpdateGatewayGroup ( array $params = [] )
Updates the details of a gateway group.
- UpdateNetworkProfile ( array $params = [] )
Updates a network profile by the network profile ARN.
- UpdateProfile ( array $params = [] )
Updates an existing room profile by room profile ARN.
- UpdateRoom ( array $params = [] )
Updates room details by room ARN.
- UpdateSkillGroup ( array $params = [] )
Updates skill group details by skill group ARN.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListBusinessReportSchedules
- ListConferenceProviders
- ListDeviceEvents
- ListGatewayGroups
- ListGateways
- ListSkills
- ListSkillsStoreCategories
- ListSkillsStoreSkillsByCategory
- ListSmartHomeAppliances
- ListTags
- SearchAddressBooks
- SearchContacts
- SearchDevices
- SearchNetworkProfiles
- SearchProfiles
- SearchRooms
- SearchSkillGroups
- SearchUsers
Operations
ApproveSkill
$result = $client->approveSkill([/* ... */]); $promise = $client->approveSkillAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->approveSkill([
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
You are performing an action that would put you beyond your account's limits.
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
AssociateContactWithAddressBook
$result = $client->associateContactWithAddressBook([/* ... */]); $promise = $client->associateContactWithAddressBookAsync([/* ... */]);
Associates a contact with a given address book.
Parameter Syntax
$result = $client->associateContactWithAddressBook([
'AddressBookArn' => '<string>', // REQUIRED
'ContactArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
You are performing an action that would put you beyond your account's limits.
AssociateDeviceWithNetworkProfile
$result = $client->associateDeviceWithNetworkProfile([/* ... */]); $promise = $client->associateDeviceWithNetworkProfileAsync([/* ... */]);
Associates a device with the specified network profile.
Parameter Syntax
$result = $client->associateDeviceWithNetworkProfile([
'DeviceArn' => '<string>', // REQUIRED
'NetworkProfileArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The request failed because this device is no longer registered and therefore no longer managed by this account.
AssociateDeviceWithRoom
$result = $client->associateDeviceWithRoom([/* ... */]); $promise = $client->associateDeviceWithRoomAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateDeviceWithRoom([
'DeviceArn' => '<string>',
'RoomArn' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
You are performing an action that would put you beyond your account's limits.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The request failed because this device is no longer registered and therefore no longer managed by this account.
AssociateSkillGroupWithRoom
$result = $client->associateSkillGroupWithRoom([/* ... */]); $promise = $client->associateSkillGroupWithRoomAsync([/* ... */]);
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
Parameter Syntax
$result = $client->associateSkillGroupWithRoom([
'RoomArn' => '<string>',
'SkillGroupArn' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
AssociateSkillWithSkillGroup
$result = $client->associateSkillWithSkillGroup([/* ... */]); $promise = $client->associateSkillWithSkillGroupAsync([/* ... */]);
Associates a skill with a skill group.
Parameter Syntax
$result = $client->associateSkillWithSkillGroup([
'SkillGroupArn' => '<string>',
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The resource is not found.
-
The skill must be linked to a third-party account.
AssociateSkillWithUsers
$result = $client->associateSkillWithUsers([/* ... */]); $promise = $client->associateSkillWithUsersAsync([/* ... */]);
Makes a private skill available for enrolled users to enable on their devices.
Parameter Syntax
$result = $client->associateSkillWithUsers([
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The resource is not found.
CreateAddressBook
$result = $client->createAddressBook([/* ... */]); $promise = $client->createAddressBookAsync([/* ... */]);
Creates an address book with the specified details.
Parameter Syntax
$result = $client->createAddressBook([
'ClientRequestToken' => '<string>',
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
A unique, user-specified identifier for the request that ensures idempotency.
- Description
-
- Type: string
The description of the address book.
- Name
-
- Required: Yes
- Type: string
The name of the address book.
- Tags
-
- Type: Array of Tag structures
The tags to be added to the specified resource. Do not provide system tags.
Result Syntax
[
'AddressBookArn' => '<string>',
]
Result Details
Errors
-
The resource being created already exists.
-
You are performing an action that would put you beyond your account's limits.
CreateBusinessReportSchedule
$result = $client->createBusinessReportSchedule([/* ... */]); $promise = $client->createBusinessReportScheduleAsync([/* ... */]);
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
Parameter Syntax
$result = $client->createBusinessReportSchedule([
'ClientRequestToken' => '<string>',
'ContentRange' => [ // REQUIRED
'Interval' => 'ONE_DAY|ONE_WEEK|THIRTY_DAYS', // REQUIRED
],
'Format' => 'CSV|CSV_ZIP', // REQUIRED
'Recurrence' => [
'StartDate' => '<string>',
],
'S3BucketName' => '<string>',
'S3KeyPrefix' => '<string>',
'ScheduleName' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
The client request token.
- ContentRange
-
- Required: Yes
- Type: BusinessReportContentRange structure
The content range of the reports.
- Format
-
- Required: Yes
- Type: string
The format of the generated report (individual CSV files or zipped files of individual files).
- Recurrence
-
- Type: BusinessReportRecurrence structure
The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
- S3BucketName
-
- Type: string
The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.
- S3KeyPrefix
-
- Type: string
The S3 key where the report is delivered.
- ScheduleName
-
- Type: string
The name identifier of the schedule.
- Tags
-
- Type: Array of Tag structures
The tags for the business report schedule.
Result Syntax
[
'ScheduleArn' => '<string>',
]
Result Details
Errors
-
The resource being created already exists.
CreateConferenceProvider
$result = $client->createConferenceProvider([/* ... */]); $promise = $client->createConferenceProviderAsync([/* ... */]);
Adds a new conference provider under the user's AWS account.
Parameter Syntax
$result = $client->createConferenceProvider([
'ClientRequestToken' => '<string>',
'ConferenceProviderName' => '<string>', // REQUIRED
'ConferenceProviderType' => 'CHIME|BLUEJEANS|FUZE|GOOGLE_HANGOUTS|POLYCOM|RINGCENTRAL|SKYPE_FOR_BUSINESS|WEBEX|ZOOM|CUSTOM', // REQUIRED
'IPDialIn' => [
'CommsProtocol' => 'SIP|SIPS|H323', // REQUIRED
'Endpoint' => '<string>', // REQUIRED
],
'MeetingSetting' => [ // REQUIRED
'RequirePin' => 'YES|NO|OPTIONAL', // REQUIRED
],
'PSTNDialIn' => [
'CountryCode' => '<string>', // REQUIRED
'OneClickIdDelay' => '<string>', // REQUIRED
'OneClickPinDelay' => '<string>', // REQUIRED
'PhoneNumber' => '<string>', // REQUIRED
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
The request token of the client.
- ConferenceProviderName
-
- Required: Yes
- Type: string
The name of the conference provider.
- ConferenceProviderType
-
- Required: Yes
- Type: string
Represents a type within a list of predefined types.
- IPDialIn
-
- Type: IPDialIn structure
The IP endpoint and protocol for calling.
- MeetingSetting
-
- Required: Yes
- Type: MeetingSetting structure
The meeting settings for the conference provider.
- PSTNDialIn
-
- Type: PSTNDialIn structure
The information for PSTN conferencing.
- Tags
-
- Type: Array of Tag structures
The tags to be added to the specified resource. Do not provide system tags.
Result Syntax
[
'ConferenceProviderArn' => '<string>',
]
Result Details
Errors
-
The resource being created already exists.
CreateContact
$result = $client->createContact([/* ... */]); $promise = $client->createContactAsync([/* ... */]);
Creates a contact with the specified details.
Parameter Syntax
$result = $client->createContact([
'ClientRequestToken' => '<string>',
'DisplayName' => '<string>',
'FirstName' => '<string>', // REQUIRED
'LastName' => '<string>',
'PhoneNumber' => '<string>',
'PhoneNumbers' => [
[
'Number' => '<string>', // REQUIRED
'Type' => 'MOBILE|WORK|HOME', // REQUIRED
],
// ...
],
'SipAddresses' => [
[
'Type' => 'WORK', // REQUIRED
'Uri' => '<string>', // REQUIRED
],
// ...
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
A unique, user-specified identifier for this request that ensures idempotency.
- DisplayName
-
- Type: string
The name of the contact to display on the console.
- FirstName
-
- Required: Yes
- Type: string
The first name of the contact that is used to call the contact on the device.
- LastName
-
- Type: string
The last name of the contact that is used to call the contact on the device.
- PhoneNumber
-
- Type: string
The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
- PhoneNumbers
-
- Type: Array of PhoneNumber structures
The list of phone numbers for the contact.
- SipAddresses
-
- Type: Array of SipAddress structures
The list of SIP addresses for the contact.
- Tags
-
- Type: Array of Tag structures
The tags to be added to the specified resource. Do not provide system tags.
Result Syntax
[
'ContactArn' => '<string>',
]
Result Details
Errors
-
The resource being created already exists.
-
You are performing an action that would put you beyond your account's limits.
CreateGatewayGroup
$result = $client->createGatewayGroup([/* ... */]); $promise = $client->createGatewayGroupAsync([/* ... */]);
Creates a gateway group with the specified details.
Parameter Syntax
$result = $client->createGatewayGroup([
'ClientRequestToken' => '<string>', // REQUIRED
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
A unique, user-specified identifier for the request that ensures idempotency.
- Description
-
- Type: string
The description of the gateway group.
- Name
-
- Required: Yes
- Type: string
The name of the gateway group.
- Tags
-
- Type: Array of Tag structures
The tags to be added to the specified resource. Do not provide system tags.
Result Syntax
[
'GatewayGroupArn' => '<string>',
]
Result Details
Errors
-
The resource being created already exists.
-
You are performing an action that would put you beyond your account's limits.
CreateNetworkProfile
$result = $client->createNetworkProfile([/* ... */]); $promise = $client->createNetworkProfileAsync([/* ... */]);
Creates a network profile with the specified details.
Parameter Syntax
$result = $client->createNetworkProfile([
'CertificateAuthorityArn' => '<string>',
'ClientRequestToken' => '<string>', // REQUIRED
'CurrentPassword' => '<string>',
'Description' => '<string>',
'EapMethod' => 'EAP_TLS',
'NetworkProfileName' => '<string>', // REQUIRED
'NextPassword' => '<string>',
'SecurityType' => 'OPEN|WEP|WPA_PSK|WPA2_PSK|WPA2_ENTERPRISE', // REQUIRED
'Ssid' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'TrustAnchors' => ['<string>', ...],
]);
Parameter Details
Members
- CertificateAuthorityArn
-
- Type: string
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
- ClientRequestToken
-
- Required: Yes
- Type: string
A unique, user-specified identifier for the request that ensures idempotency.
- CurrentPassword
-
- Type: string
The current password of the Wi-Fi network.
- Description
-
- Type: string
Detailed information about a device's network profile.
- EapMethod
-
- Type: string
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
- NetworkProfileName
-
- Required: Yes
- Type: string
The name of the network profile associated with a device.
- NextPassword
-
- Type: string
The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
- SecurityType
-
- Required: Yes
- Type: string
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
- Ssid
-
- Required: Yes
- Type: string
The SSID of the Wi-Fi network.
- Tags
-
- Type: Array of Tag structures
The tags to be added to the specified resource. Do not provide system tags.
- TrustAnchors
-
- Type: Array of strings
The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.
Result Syntax
[
'NetworkProfileArn' => '<string>',
]
Result Details
Errors
-
The resource being created already exists.
-
You are performing an action that would put you beyond your account's limits.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
InvalidCertificateAuthorityException:
The Certificate Authority can't issue or revoke a certificate.
-
InvalidServiceLinkedRoleStateException:
The service linked role is locked for deletion.
CreateProfile
$result = $client->createProfile([/* ... */]); $promise = $client->createProfileAsync([/* ... */]);
Creates a new room profile with the specified details.
Parameter Syntax
$result = $client->createProfile([
'Address' => '<string>', // REQUIRED
'ClientRequestToken' => '<string>',
'DataRetentionOptIn' => true || false,
'DistanceUnit' => 'METRIC|IMPERIAL', // REQUIRED
'Locale' => '<string>',
'MaxVolumeLimit' => <integer>,
'MeetingRoomConfiguration' => [
'EndOfMeetingReminder' => [
'Enabled' => true || false, // REQUIRED
'ReminderAtMinutes' => [<integer>, ...], // REQUIRED
'ReminderType' => 'ANNOUNCEMENT_TIME_CHECK|ANNOUNCEMENT_VARIABLE_TIME_LEFT|CHIME|KNOCK', // REQUIRED
],
'InstantBooking' => [
'DurationInMinutes' => <integer>, // REQUIRED
'Enabled' => true || false, // REQUIRED
],
'RequireCheckIn' => [
'Enabled' => true || false, // REQUIRED
'ReleaseAfterMinutes' => <integer>, // REQUIRED
],
'RoomUtilizationMetricsEnabled' => true || false,
],
'PSTNEnabled' => true || false,
'ProfileName' => '<string>', // REQUIRED
'SetupModeDisabled' => true || false,
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'TemperatureUnit' => 'FAHRENHEIT|CELSIUS', // REQUIRED
'Timezone' => '<string>', // REQUIRED
'WakeWord' => 'ALEXA|AMAZON|ECHO|COMPUTER', // REQUIRED
]);
Parameter Details
Members
- Address
-
- Required: Yes
- Type: string
The valid address for the room.
- ClientRequestToken
-
- Type: string
The user-specified token that is used during the creation of a profile.
- DataRetentionOptIn
-
- Type: boolean
Whether data retention of the profile is enabled.
- DistanceUnit
-
- Required: Yes
- Type: string
The distance unit to be used by devices in the profile.
- Locale
-
- Type: string
The locale of the room profile. (This is currently only available to a limited preview audience.)
- MaxVolumeLimit
-
- Type: int
The maximum volume limit for a room profile.
- MeetingRoomConfiguration
-
- Type: CreateMeetingRoomConfiguration structure
The meeting room settings of a room profile.
- PSTNEnabled
-
- Type: boolean
Whether PSTN calling is enabled.
- ProfileName
-
- Required: Yes
- Type: string
The name of a room profile.
- SetupModeDisabled
-
- Type: boolean
Whether room profile setup is enabled.
- Tags
-
- Type: Array of Tag structures
The tags for the profile.
- TemperatureUnit
-
- Required: Yes
- Type: string
The temperature unit to be used by devices in the profile.
- Timezone
-
- Required: Yes
- Type: string
The time zone used by a room profile.
- WakeWord
-
- Required: Yes
- Type: string
A wake word for Alexa, Echo, Amazon, or a computer.
Result Syntax
[
'ProfileArn' => '<string>',
]
Result Details
Errors
-
You are performing an action that would put you beyond your account's limits.
-
The resource being created already exists.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
CreateRoom
$result = $client->createRoom([/* ... */]); $promise = $client->createRoomAsync([/* ... */]);
Creates a room with the specified details.
Parameter Syntax
$result = $client->createRoom([
'ClientRequestToken' => '<string>',
'Description' => '<string>',
'ProfileArn' => '<string>',
'ProviderCalendarId' => '<string>',
'RoomName' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
A unique, user-specified identifier for this request that ensures idempotency.
- Description
-
- Type: string
The description for the room.
- ProfileArn
-
- Type: string
The profile ARN for the room. This is required.
- ProviderCalendarId
-
- Type: string
The calendar ARN for the room.
- RoomName
-
- Required: Yes
- Type: string
The name for the room.
- Tags
-
- Type: Array of Tag structures
The tags for the room.
Result Syntax
[
'RoomArn' => '<string>',
]
Result Details
Errors
-
The resource being created already exists.
-
You are performing an action that would put you beyond your account's limits.
CreateSkillGroup
$result = $client->createSkillGroup([/* ... */]); $promise = $client->createSkillGroupAsync([/* ... */]);
Creates a skill group with a specified name and description.
Parameter Syntax
$result = $client->createSkillGroup([
'ClientRequestToken' => '<string>',
'Description' => '<string>',
'SkillGroupName' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
A unique, user-specified identifier for this request that ensures idempotency.
- Description
-
- Type: string
The description for the skill group.
- SkillGroupName
-
- Required: Yes
- Type: string
The name for the skill group.
- Tags
-
- Type: Array of Tag structures
The tags for the skill group.
Result Syntax
[
'SkillGroupArn' => '<string>',
]
Result Details
Errors
-
The resource being created already exists.
-
You are performing an action that would put you beyond your account's limits.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
CreateUser
$result = $client->createUser([/* ... */]); $promise = $client->createUserAsync([/* ... */]);
Creates a user.
Parameter Syntax
$result = $client->createUser([
'ClientRequestToken' => '<string>',
'Email' => '<string>',
'FirstName' => '<string>',
'LastName' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'UserId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
A unique, user-specified identifier for this request that ensures idempotency.
-
- Type: string
The email address for the user.
- FirstName
-
- Type: string
The first name for the user.
- LastName
-
- Type: string
The last name for the user.
- Tags
-
- Type: Array of Tag structures
The tags for the user.
- UserId
-
- Required: Yes
- Type: string
The ARN for the user.
Result Syntax
[
'UserArn' => '<string>',
]
Result Details
Errors
-
The resource in the request is already in use.
-
You are performing an action that would put you beyond your account's limits.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DeleteAddressBook
$result = $client->deleteAddressBook([/* ... */]); $promise = $client->deleteAddressBookAsync([/* ... */]);
Deletes an address book by the address book ARN.
Parameter Syntax
$result = $client->deleteAddressBook([
'AddressBookArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DeleteBusinessReportSchedule
$result = $client->deleteBusinessReportSchedule([/* ... */]); $promise = $client->deleteBusinessReportScheduleAsync([/* ... */]);
Deletes the recurring report delivery schedule with the specified schedule ARN.
Parameter Syntax
$result = $client->deleteBusinessReportSchedule([
'ScheduleArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DeleteConferenceProvider
$result = $client->deleteConferenceProvider([/* ... */]); $promise = $client->deleteConferenceProviderAsync([/* ... */]);
Deletes a conference provider.
Parameter Syntax
$result = $client->deleteConferenceProvider([
'ConferenceProviderArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
DeleteContact
$result = $client->deleteContact([/* ... */]); $promise = $client->deleteContactAsync([/* ... */]);
Deletes a contact by the contact ARN.
Parameter Syntax
$result = $client->deleteContact([
'ContactArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DeleteDevice
$result = $client->deleteDevice([/* ... */]); $promise = $client->deleteDeviceAsync([/* ... */]);
Removes a device from Alexa For Business.
Parameter Syntax
$result = $client->deleteDevice([
'DeviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
InvalidCertificateAuthorityException:
The Certificate Authority can't issue or revoke a certificate.
DeleteDeviceUsageData
$result = $client->deleteDeviceUsageData([/* ... */]); $promise = $client->deleteDeviceUsageDataAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteDeviceUsageData([
'DeviceArn' => '<string>', // REQUIRED
'DeviceUsageType' => 'VOICE', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
The request failed because this device is no longer registered and therefore no longer managed by this account.
-
You are performing an action that would put you beyond your account's limits.
DeleteGatewayGroup
$result = $client->deleteGatewayGroup([/* ... */]); $promise = $client->deleteGatewayGroupAsync([/* ... */]);
Deletes a gateway group.
Parameter Syntax
$result = $client->deleteGatewayGroup([
'GatewayGroupArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Another resource is associated with the resource in the request.
DeleteNetworkProfile
$result = $client->deleteNetworkProfile([/* ... */]); $promise = $client->deleteNetworkProfileAsync([/* ... */]);
Deletes a network profile by the network profile ARN.
Parameter Syntax
$result = $client->deleteNetworkProfile([
'NetworkProfileArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource in the request is already in use.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The resource is not found.
DeleteProfile
$result = $client->deleteProfile([/* ... */]); $promise = $client->deleteProfileAsync([/* ... */]);
Deletes a room profile by the profile ARN.
Parameter Syntax
$result = $client->deleteProfile([
'ProfileArn' => '<string>',
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DeleteRoom
$result = $client->deleteRoom([/* ... */]); $promise = $client->deleteRoomAsync([/* ... */]);
Deletes a room by the room ARN.
Parameter Syntax
$result = $client->deleteRoom([
'RoomArn' => '<string>',
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DeleteRoomSkillParameter
$result = $client->deleteRoomSkillParameter([/* ... */]); $promise = $client->deleteRoomSkillParameterAsync([/* ... */]);
Deletes room skill parameter details by room, skill, and parameter key ID.
Parameter Syntax
$result = $client->deleteRoomSkillParameter([
'ParameterKey' => '<string>', // REQUIRED
'RoomArn' => '<string>',
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ParameterKey
-
- Required: Yes
- Type: string
The room skill parameter key for which to remove details.
- RoomArn
-
- Type: string
The ARN of the room from which to remove the room skill parameter details.
- SkillId
-
- Required: Yes
- Type: string
The ID of the skill from which to remove the room skill parameter details.
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DeleteSkillAuthorization
$result = $client->deleteSkillAuthorization([/* ... */]); $promise = $client->deleteSkillAuthorizationAsync([/* ... */]);
Unlinks a third-party account from a skill.
Parameter Syntax
$result = $client->deleteSkillAuthorization([
'RoomArn' => '<string>',
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DeleteSkillGroup
$result = $client->deleteSkillGroup([/* ... */]); $promise = $client->deleteSkillGroupAsync([/* ... */]);
Deletes a skill group by skill group ARN.
Parameter Syntax
$result = $client->deleteSkillGroup([
'SkillGroupArn' => '<string>',
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DeleteUser
$result = $client->deleteUser([/* ... */]); $promise = $client->deleteUserAsync([/* ... */]);
Deletes a specified user by user ARN and enrollment ARN.
Parameter Syntax
$result = $client->deleteUser([
'EnrollmentId' => '<string>', // REQUIRED
'UserArn' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
DisassociateContactFromAddressBook
$result = $client->disassociateContactFromAddressBook([/* ... */]); $promise = $client->disassociateContactFromAddressBookAsync([/* ... */]);
Disassociates a contact from a given address book.
Parameter Syntax
$result = $client->disassociateContactFromAddressBook([
'AddressBookArn' => '<string>', // REQUIRED
'ContactArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DisassociateDeviceFromRoom
$result = $client->disassociateDeviceFromRoom([/* ... */]); $promise = $client->disassociateDeviceFromRoomAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateDeviceFromRoom([
'DeviceArn' => '<string>',
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The request failed because this device is no longer registered and therefore no longer managed by this account.
DisassociateSkillFromSkillGroup
$result = $client->disassociateSkillFromSkillGroup([/* ... */]); $promise = $client->disassociateSkillFromSkillGroupAsync([/* ... */]);
Disassociates a skill from a skill group.
Parameter Syntax
$result = $client->disassociateSkillFromSkillGroup([
'SkillGroupArn' => '<string>',
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The resource is not found.
DisassociateSkillFromUsers
$result = $client->disassociateSkillFromUsers([/* ... */]); $promise = $client->disassociateSkillFromUsersAsync([/* ... */]);
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
Parameter Syntax
$result = $client->disassociateSkillFromUsers([
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The resource is not found.
DisassociateSkillGroupFromRoom
$result = $client->disassociateSkillGroupFromRoom([/* ... */]); $promise = $client->disassociateSkillGroupFromRoomAsync([/* ... */]);
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
Parameter Syntax
$result = $client->disassociateSkillGroupFromRoom([
'RoomArn' => '<string>',
'SkillGroupArn' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
ForgetSmartHomeAppliances
$result = $client->forgetSmartHomeAppliances([/* ... */]); $promise = $client->forgetSmartHomeAppliancesAsync([/* ... */]);
Forgets smart home appliances associated to a room.
Parameter Syntax
$result = $client->forgetSmartHomeAppliances([
'RoomArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
GetAddressBook
$result = $client->getAddressBook([/* ... */]); $promise = $client->getAddressBookAsync([/* ... */]);
Gets address the book details by the address book ARN.
Parameter Syntax
$result = $client->getAddressBook([
'AddressBookArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AddressBook' => [
'AddressBookArn' => '<string>',
'Description' => '<string>',
'Name' => '<string>',
],
]
Result Details
Members
- AddressBook
-
- Type: AddressBook structure
The details of the requested address book.
Errors
-
The resource is not found.
GetConferencePreference
$result = $client->getConferencePreference([/* ... */]); $promise = $client->getConferencePreferenceAsync([/* ... */]);
Retrieves the existing conference preferences.
Parameter Syntax
$result = $client->getConferencePreference([ ]);
Parameter Details
Members
Result Syntax
[
'Preference' => [
'DefaultConferenceProviderArn' => '<string>',
],
]
Result Details
Members
- Preference
-
- Type: ConferencePreference structure
The conference preference.
Errors
-
The resource is not found.
GetConferenceProvider
$result = $client->getConferenceProvider([/* ... */]); $promise = $client->getConferenceProviderAsync([/* ... */]);
Gets details about a specific conference provider.
Parameter Syntax
$result = $client->getConferenceProvider([
'ConferenceProviderArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ConferenceProvider' => [
'Arn' => '<string>',
'IPDialIn' => [
'CommsProtocol' => 'SIP|SIPS|H323',
'Endpoint' => '<string>',
],
'MeetingSetting' => [
'RequirePin' => 'YES|NO|OPTIONAL',
],
'Name' => '<string>',
'PSTNDialIn' => [
'CountryCode' => '<string>',
'OneClickIdDelay' => '<string>',
'OneClickPinDelay' => '<string>',
'PhoneNumber' => '<string>',
],
'Type' => 'CHIME|BLUEJEANS|FUZE|GOOGLE_HANGOUTS|POLYCOM|RINGCENTRAL|SKYPE_FOR_BUSINESS|WEBEX|ZOOM|CUSTOM',
],
]
Result Details
Members
- ConferenceProvider
-
- Type: ConferenceProvider structure
The conference provider.
Errors
-
The resource is not found.
GetContact
$result = $client->getContact([/* ... */]); $promise = $client->getContactAsync([/* ... */]);
Gets the contact details by the contact ARN.
Parameter Syntax
$result = $client->getContact([
'ContactArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Contact' => [
'ContactArn' => '<string>',
'DisplayName' => '<string>',
'FirstName' => '<string>',
'LastName' => '<string>',
'PhoneNumber' => '<string>',
'PhoneNumbers' => [
[
'Number' => '<string>',
'Type' => 'MOBILE|WORK|HOME',
],
// ...
],
'SipAddresses' => [
[
'Type' => 'WORK',
'Uri' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Contact
-
- Type: Contact structure
The details of the requested contact.
Errors
-
The resource is not found.
GetDevice
$result = $client->getDevice([/* ... */]); $promise = $client->getDeviceAsync([/* ... */]);
Gets the details of a device by device ARN.
Parameter Syntax
$result = $client->getDevice([
'DeviceArn' => '<string>',
]);
Parameter Details
Result Syntax
[
'Device' => [
'DeviceArn' => '<string>',
'DeviceName' => '<string>',
'DeviceSerialNumber' => '<string>',
'DeviceStatus' => 'READY|PENDING|WAS_OFFLINE|DEREGISTERED|FAILED',
'DeviceStatusInfo' => [
'ConnectionStatus' => 'ONLINE|OFFLINE',
'ConnectionStatusUpdatedTime' => <DateTime>,
'DeviceStatusDetails' => [
[
'Code' => 'DEVICE_SOFTWARE_UPDATE_NEEDED|DEVICE_WAS_OFFLINE|CREDENTIALS_ACCESS_FAILURE|TLS_VERSION_MISMATCH|ASSOCIATION_REJECTION|AUTHENTICATION_FAILURE|DHCP_FAILURE|INTERNET_UNAVAILABLE|DNS_FAILURE|UNKNOWN_FAILURE|CERTIFICATE_ISSUING_LIMIT_EXCEEDED|INVALID_CERTIFICATE_AUTHORITY|NETWORK_PROFILE_NOT_FOUND|INVALID_PASSWORD_STATE|PASSWORD_NOT_FOUND|PASSWORD_MANAGER_ACCESS_DENIED|CERTIFICATE_AUTHORITY_ACCESS_DENIED',
'Feature' => 'BLUETOOTH|VOLUME|NOTIFICATIONS|LISTS|SKILLS|NETWORK_PROFILE|SETTINGS|ALL',
],
// ...
],
],
'DeviceType' => '<string>',
'MacAddress' => '<string>',
'NetworkProfileInfo' => [
'CertificateArn' => '<string>',
'CertificateExpirationTime' => <DateTime>,
'NetworkProfileArn' => '<string>',
],
'RoomArn' => '<string>',
'SoftwareVersion' => '<string>',
],
]
Result Details
Members
- Device
-
- Type: Device structure
The details of the device requested. Required.
Errors
-
The resource is not found.
GetGateway
$result = $client->getGateway([/* ... */]); $promise = $client->getGatewayAsync([/* ... */]);
Retrieves the details of a gateway.
Parameter Syntax
$result = $client->getGateway([
'GatewayArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Gateway' => [
'Arn' => '<string>',
'Description' => '<string>',
'GatewayGroupArn' => '<string>',
'Name' => '<string>',
'SoftwareVersion' => '<string>',
],
]
Result Details
Members
- Gateway
-
- Type: Gateway structure
The details of the gateway.
Errors
-
The resource is not found.
GetGatewayGroup
$result = $client->getGatewayGroup([/* ... */]); $promise = $client->getGatewayGroupAsync([/* ... */]);
Retrieves the details of a gateway group.
Parameter Syntax
$result = $client->getGatewayGroup([
'GatewayGroupArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'GatewayGroup' => [
'Arn' => '<string>',
'Description' => '<string>',
'Name' => '<string>',
],
]
Result Details
Members
- GatewayGroup
-
- Type: GatewayGroup structure
The details of the gateway group.
Errors
-
The resource is not found.
GetInvitationConfiguration
$result = $client->getInvitationConfiguration([/* ... */]); $promise = $client->getInvitationConfigurationAsync([/* ... */]);
Retrieves the configured values for the user enrollment invitation email template.
Parameter Syntax
$result = $client->getInvitationConfiguration([ ]);
Parameter Details
Members
Result Syntax
[
'ContactEmail' => '<string>',
'OrganizationName' => '<string>',
'PrivateSkillIds' => ['<string>', ...],
]
Result Details
Members
- ContactEmail
-
- Type: string
The email ID of the organization or individual contact that the enrolled user can use.
- OrganizationName
-
- Type: string
The name of the organization sending the enrollment invite to a user.
- PrivateSkillIds
-
- Type: Array of strings
The list of private skill IDs that you want to recommend to the user to enable in the invitation.
Errors
-
The resource is not found.
GetNetworkProfile
$result = $client->getNetworkProfile([/* ... */]); $promise = $client->getNetworkProfileAsync([/* ... */]);
Gets the network profile details by the network profile ARN.
Parameter Syntax
$result = $client->getNetworkProfile([
'NetworkProfileArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'NetworkProfile' => [
'CertificateAuthorityArn' => '<string>',
'CurrentPassword' => '<string>',
'Description' => '<string>',
'EapMethod' => 'EAP_TLS',
'NetworkProfileArn' => '<string>',
'NetworkProfileName' => '<string>',
'NextPassword' => '<string>',
'SecurityType' => 'OPEN|WEP|WPA_PSK|WPA2_PSK|WPA2_ENTERPRISE',
'Ssid' => '<string>',
'TrustAnchors' => ['<string>', ...],
],
]
Result Details
Members
- NetworkProfile
-
- Type: NetworkProfile structure
The network profile associated with a device.
Errors
-
The resource is not found.
-
InvalidSecretsManagerResourceException:
A password in SecretsManager is in an invalid state.
GetProfile
$result = $client->getProfile([/* ... */]); $promise = $client->getProfileAsync([/* ... */]);
Gets the details of a room profile by profile ARN.
Parameter Syntax
$result = $client->getProfile([
'ProfileArn' => '<string>',
]);
Parameter Details
Result Syntax
[
'Profile' => [
'Address' => '<string>',
'AddressBookArn' => '<string>',
'DataRetentionOptIn' => true || false,
'DistanceUnit' => 'METRIC|IMPERIAL',
'IsDefault' => true || false,
'Locale' => '<string>',
'MaxVolumeLimit' => <integer>,
'MeetingRoomConfiguration' => [
'EndOfMeetingReminder' => [
'Enabled' => true || false,
'ReminderAtMinutes' => [<integer>, ...],
'ReminderType' => 'ANNOUNCEMENT_TIME_CHECK|ANNOUNCEMENT_VARIABLE_TIME_LEFT|CHIME|KNOCK',
],
'InstantBooking' => [
'DurationInMinutes' => <integer>,
'Enabled' => true || false,
],
'RequireCheckIn' => [
'Enabled' => true || false,
'ReleaseAfterMinutes' => <integer>,
],
'RoomUtilizationMetricsEnabled' => true || false,
],
'PSTNEnabled' => true || false,
'ProfileArn' => '<string>',
'ProfileName' => '<string>',
'SetupModeDisabled' => true || false,
'TemperatureUnit' => 'FAHRENHEIT|CELSIUS',
'Timezone' => '<string>',
'WakeWord' => 'ALEXA|AMAZON|ECHO|COMPUTER',
],
]
Result Details
Members
- Profile
-
- Type: Profile structure
The details of the room profile requested. Required.
Errors
-
The resource is not found.
GetRoom
$result = $client->getRoom([/* ... */]); $promise = $client->getRoomAsync([/* ... */]);
Gets room details by room ARN.
Parameter Syntax
$result = $client->getRoom([
'RoomArn' => '<string>',
]);
Parameter Details
Result Syntax
[
'Room' => [
'Description' => '<string>',
'ProfileArn' => '<string>',
'ProviderCalendarId' => '<string>',
'RoomArn' => '<string>',
'RoomName' => '<string>',
],
]
Result Details
Members
- Room
-
- Type: Room structure
The details of the room requested.
Errors
-
The resource is not found.
GetRoomSkillParameter
$result = $client->getRoomSkillParameter([/* ... */]); $promise = $client->getRoomSkillParameterAsync([/* ... */]);
Gets room skill parameter details by room, skill, and parameter key ARN.
Parameter Syntax
$result = $client->getRoomSkillParameter([
'ParameterKey' => '<string>', // REQUIRED
'RoomArn' => '<string>',
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ParameterKey
-
- Required: Yes
- Type: string
The room skill parameter key for which to get details. Required.
- RoomArn
-
- Type: string
The ARN of the room from which to get the room skill parameter details.
- SkillId
-
- Required: Yes
- Type: string
The ARN of the skill from which to get the room skill parameter details. Required.
Result Syntax
[
'RoomSkillParameter' => [
'ParameterKey' => '<string>',
'ParameterValue' => '<string>',
],
]
Result Details
Members
- RoomSkillParameter
-
- Type: RoomSkillParameter structure
The details of the room skill parameter requested. Required.
Errors
-
The resource is not found.
GetSkillGroup
$result = $client->getSkillGroup([/* ... */]); $promise = $client->getSkillGroupAsync([/* ... */]);
Gets skill group details by skill group ARN.
Parameter Syntax
$result = $client->getSkillGroup([
'SkillGroupArn' => '<string>',
]);
Parameter Details
Result Syntax
[
'SkillGroup' => [
'Description' => '<string>',
'SkillGroupArn' => '<string>',
'SkillGroupName' => '<string>',
],
]
Result Details
Members
- SkillGroup
-
- Type: SkillGroup structure
The details of the skill group requested. Required.
Errors
-
The resource is not found.
ListBusinessReportSchedules
$result = $client->listBusinessReportSchedules([/* ... */]); $promise = $client->listBusinessReportSchedulesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listBusinessReportSchedules([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'BusinessReportSchedules' => [
[
'ContentRange' => [
'Interval' => 'ONE_DAY|ONE_WEEK|THIRTY_DAYS',
],
'Format' => 'CSV|CSV_ZIP',
'LastBusinessReport' => [
'DeliveryTime' => <DateTime>,
'DownloadUrl' => '<string>',
'FailureCode' => 'ACCESS_DENIED|NO_SUCH_BUCKET|INTERNAL_FAILURE',
'S3Location' => [
'BucketName' => '<string>',
'Path' => '<string>',
],
'Status' => 'RUNNING|SUCCEEDED|FAILED',
],
'Recurrence' => [
'StartDate' => '<string>',
],
'S3BucketName' => '<string>',
'S3KeyPrefix' => '<string>',
'ScheduleArn' => '<string>',
'ScheduleName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- BusinessReportSchedules
-
- Type: Array of BusinessReportSchedule structures
The schedule of the reports.
- NextToken
-
- Type: string
The token used to list the remaining schedules from the previous API call.
Errors
There are no errors described for this operation.
ListConferenceProviders
$result = $client->listConferenceProviders([/* ... */]); $promise = $client->listConferenceProvidersAsync([/* ... */]);
Lists conference providers under a specific AWS account.
Parameter Syntax
$result = $client->listConferenceProviders([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ConferenceProviders' => [
[
'Arn' => '<string>',
'IPDialIn' => [
'CommsProtocol' => 'SIP|SIPS|H323',
'Endpoint' => '<string>',
],
'MeetingSetting' => [
'RequirePin' => 'YES|NO|OPTIONAL',
],
'Name' => '<string>',
'PSTNDialIn' => [
'CountryCode' => '<string>',
'OneClickIdDelay' => '<string>',
'OneClickPinDelay' => '<string>',
'PhoneNumber' => '<string>',
],
'Type' => 'CHIME|BLUEJEANS|FUZE|GOOGLE_HANGOUTS|POLYCOM|RINGCENTRAL|SKYPE_FOR_BUSINESS|WEBEX|ZOOM|CUSTOM',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ConferenceProviders
-
- Type: Array of ConferenceProvider structures
The conference providers.
- NextToken
-
- Type: string
The tokens used for pagination.
Errors
There are no errors described for this operation.
ListDeviceEvents
$result = $client->listDeviceEvents([/* ... */]); $promise = $client->listDeviceEventsAsync([/* ... */]);
Lists the device event history, including device connection status, for up to 30 days.
Parameter Syntax
$result = $client->listDeviceEvents([
'DeviceArn' => '<string>', // REQUIRED
'EventType' => 'CONNECTION_STATUS|DEVICE_STATUS',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- DeviceArn
-
- Required: Yes
- Type: string
The ARN of a device.
- EventType
-
- Type: string
The event type to filter device events. If EventType isn't specified, 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.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.
Result Syntax
[
'DeviceEvents' => [
[
'Timestamp' => <DateTime>,
'Type' => 'CONNECTION_STATUS|DEVICE_STATUS',
'Value' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- DeviceEvents
-
- Type: Array of DeviceEvent structures
The device events requested for the device ARN.
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
Errors
-
The resource is not found.
ListGatewayGroups
$result = $client->listGatewayGroups([/* ... */]); $promise = $client->listGatewayGroupsAsync([/* ... */]);
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
Parameter Syntax
$result = $client->listGatewayGroups([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'GatewayGroups' => [
[
'Arn' => '<string>',
'Description' => '<string>',
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- GatewayGroups
-
- Type: Array of GatewayGroupSummary structures
The gateway groups in the list.
- NextToken
-
- Type: string
The token used to paginate though multiple pages of gateway group summaries.
Errors
There are no errors described for this operation.
ListGateways
$result = $client->listGateways([/* ... */]); $promise = $client->listGatewaysAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listGateways([
'GatewayGroupArn' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Gateways' => [
[
'Arn' => '<string>',
'Description' => '<string>',
'GatewayGroupArn' => '<string>',
'Name' => '<string>',
'SoftwareVersion' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Gateways
-
- Type: Array of GatewaySummary structures
The gateways in the list.
- NextToken
-
- Type: string
The token used to paginate though multiple pages of gateway summaries.
Errors
There are no errors described for this operation.
ListSkills
$result = $client->listSkills([/* ... */]); $promise = $client->listSkillsAsync([/* ... */]);
Lists all enabled skills in a specific skill group.
Parameter Syntax
$result = $client->listSkills([
'EnablementType' => 'ENABLED|PENDING',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SkillGroupArn' => '<string>',
'SkillType' => 'PUBLIC|PRIVATE|ALL',
]);
Parameter Details
Members
- EnablementType
-
- Type: string
Whether the skill is enabled under the user's account.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified
MaxResultsvalue, a token is included in the response so that the remaining results can be retrieved. - NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by
MaxResults. - SkillGroupArn
-
- Type: string
The ARN of the skill group for which to list enabled skills.
- SkillType
-
- Type: string
Whether the skill is publicly available or is a private skill.
Result Syntax
[
'NextToken' => '<string>',
'SkillSummaries' => [
[
'EnablementType' => 'ENABLED|PENDING',
'SkillId' => '<string>',
'SkillName' => '<string>',
'SkillType' => 'PUBLIC|PRIVATE',
'SupportsLinking' => true || false,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
- SkillSummaries
-
- Type: Array of SkillSummary structures
The list of enabled skills requested. Required.
Errors
There are no errors described for this operation.
ListSkillsStoreCategories
$result = $client->listSkillsStoreCategories([/* ... */]); $promise = $client->listSkillsStoreCategoriesAsync([/* ... */]);
Lists all categories in the Alexa skill store.
Parameter Syntax
$result = $client->listSkillsStoreCategories([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'CategoryList' => [
[
'CategoryId' => <integer>,
'CategoryName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- CategoryList
-
- Type: Array of Category structures
The list of categories.
- NextToken
-
- Type: string
The tokens used for pagination.
Errors
There are no errors described for this operation.
ListSkillsStoreSkillsByCategory
$result = $client->listSkillsStoreSkillsByCategory([/* ... */]); $promise = $client->listSkillsStoreSkillsByCategoryAsync([/* ... */]);
Lists all skills in the Alexa skill store by category.
Parameter Syntax
$result = $client->listSkillsStoreSkillsByCategory([
'CategoryId' => <integer>, // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'SkillsStoreSkills' => [
[
'IconUrl' => '<string>',
'SampleUtterances' => ['<string>', ...],
'ShortDescription' => '<string>',
'SkillDetails' => [
'BulletPoints' => ['<string>', ...],
'DeveloperInfo' => [
'DeveloperName' => '<string>',
'Email' => '<string>',
'PrivacyPolicy' => '<string>',
'Url' => '<string>',
],
'EndUserLicenseAgreement' => '<string>',
'GenericKeywords' => ['<string>', ...],
'InvocationPhrase' => '<string>',
'NewInThisVersionBulletPoints' => ['<string>', ...],
'ProductDescription' => '<string>',
'ReleaseDate' => '<string>',
'Reviews' => ['<string>', ...],
'SkillTypes' => ['<string>', ...],
],
'SkillId' => '<string>',
'SkillName' => '<string>',
'SupportsLinking' => true || false,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The tokens used for pagination.
- SkillsStoreSkills
-
- Type: Array of SkillsStoreSkill structures
The skill store skills.
Errors
There are no errors described for this operation.
ListSmartHomeAppliances
$result = $client->listSmartHomeAppliances([/* ... */]); $promise = $client->listSmartHomeAppliancesAsync([/* ... */]);
Lists all of the smart home appliances associated with a room.
Parameter Syntax
$result = $client->listSmartHomeAppliances([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'RoomArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'SmartHomeAppliances' => [
[
'Description' => '<string>',
'FriendlyName' => '<string>',
'ManufacturerName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The tokens used for pagination.
- SmartHomeAppliances
-
- Type: Array of SmartHomeAppliance structures
The smart home appliances.
Errors
-
The resource is not found.
ListTags
$result = $client->listTags([/* ... */]); $promise = $client->listTagsAsync([/* ... */]);
Lists all tags for the specified resource.
Parameter Syntax
$result = $client->listTags([
'Arn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the specified resource for which to list tags.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified
MaxResultsvalue, a token is included in the response so that the remaining results can be retrieved. - NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by
MaxResults.
Result Syntax
[
'NextToken' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
- Tags
-
- Type: Array of Tag structures
The tags requested for the specified resource.
Errors
-
The resource is not found.
PutConferencePreference
$result = $client->putConferencePreference([/* ... */]); $promise = $client->putConferencePreferenceAsync([/* ... */]);
Sets the conference preferences on a specific conference provider at the account level.
Parameter Syntax
$result = $client->putConferencePreference([
'ConferencePreference' => [ // REQUIRED
'DefaultConferenceProviderArn' => '<string>',
],
]);
Parameter Details
Members
- ConferencePreference
-
- Required: Yes
- Type: ConferencePreference structure
The conference preference of a specific conference provider.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
PutInvitationConfiguration
$result = $client->putInvitationConfiguration([/* ... */]); $promise = $client->putInvitationConfigurationAsync([/* ... */]);
Configures the email template for the user enrollment invitation with the specified attributes.
Parameter Syntax
$result = $client->putInvitationConfiguration([
'ContactEmail' => '<string>',
'OrganizationName' => '<string>', // REQUIRED
'PrivateSkillIds' => ['<string>', ...],
]);
Parameter Details
Members
- ContactEmail
-
- Type: string
The email ID of the organization or individual contact that the enrolled user can use.
- OrganizationName
-
- Required: Yes
- Type: string
The name of the organization sending the enrollment invite to a user.
- PrivateSkillIds
-
- Type: Array of strings
The list of private skill IDs that you want to recommend to the user to enable in the invitation.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
PutRoomSkillParameter
$result = $client->putRoomSkillParameter([/* ... */]); $promise = $client->putRoomSkillParameterAsync([/* ... */]);
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
Parameter Syntax
$result = $client->putRoomSkillParameter([
'RoomArn' => '<string>',
'RoomSkillParameter' => [ // REQUIRED
'ParameterKey' => '<string>', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- RoomArn
-
- Type: string
The ARN of the room associated with the room skill parameter. Required.
- RoomSkillParameter
-
- Required: Yes
- Type: RoomSkillParameter structure
The updated room skill parameter. Required.
- SkillId
-
- Required: Yes
- Type: string
The ARN of the skill associated with the room skill parameter. Required.
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
PutSkillAuthorization
$result = $client->putSkillAuthorization([/* ... */]); $promise = $client->putSkillAuthorizationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->putSkillAuthorization([
'AuthorizationResult' => ['<string>', ...], // REQUIRED
'RoomArn' => '<string>',
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AuthorizationResult
-
- Required: Yes
- Type: Associative array of custom strings keys (Key) to strings
The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.
- RoomArn
-
- Type: string
The room that the skill is authorized for.
- SkillId
-
- Required: Yes
- Type: string
The unique identifier of a skill.
Result Syntax
[]
Result Details
Errors
-
The caller has no permissions to operate on the resource involved in the API call.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
RegisterAVSDevice
$result = $client->registerAVSDevice([/* ... */]); $promise = $client->registerAVSDeviceAsync([/* ... */]);
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
Parameter Syntax
$result = $client->registerAVSDevice([
'AmazonId' => '<string>', // REQUIRED
'ClientId' => '<string>', // REQUIRED
'DeviceSerialNumber' => '<string>',
'ProductId' => '<string>', // REQUIRED
'RoomArn' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'UserCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AmazonId
-
- Required: Yes
- Type: string
The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
- ClientId
-
- Required: Yes
- Type: string
The client ID of the OEM used for code-based linking authorization on an AVS device.
- DeviceSerialNumber
-
- Type: string
The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
- ProductId
-
- Required: Yes
- Type: string
The product ID used to identify your AVS device during authorization.
- RoomArn
-
- Type: string
The Amazon Resource Name (ARN) of the room with which to associate your AVS device.
- Tags
-
- Type: Array of Tag structures
The tags to be added to the specified resource. Do not provide system tags.
- UserCode
-
- Required: Yes
- Type: string
The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.
Result Syntax
[
'DeviceArn' => '<string>',
]
Result Details
Errors
-
You are performing an action that would put you beyond your account's limits.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The resource is not found.
-
The device is in an invalid state.
RejectSkill
$result = $client->rejectSkill([/* ... */]); $promise = $client->rejectSkillAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->rejectSkill([
'SkillId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The resource is not found.
ResolveRoom
$result = $client->resolveRoom([/* ... */]); $promise = $client->resolveRoomAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->resolveRoom([
'SkillId' => '<string>', // REQUIRED
'UserId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RoomArn' => '<string>',
'RoomName' => '<string>',
'RoomSkillParameters' => [
[
'ParameterKey' => '<string>',
'ParameterValue' => '<string>',
],
// ...
],
]
Result Details
Members
- RoomArn
-
- Type: string
The ARN of the room from which the skill request was invoked.
- RoomName
-
- Type: string
The name of the room from which the skill request was invoked.
- RoomSkillParameters
-
- Type: Array of RoomSkillParameter structures
Response to get the room profile request. Required.
Errors
-
The resource is not found.
RevokeInvitation
$result = $client->revokeInvitation([/* ... */]); $promise = $client->revokeInvitationAsync([/* ... */]);
Revokes an invitation and invalidates the enrollment URL.
Parameter Syntax
$result = $client->revokeInvitation([
'EnrollmentId' => '<string>',
'UserArn' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
SearchAddressBooks
$result = $client->searchAddressBooks([/* ... */]); $promise = $client->searchAddressBooksAsync([/* ... */]);
Searches address books and lists the ones that meet a set of filter and sort criteria.
Parameter Syntax
$result = $client->searchAddressBooks([
'Filters' => [
[
'Key' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SortCriteria' => [
[
'Key' => '<string>', // REQUIRED
'Value' => 'ASC|DESC', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
- SortCriteria
-
- Type: Array of Sort structures
The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
Result Syntax
[
'AddressBooks' => [
[
'AddressBookArn' => '<string>',
'Description' => '<string>',
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'TotalCount' => <integer>,
]
Result Details
Members
- AddressBooks
-
- Type: Array of AddressBookData structures
The address books that meet the specified set of filter criteria, in sort order.
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
- TotalCount
-
- Type: int
The total number of address books returned.
Errors
There are no errors described for this operation.
SearchContacts
$result = $client->searchContacts([/* ... */]); $promise = $client->searchContactsAsync([/* ... */]);
Searches contacts and lists the ones that meet a set of filter and sort criteria.
Parameter Syntax
$result = $client->searchContacts([
'Filters' => [
[
'Key' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SortCriteria' => [
[
'Key' => '<string>', // REQUIRED
'Value' => 'ASC|DESC', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
- SortCriteria
-
- Type: Array of Sort structures
The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
Result Syntax
[
'Contacts' => [
[
'ContactArn' => '<string>',
'DisplayName' => '<string>',
'FirstName' => '<string>',
'LastName' => '<string>',
'PhoneNumber' => '<string>',
'PhoneNumbers' => [
[
'Number' => '<string>',
'Type' => 'MOBILE|WORK|HOME',
],
// ...
],
'SipAddresses' => [
[
'Type' => 'WORK',
'Uri' => '<string>',
],
// ...
],
],
// ...
],
'NextToken' => '<string>',
'TotalCount' => <integer>,
]
Result Details
Members
- Contacts
-
- Type: Array of ContactData structures
The contacts that meet the specified set of filter criteria, in sort order.
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
- TotalCount
-
- Type: int
The total number of contacts returned.
Errors
There are no errors described for this operation.
SearchDevices
$result = $client->searchDevices([/* ... */]); $promise = $client->searchDevicesAsync([/* ... */]);
Searches devices and lists the ones that meet a set of filter criteria.
Parameter Syntax
$result = $client->searchDevices([
'Filters' => [
[
'Key' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SortCriteria' => [
[
'Key' => '<string>', // REQUIRED
'Value' => 'ASC|DESC', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified
MaxResultsvalue, a token is included in the response so that the remaining results can be retrieved. - NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by
MaxResults. - SortCriteria
-
- Type: Array of Sort structures
The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
Result Syntax
[
'Devices' => [
[
'CreatedTime' => <DateTime>,
'DeviceArn' => '<string>',
'DeviceName' => '<string>',
'DeviceSerialNumber' => '<string>',
'DeviceStatus' => 'READY|PENDING|WAS_OFFLINE|DEREGISTERED|FAILED',
'DeviceStatusInfo' => [
'ConnectionStatus' => 'ONLINE|OFFLINE',
'ConnectionStatusUpdatedTime' => <DateTime>,
'DeviceStatusDetails' => [
[
'Code' => 'DEVICE_SOFTWARE_UPDATE_NEEDED|DEVICE_WAS_OFFLINE|CREDENTIALS_ACCESS_FAILURE|TLS_VERSION_MISMATCH|ASSOCIATION_REJECTION|AUTHENTICATION_FAILURE|DHCP_FAILURE|INTERNET_UNAVAILABLE|DNS_FAILURE|UNKNOWN_FAILURE|CERTIFICATE_ISSUING_LIMIT_EXCEEDED|INVALID_CERTIFICATE_AUTHORITY|NETWORK_PROFILE_NOT_FOUND|INVALID_PASSWORD_STATE|PASSWORD_NOT_FOUND|PASSWORD_MANAGER_ACCESS_DENIED|CERTIFICATE_AUTHORITY_ACCESS_DENIED',
'Feature' => 'BLUETOOTH|VOLUME|NOTIFICATIONS|LISTS|SKILLS|NETWORK_PROFILE|SETTINGS|ALL',
],
// ...
],
],
'DeviceType' => '<string>',
'MacAddress' => '<string>',
'NetworkProfileArn' => '<string>',
'NetworkProfileName' => '<string>',
'RoomArn' => '<string>',
'RoomName' => '<string>',
'SoftwareVersion' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'TotalCount' => <integer>,
]
Result Details
Members
- Devices
-
- Type: Array of DeviceData structures
The devices that meet the specified set of filter criteria, in sort order.
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
- TotalCount
-
- Type: int
The total number of devices returned.
Errors
There are no errors described for this operation.
SearchNetworkProfiles
$result = $client->searchNetworkProfiles([/* ... */]); $promise = $client->searchNetworkProfilesAsync([/* ... */]);
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
Parameter Syntax
$result = $client->searchNetworkProfiles([
'Filters' => [
[
'Key' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SortCriteria' => [
[
'Key' => '<string>', // REQUIRED
'Value' => 'ASC|DESC', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
- SortCriteria
-
- Type: Array of Sort structures
The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.
Result Syntax
[
'NetworkProfiles' => [
[
'CertificateAuthorityArn' => '<string>',
'Description' => '<string>',
'EapMethod' => 'EAP_TLS',
'NetworkProfileArn' => '<string>',
'NetworkProfileName' => '<string>',
'SecurityType' => 'OPEN|WEP|WPA_PSK|WPA2_PSK|WPA2_ENTERPRISE',
'Ssid' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'TotalCount' => <integer>,
]
Result Details
Members
- NetworkProfiles
-
- Type: Array of NetworkProfileData structures
The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.
- NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
- TotalCount
-
- Type: int
The total number of network profiles returned.
Errors
There are no errors described for this operation.
SearchProfiles
$result = $client->searchProfiles([/* ... */]); $promise = $client->searchProfilesAsync([/* ... */]);
Searches room profiles and lists the ones that meet a set of filter criteria.
Parameter Syntax
$result = $client->searchProfiles([
'Filters' => [
[
'Key' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SortCriteria' => [
[
'Key' => '<string>', // REQUIRED
'Value' => 'ASC|DESC', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified
MaxResultsvalue, a token is included in the response so that the remaining results can be retrieved. - NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by
MaxResults. - SortCriteria
-
- Type: Array of Sort structures
The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
Result Syntax
[
'NextToken' => '<string>',
'Profiles' => [
[
'Address' => '<string>',
'DistanceUnit' => 'METRIC|IMPERIAL',
'IsDefault' => true || false,
'Locale' => '<string>',
'ProfileArn' => '<string>',
'ProfileName' => '<string>',
'TemperatureUnit' => 'FAHRENHEIT|CELSIUS',
'Timezone' => '<string>',
'WakeWord' => 'ALEXA|AMAZON|ECHO|COMPUTER',
],
// ...
],
'TotalCount' => <integer>,
]
Result Details
Members
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
- Profiles
-
- Type: Array of ProfileData structures
The profiles that meet the specified set of filter criteria, in sort order.
- TotalCount
-
- Type: int
The total number of room profiles returned.
Errors
There are no errors described for this operation.
SearchRooms
$result = $client->searchRooms([/* ... */]); $promise = $client->searchRoomsAsync([/* ... */]);
Searches rooms and lists the ones that meet a set of filter and sort criteria.
Parameter Syntax
$result = $client->searchRooms([
'Filters' => [
[
'Key' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SortCriteria' => [
[
'Key' => '<string>', // REQUIRED
'Value' => 'ASC|DESC', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified
MaxResultsvalue, a token is included in the response so that the remaining results can be retrieved. - NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by
MaxResults. - SortCriteria
-
- Type: Array of Sort structures
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
Result Syntax
[
'NextToken' => '<string>',
'Rooms' => [
[
'Description' => '<string>',
'ProfileArn' => '<string>',
'ProfileName' => '<string>',
'ProviderCalendarId' => '<string>',
'RoomArn' => '<string>',
'RoomName' => '<string>',
],
// ...
],
'TotalCount' => <integer>,
]
Result Details
Members
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
- Rooms
-
- Type: Array of RoomData structures
The rooms that meet the specified set of filter criteria, in sort order.
- TotalCount
-
- Type: int
The total number of rooms returned.
Errors
There are no errors described for this operation.
SearchSkillGroups
$result = $client->searchSkillGroups([/* ... */]); $promise = $client->searchSkillGroupsAsync([/* ... */]);
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
Parameter Syntax
$result = $client->searchSkillGroups([
'Filters' => [
[
'Key' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SortCriteria' => [
[
'Key' => '<string>', // REQUIRED
'Value' => 'ASC|DESC', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified
MaxResultsvalue, a token is included in the response so that the remaining results can be retrieved. - NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by
MaxResults. Required. - SortCriteria
-
- Type: Array of Sort structures
The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
Result Syntax
[
'NextToken' => '<string>',
'SkillGroups' => [
[
'Description' => '<string>',
'SkillGroupArn' => '<string>',
'SkillGroupName' => '<string>',
],
// ...
],
'TotalCount' => <integer>,
]
Result Details
Members
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
- SkillGroups
-
- Type: Array of SkillGroupData structures
The skill groups that meet the filter criteria, in sort order.
- TotalCount
-
- Type: int
The total number of skill groups returned.
Errors
There are no errors described for this operation.
SearchUsers
$result = $client->searchUsers([/* ... */]); $promise = $client->searchUsersAsync([/* ... */]);
Searches users and lists the ones that meet a set of filter and sort criteria.
Parameter Syntax
$result = $client->searchUsers([
'Filters' => [
[
'Key' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SortCriteria' => [
[
'Key' => '<string>', // REQUIRED
'Value' => 'ASC|DESC', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
- MaxResults
-
- Type: int
The maximum number of results to include in the response. If more results exist than the specified
MaxResultsvalue, a token is included in the response so that the remaining results can be retrieved. Required. - NextToken
-
- Type: string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by
MaxResults. Required. - SortCriteria
-
- Type: Array of Sort structures
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
Result Syntax
[
'NextToken' => '<string>',
'TotalCount' => <integer>,
'Users' => [
[
'Email' => '<string>',
'EnrollmentId' => '<string>',
'EnrollmentStatus' => 'INITIALIZED|PENDING|REGISTERED|DISASSOCIATING|DEREGISTERING',
'FirstName' => '<string>',
'LastName' => '<string>',
'UserArn' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token returned to indicate that there is more data available.
- TotalCount
-
- Type: int
The total number of users returned.
- Users
-
- Type: Array of UserData structures
The users that meet the specified set of filter criteria, in sort order.
Errors
There are no errors described for this operation.
SendAnnouncement
$result = $client->sendAnnouncement([/* ... */]); $promise = $client->sendAnnouncementAsync([/* ... */]);
Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
Parameter Syntax
$result = $client->sendAnnouncement([
'ClientRequestToken' => '<string>', // REQUIRED
'Content' => [ // REQUIRED
'AudioList' => [
[
'Locale' => 'en-US', // REQUIRED
'Location' => '<string>', // REQUIRED
],
// ...
],
'SsmlList' => [
[
'Locale' => 'en-US', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'TextList' => [
[
'Locale' => 'en-US', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
],
'RoomFilters' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'TimeToLiveInSeconds' => <integer>,
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
The unique, user-specified identifier for the request that ensures idempotency.
- Content
-
- Required: Yes
- Type: Content structure
The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
- RoomFilters
-
- Required: Yes
- Type: Array of Filter structures
The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.
- TimeToLiveInSeconds
-
- Type: int
The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.
Result Syntax
[
'AnnouncementArn' => '<string>',
]
Result Details
Errors
-
You are performing an action that would put you beyond your account's limits.
-
The resource being created already exists.
SendInvitation
$result = $client->sendInvitation([/* ... */]); $promise = $client->sendInvitationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->sendInvitation([
'UserArn' => '<string>',
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
The attempt to update a user is invalid due to the user's current status.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
StartDeviceSync
$result = $client->startDeviceSync([/* ... */]); $promise = $client->startDeviceSyncAsync([/* ... */]);
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).
Parameter Syntax
$result = $client->startDeviceSync([
'DeviceArn' => '<string>',
'Features' => ['<string>', ...], // REQUIRED
'RoomArn' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request failed because this device is no longer registered and therefore no longer managed by this account.
StartSmartHomeApplianceDiscovery
$result = $client->startSmartHomeApplianceDiscovery([/* ... */]); $promise = $client->startSmartHomeApplianceDiscoveryAsync([/* ... */]);
Initiates the discovery of any smart home appliances associated with the room.
Parameter Syntax
$result = $client->startSmartHomeApplianceDiscovery([
'RoomArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds metadata tags to a specified resource.
Parameter Syntax
$result = $client->tagResource([
'Arn' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the resource to which to add metadata tags. Required.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
The tags to be added to the specified resource. Do not provide system tags. Required.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes metadata tags from a specified resource.
Parameter Syntax
$result = $client->untagResource([
'Arn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
UpdateAddressBook
$result = $client->updateAddressBook([/* ... */]); $promise = $client->updateAddressBookAsync([/* ... */]);
Updates address book details by the address book ARN.
Parameter Syntax
$result = $client->updateAddressBook([
'AddressBookArn' => '<string>', // REQUIRED
'Description' => '<string>',
'Name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
The name sent in the request is already in use.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
UpdateBusinessReportSchedule
$result = $client->updateBusinessReportSchedule([/* ... */]); $promise = $client->updateBusinessReportScheduleAsync([/* ... */]);
Updates the configuration of the report delivery schedule with the specified schedule ARN.
Parameter Syntax
$result = $client->updateBusinessReportSchedule([
'Format' => 'CSV|CSV_ZIP',
'Recurrence' => [
'StartDate' => '<string>',
],
'S3BucketName' => '<string>',
'S3KeyPrefix' => '<string>',
'ScheduleArn' => '<string>', // REQUIRED
'ScheduleName' => '<string>',
]);
Parameter Details
Members
- Format
-
- Type: string
The format of the generated report (individual CSV files or zipped files of individual files).
- Recurrence
-
- Type: BusinessReportRecurrence structure
The recurrence of the reports.
- S3BucketName
-
- Type: string
The S3 location of the output reports.
- S3KeyPrefix
-
- Type: string
The S3 key where the report is delivered.
- ScheduleArn
-
- Required: Yes
- Type: string
The ARN of the business report schedule.
- ScheduleName
-
- Type: string
The name identifier of the schedule.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
UpdateConferenceProvider
$result = $client->updateConferenceProvider([/* ... */]); $promise = $client->updateConferenceProviderAsync([/* ... */]);
Updates an existing conference provider's settings.
Parameter Syntax
$result = $client->updateConferenceProvider([
'ConferenceProviderArn' => '<string>', // REQUIRED
'ConferenceProviderType' => 'CHIME|BLUEJEANS|FUZE|GOOGLE_HANGOUTS|POLYCOM|RINGCENTRAL|SKYPE_FOR_BUSINESS|WEBEX|ZOOM|CUSTOM', // REQUIRED
'IPDialIn' => [
'CommsProtocol' => 'SIP|SIPS|H323', // REQUIRED
'Endpoint' => '<string>', // REQUIRED
],
'MeetingSetting' => [ // REQUIRED
'RequirePin' => 'YES|NO|OPTIONAL', // REQUIRED
],
'PSTNDialIn' => [
'CountryCode' => '<string>', // REQUIRED
'OneClickIdDelay' => '<string>', // REQUIRED
'OneClickPinDelay' => '<string>', // REQUIRED
'PhoneNumber' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- ConferenceProviderArn
-
- Required: Yes
- Type: string
The ARN of the conference provider.
- ConferenceProviderType
-
- Required: Yes
- Type: string
The type of the conference provider.
- IPDialIn
-
- Type: IPDialIn structure
The IP endpoint and protocol for calling.
- MeetingSetting
-
- Required: Yes
- Type: MeetingSetting structure
The meeting settings for the conference provider.
- PSTNDialIn
-
- Type: PSTNDialIn structure
The information for PSTN conferencing.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
UpdateContact
$result = $client->updateContact([/* ... */]); $promise = $client->updateContactAsync([/* ... */]);
Updates the contact details by the contact ARN.
Parameter Syntax
$result = $client->updateContact([
'ContactArn' => '<string>', // REQUIRED
'DisplayName' => '<string>',
'FirstName' => '<string>',
'LastName' => '<string>',
'PhoneNumber' => '<string>',
'PhoneNumbers' => [
[
'Number' => '<string>', // REQUIRED
'Type' => 'MOBILE|WORK|HOME', // REQUIRED
],
// ...
],
'SipAddresses' => [
[
'Type' => 'WORK', // REQUIRED
'Uri' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ContactArn
-
- Required: Yes
- Type: string
The ARN of the contact to update.
- DisplayName
-
- Type: string
The updated display name of the contact.
- FirstName
-
- Type: string
The updated first name of the contact.
- LastName
-
- Type: string
The updated last name of the contact.
- PhoneNumber
-
- Type: string
The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
- PhoneNumbers
-
- Type: Array of PhoneNumber structures
The list of phone numbers for the contact.
- SipAddresses
-
- Type: Array of SipAddress structures
The list of SIP addresses for the contact.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
UpdateDevice
$result = $client->updateDevice([/* ... */]); $promise = $client->updateDeviceAsync([/* ... */]);
Updates the device name by device ARN.
Parameter Syntax
$result = $client->updateDevice([
'DeviceArn' => '<string>',
'DeviceName' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
The request failed because this device is no longer registered and therefore no longer managed by this account.
UpdateGateway
$result = $client->updateGateway([/* ... */]); $promise = $client->updateGatewayAsync([/* ... */]);
Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
Parameter Syntax
$result = $client->updateGateway([
'Description' => '<string>',
'GatewayArn' => '<string>', // REQUIRED
'Name' => '<string>',
'SoftwareVersion' => '<string>',
]);
Parameter Details
Members
- Description
-
- Type: string
The updated description of the gateway.
- GatewayArn
-
- Required: Yes
- Type: string
The ARN of the gateway to update.
- Name
-
- Type: string
The updated name of the gateway.
- SoftwareVersion
-
- Type: string
The updated software version of the gateway. The gateway automatically updates its software version during normal operation.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
The name sent in the request is already in use.
UpdateGatewayGroup
$result = $client->updateGatewayGroup([/* ... */]); $promise = $client->updateGatewayGroupAsync([/* ... */]);
Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
Parameter Syntax
$result = $client->updateGatewayGroup([
'Description' => '<string>',
'GatewayGroupArn' => '<string>', // REQUIRED
'Name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
The name sent in the request is already in use.
UpdateNetworkProfile
$result = $client->updateNetworkProfile([/* ... */]); $promise = $client->updateNetworkProfileAsync([/* ... */]);
Updates a network profile by the network profile ARN.
Parameter Syntax
$result = $client->updateNetworkProfile([
'CertificateAuthorityArn' => '<string>',
'CurrentPassword' => '<string>',
'Description' => '<string>',
'NetworkProfileArn' => '<string>', // REQUIRED
'NetworkProfileName' => '<string>',
'NextPassword' => '<string>',
'TrustAnchors' => ['<string>', ...],
]);
Parameter Details
Members
- CertificateAuthorityArn
-
- Type: string
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
- CurrentPassword
-
- Type: string
The current password of the Wi-Fi network.
- Description
-
- Type: string
Detailed information about a device's network profile.
- NetworkProfileArn
-
- Required: Yes
- Type: string
The ARN of the network profile associated with a device.
- NetworkProfileName
-
- Type: string
The name of the network profile associated with a device.
- NextPassword
-
- Type: string
The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
- TrustAnchors
-
- Type: Array of strings
The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
The name sent in the request is already in use.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
-
InvalidCertificateAuthorityException:
The Certificate Authority can't issue or revoke a certificate.
-
InvalidSecretsManagerResourceException:
A password in SecretsManager is in an invalid state.
UpdateProfile
$result = $client->updateProfile([/* ... */]); $promise = $client->updateProfileAsync([/* ... */]);
Updates an existing room profile by room profile ARN.
Parameter Syntax
$result = $client->updateProfile([
'Address' => '<string>',
'DataRetentionOptIn' => true || false,
'DistanceUnit' => 'METRIC|IMPERIAL',
'IsDefault' => true || false,
'Locale' => '<string>',
'MaxVolumeLimit' => <integer>,
'MeetingRoomConfiguration' => [
'EndOfMeetingReminder' => [
'Enabled' => true || false,
'ReminderAtMinutes' => [<integer>, ...],
'ReminderType' => 'ANNOUNCEMENT_TIME_CHECK|ANNOUNCEMENT_VARIABLE_TIME_LEFT|CHIME|KNOCK',
],
'InstantBooking' => [
'DurationInMinutes' => <integer>,
'Enabled' => true || false,
],
'RequireCheckIn' => [
'Enabled' => true || false,
'ReleaseAfterMinutes' => <integer>,
],
'RoomUtilizationMetricsEnabled' => true || false,
],
'PSTNEnabled' => true || false,
'ProfileArn' => '<string>',
'ProfileName' => '<string>',
'SetupModeDisabled' => true || false,
'TemperatureUnit' => 'FAHRENHEIT|CELSIUS',
'Timezone' => '<string>',
'WakeWord' => 'ALEXA|AMAZON|ECHO|COMPUTER',
]);
Parameter Details
Members
- Address
-
- Type: string
The updated address for the room profile.
- DataRetentionOptIn
-
- Type: boolean
Whether data retention of the profile is enabled.
- DistanceUnit
-
- Type: string
The updated distance unit for the room profile.
- IsDefault
-
- Type: boolean
Sets the profile as default if selected. If this is missing, no update is done to the default status.
- Locale
-
- Type: string
The updated locale for the room profile. (This is currently only available to a limited preview audience.)
- MaxVolumeLimit
-
- Type: int
The updated maximum volume limit for the room profile.
- MeetingRoomConfiguration
-
- Type: UpdateMeetingRoomConfiguration structure
The updated meeting room settings of a room profile.
- PSTNEnabled
-
- Type: boolean
Whether the PSTN setting of the room profile is enabled.
- ProfileArn
-
- Type: string
The ARN of the room profile to update. Required.
- ProfileName
-
- Type: string
The updated name for the room profile.
- SetupModeDisabled
-
- Type: boolean
Whether the setup mode of the profile is enabled.
- TemperatureUnit
-
- Type: string
The updated temperature unit for the room profile.
- Timezone
-
- Type: string
The updated timezone for the room profile.
- WakeWord
-
- Type: string
The updated wake word for the room profile.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
The name sent in the request is already in use.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
UpdateRoom
$result = $client->updateRoom([/* ... */]); $promise = $client->updateRoomAsync([/* ... */]);
Updates room details by room ARN.
Parameter Syntax
$result = $client->updateRoom([
'Description' => '<string>',
'ProfileArn' => '<string>',
'ProviderCalendarId' => '<string>',
'RoomArn' => '<string>',
'RoomName' => '<string>',
]);
Parameter Details
Members
- Description
-
- Type: string
The updated description for the room.
- ProfileArn
-
- Type: string
The updated profile ARN for the room.
- ProviderCalendarId
-
- Type: string
The updated provider calendar ARN for the room.
- RoomArn
-
- Type: string
The ARN of the room to update.
- RoomName
-
- Type: string
The updated name for the room.
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
The name sent in the request is already in use.
UpdateSkillGroup
$result = $client->updateSkillGroup([/* ... */]); $promise = $client->updateSkillGroupAsync([/* ... */]);
Updates skill group details by skill group ARN.
Parameter Syntax
$result = $client->updateSkillGroup([
'Description' => '<string>',
'SkillGroupArn' => '<string>',
'SkillGroupName' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is not found.
-
The name sent in the request is already in use.
-
ConcurrentModificationException:
There is a concurrent modification of resources.
Shapes
AddressBook
Description
An address book with attributes.
Members
AddressBookData
Description
Information related to an address book.
Members
AlreadyExistsException
Audio
Description
The audio message. There is a 1 MB limit on the audio file input and the only supported format is MP3. To convert your MP3 audio files to an Alexa-friendly,
required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter software. One option for this is a command-line tool, FFmpeg. For more information, see FFmpeg. The following command converts the provided <input-file> to an MP3 file that is played in the announcement:
ffmpeg -i <input-file> -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000 <output-file.mp3>
Members
- Locale
-
- Required: Yes
- Type: string
The locale of the audio message. Currently, en-US is supported.
- Location
-
- Required: Yes
- Type: string
The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.
BusinessReport
Description
Usage report with specified parameters.
Members
- DeliveryTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of report delivery.
- DownloadUrl
-
- Type: string
The download link where a user can download the report.
- FailureCode
-
- Type: string
The failure code.
- S3Location
-
- Type: BusinessReportS3Location structure
The S3 location of the output reports.
- Status
-
- Type: string
The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
BusinessReportContentRange
Description
The content range of the report.
Members
BusinessReportRecurrence
BusinessReportS3Location
Description
The S3 location of the output reports.
Members
BusinessReportSchedule
Description
The schedule of the usage report.
Members
- ContentRange
-
- Type: BusinessReportContentRange structure
The content range of the reports.
- Format
-
- Type: string
The format of the generated report (individual CSV files or zipped files of individual files).
- LastBusinessReport
-
- Type: BusinessReport structure
The details of the last business report delivery for a specified time interval.
- Recurrence
-
- Type: BusinessReportRecurrence structure
The recurrence of the reports.
- S3BucketName
-
- Type: string
The S3 bucket name of the output reports.
- S3KeyPrefix
-
- Type: string
The S3 key where the report is delivered.
- ScheduleArn
-
- Type: string
The ARN of the business report schedule.
- ScheduleName
-
- Type: string
The name identifier of the schedule.
Category
Description
The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.
Members
ConcurrentModificationException
ConferencePreference
Description
The default conference provider that is used if no other scheduled meetings are detected.
Members
ConferenceProvider
Description
An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.
Members
- Arn
-
- Type: string
The ARN of the newly created conference provider.
- IPDialIn
-
- Type: IPDialIn structure
The IP endpoint and protocol for calling.
- MeetingSetting
-
- Type: MeetingSetting structure
The meeting settings for the conference provider.
- Name
-
- Type: string
The name of the conference provider.
- PSTNDialIn
-
- Type: PSTNDialIn structure
The information for PSTN conferencing.
- Type
-
- Type: string
The type of conference providers.
Contact
Description
A contact with attributes.
Members
- ContactArn
-
- Type: string
The ARN of the contact.
- DisplayName
-
- Type: string
The name of the contact to display on the console.
- FirstName
-
- Type: string
The first name of the contact, used to call the contact on the device.
- LastName
-
- Type: string
The last name of the contact, used to call the contact on the device.
- PhoneNumber
-
- Type: string
The phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
- PhoneNumbers
-
- Type: Array of PhoneNumber structures
The list of phone numbers for the contact.
- SipAddresses
-
- Type: Array of SipAddress structures
The list of SIP addresses for the contact.
ContactData
Description
Information related to a contact.
Members
- ContactArn
-
- Type: string
The ARN of the contact.
- DisplayName
-
- Type: string
The name of the contact to display on the console.
- FirstName
-
- Type: string
The first name of the contact, used to call the contact on the device.
- LastName
-
- Type: string
The last name of the contact, used to call the contact on the device.
- PhoneNumber
-
- Type: string
The phone number of the contact. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
- PhoneNumbers
-
- Type: Array of PhoneNumber structures
The list of phone numbers for the contact.
- SipAddresses
-
- Type: Array of SipAddress structures
The list of SIP addresses for the contact.
Content
Description
The content definition. This can contain only one text, SSML, or audio list object.
Members
CreateEndOfMeetingReminder
Description
Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
Members
- Enabled
-
- Required: Yes
- Type: boolean
Whether an end of meeting reminder is enabled or not.
- ReminderAtMinutes
-
- Required: Yes
- Type: Array of ints
A range of 3 to 15 minutes that determines when the reminder begins.
- ReminderType
-
- Required: Yes
- Type: string
The type of sound that users hear during the end of meeting reminder.
CreateInstantBooking
Description
Creates settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.
Members
CreateMeetingRoomConfiguration
Description
Creates meeting room settings of a room profile.
Members
- EndOfMeetingReminder
-
- Type: CreateEndOfMeetingReminder structure
Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
- InstantBooking
-
- Type: CreateInstantBooking structure
Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.
- RequireCheckIn
-
- Type: CreateRequireCheckIn structure
Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
- RoomUtilizationMetricsEnabled
-
- Type: boolean
Whether room utilization metrics are enabled or not.
CreateRequireCheckIn
Description
Creates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.
Members
DeveloperInfo
Description
The details about the developer that published the skill.
Members
Device
Description
A device with attributes.
Members
- DeviceArn
-
- Type: string
The ARN of a device.
- DeviceName
-
- Type: string
The name of a device.
- DeviceSerialNumber
-
- Type: string
The serial number of a device.
- DeviceStatus
-
- Type: string
The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
- DeviceStatusInfo
-
- Type: DeviceStatusInfo structure
Detailed information about a device's status.
- DeviceType
-
- Type: string
The type of a device.
- MacAddress
-
- Type: string
The MAC address of a device.
- NetworkProfileInfo
-
- Type: DeviceNetworkProfileInfo structure
Detailed information about a device's network profile.
- RoomArn
-
- Type: string
The room ARN of a device.
- SoftwareVersion
-
- Type: string
The software version of a device.
DeviceData
Description
Device attributes.
Members
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time (in epoch) when the device data was created.
- DeviceArn
-
- Type: string
The ARN of a device.
- DeviceName
-
- Type: string
The name of a device.
- DeviceSerialNumber
-
- Type: string
The serial number of a device.
- DeviceStatus
-
- Type: string
The status of a device.
- DeviceStatusInfo
-
- Type: DeviceStatusInfo structure
Detailed information about a device's status.
- DeviceType
-
- Type: string
The type of a device.
- MacAddress
-
- Type: string
The MAC address of a device.
- NetworkProfileArn
-
- Type: string
The ARN of the network profile associated with a device.
- NetworkProfileName
-
- Type: string
The name of the network profile associated with a device.
- RoomArn
-
- Type: string
The room ARN associated with a device.
- RoomName
-
- Type: string
The name of the room associated with a device.
- SoftwareVersion
-
- Type: string
The software version of a device.
DeviceEvent
Description
The list of device events.
Members
DeviceNetworkProfileInfo
Description
Detailed information about a device's network profile.
Members
- CertificateArn
-
- Type: string
The ARN of the certificate associated with a device.
- CertificateExpirationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time (in epoch) when the certificate expires.
- NetworkProfileArn
-
- Type: string
The ARN of the network profile associated with a device.
DeviceNotRegisteredException
Description
The request failed because this device is no longer registered and therefore no longer managed by this account.
Members
DeviceStatusDetail
Description
Details of a device’s status.
Members
DeviceStatusInfo
Description
Detailed information about a device's status.
Members
- ConnectionStatus
-
- Type: string
The latest available information about the connection status of a device.
- ConnectionStatusUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time (in epoch) when the device connection status changed.
- DeviceStatusDetails
-
- Type: Array of DeviceStatusDetail structures
One or more device status detail descriptions.
EndOfMeetingReminder
Description
Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
Members
Filter
Description
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.
Members
Gateway
Description
The details of the gateway.
Members
- Arn
-
- Type: string
The ARN of the gateway.
- Description
-
- Type: string
The description of the gateway.
- GatewayGroupArn
-
- Type: string
The ARN of the gateway group that the gateway is associated to.
- Name
-
- Type: string
The name of the gateway.
- SoftwareVersion
-
- Type: string
The software version of the gateway. The gateway automatically updates its software version during normal operation.
GatewayGroup
Description
The details of the gateway group.
Members
GatewayGroupSummary
Description
The summary of a gateway group.
Members
GatewaySummary
Description
The summary of a gateway.
Members
- Arn
-
- Type: string
The ARN of the gateway.
- Description
-
- Type: string
The description of the gateway.
- GatewayGroupArn
-
- Type: string
The ARN of the gateway group that the gateway is associated to.
- Name
-
- Type: string
The name of the gateway.
- SoftwareVersion
-
- Type: string
The software version of the gateway. The gateway automatically updates its software version during normal operation.
IPDialIn
Description
The IP endpoint and protocol for calling.
Members
InstantBooking
Description
Settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.
Members
InvalidCertificateAuthorityException
Description
The Certificate Authority can't issue or revoke a certificate.
Members
InvalidDeviceException
InvalidSecretsManagerResourceException
InvalidServiceLinkedRoleStateException
InvalidUserStatusException
Description
The attempt to update a user is invalid due to the user's current status.
Members
LimitExceededException
Description
You are performing an action that would put you beyond your account's limits.
Members
MeetingRoomConfiguration
Description
Meeting room settings of a room profile.
Members
- EndOfMeetingReminder
-
- Type: EndOfMeetingReminder structure
Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
- InstantBooking
-
- Type: InstantBooking structure
Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.
- RequireCheckIn
-
- Type: RequireCheckIn structure
Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
- RoomUtilizationMetricsEnabled
-
- Type: boolean
Whether room utilization metrics are enabled or not.
MeetingSetting
Description
The values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL.
-
If YES, Alexa will always ask for a meeting pin.
-
If NO, Alexa will never ask for a meeting pin.
-
If OPTIONAL, Alexa will ask if you have a meeting pin and if the customer responds with yes, it will ask for the meeting pin.
Members
NameInUseException
NetworkProfile
Description
The network profile associated with a device.
Members
- CertificateAuthorityArn
-
- Type: string
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
- CurrentPassword
-
- Type: string
The current password of the Wi-Fi network.
- Description
-
- Type: string
Detailed information about a device's network profile.
- EapMethod
-
- Type: string
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
- NetworkProfileArn
-
- Type: string
The ARN of the network profile associated with a device.
- NetworkProfileName
-
- Type: string
The name of the network profile associated with a device.
- NextPassword
-
- Type: string
The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
- SecurityType
-
- Type: string
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
- Ssid
-
- Type: string
The SSID of the Wi-Fi network.
- TrustAnchors
-
- Type: Array of strings
The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.
NetworkProfileData
Description
The data associated with a network profile.
Members
- CertificateAuthorityArn
-
- Type: string
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
- Description
-
- Type: string
Detailed information about a device's network profile.
- EapMethod
-
- Type: string
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
- NetworkProfileArn
-
- Type: string
The ARN of the network profile associated with a device.
- NetworkProfileName
-
- Type: string
The name of the network profile associated with a device.
- SecurityType
-
- Type: string
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
- Ssid
-
- Type: string
The SSID of the Wi-Fi network.
NotFoundException
PSTNDialIn
Description
The information for public switched telephone network (PSTN) conferencing.
Members
- CountryCode
-
- Required: Yes
- Type: string
The zip code.
- OneClickIdDelay
-
- Required: Yes
- Type: string
The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
- OneClickPinDelay
-
- Required: Yes
- Type: string
The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
- PhoneNumber
-
- Required: Yes
- Type: string
The phone number to call to join the conference.
PhoneNumber
Description
The phone number for the contact containing the raw number and phone number type.
Members
Profile
Description
A room profile with attributes.
Members
- Address
-
- Type: string
The address of a room profile.
- AddressBookArn
-
- Type: string
The ARN of the address book.
- DataRetentionOptIn
-
- Type: boolean
Whether data retention of the profile is enabled.
- DistanceUnit
-
- Type: string
The distance unit of a room profile.
- IsDefault
-
- Type: boolean
Retrieves if the profile is default or not.
- Locale
-
- Type: string
The locale of a room profile. (This is currently available only to a limited preview audience.)
- MaxVolumeLimit
-
- Type: int
The max volume limit of a room profile.
- MeetingRoomConfiguration
-
- Type: MeetingRoomConfiguration structure
Meeting room settings of a room profile.
- PSTNEnabled
-
- Type: boolean
The PSTN setting of a room profile.
- ProfileArn
-
- Type: string
The ARN of a room profile.
- ProfileName
-
- Type: string
The name of a room profile.
- SetupModeDisabled
-
- Type: boolean
The setup mode of a room profile.
- TemperatureUnit
-
- Type: string
The temperature unit of a room profile.
- Timezone
-
- Type: string
The time zone of a room profile.
- WakeWord
-
- Type: string
The wake word of a room profile.
ProfileData
Description
The data of a room profile.
Members
- Address
-
- Type: string
The address of a room profile.
- DistanceUnit
-
- Type: string
The distance unit of a room profile.
- IsDefault
-
- Type: boolean
Retrieves if the profile data is default or not.
- Locale
-
- Type: string
The locale of a room profile. (This is currently available only to a limited preview audience.)
- ProfileArn
-
- Type: string
The ARN of a room profile.
- ProfileName
-
- Type: string
The name of a room profile.
- TemperatureUnit
-
- Type: string
The temperature unit of a room profile.
- Timezone
-
- Type: string
The time zone of a room profile.
- WakeWord
-
- Type: string
The wake word of a room profile.
RequireCheckIn
Description
Settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.
Members
ResourceAssociatedException
Description
Another resource is associated with the resource in the request.
Members
ResourceInUseException
Description
The resource in the request is already in use.
Members
Room
Description
A room with attributes.
Members
RoomData
Description
The data of a room.
Members
- Description
-
- Type: string
The description of a room.
- ProfileArn
-
- Type: string
The profile ARN of a room.
- ProfileName
-
- Type: string
The profile name of a room.
- ProviderCalendarId
-
- Type: string
The provider calendar ARN of a room.
- RoomArn
-
- Type: string
The ARN of a room.
- RoomName
-
- Type: string
The name of a room.
RoomSkillParameter
Description
A skill parameter associated with a room.
Members
SipAddress
Description
The SIP address for the contact containing the URI and SIP address type.
Members
SkillDetails
Description
Granular information about the skill.
Members
- BulletPoints
-
- Type: Array of strings
The details about what the skill supports organized as bullet points.
- DeveloperInfo
-
- Type: DeveloperInfo structure
The details about the developer that published the skill.
- EndUserLicenseAgreement
-
- Type: string
The URL of the end user license agreement.
- GenericKeywords
-
- Type: Array of strings
The generic keywords associated with the skill that can be used to find a skill.
- InvocationPhrase
-
- Type: string
The phrase used to trigger the skill.
- NewInThisVersionBulletPoints
-
- Type: Array of strings
The updates added in bullet points.
- ProductDescription
-
- Type: string
The description of the product.
- ReleaseDate
-
- Type: string
The date when the skill was released.
- Reviews
-
- Type: Associative array of custom strings keys (ReviewKey) to strings
This member has been deprecated.
The list of reviews for the skill, including Key and Value pair.
- SkillTypes
-
- Type: Array of strings
The types of skills.
SkillGroup
Description
A skill group with attributes.
Members
SkillGroupData
Description
The attributes of a skill group.
Members
SkillNotLinkedException
SkillSummary
Description
The summary of skills.
Members
- EnablementType
-
- Type: string
Whether the skill is enabled under the user's account, or if it requires linking to be used.
- SkillId
-
- Type: string
The ARN of the skill summary.
- SkillName
-
- Type: string
The name of the skill.
- SkillType
-
- Type: string
Whether the skill is publicly available or is a private skill.
- SupportsLinking
-
- Type: boolean
Linking support for a skill.
SkillsStoreSkill
Description
The detailed information about an Alexa skill.
Members
- IconUrl
-
- Type: string
The URL where the skill icon resides.
- SampleUtterances
-
- Type: Array of strings
Sample utterances that interact with the skill.
- ShortDescription
-
- Type: string
Short description about the skill.
- SkillDetails
-
- Type: SkillDetails structure
Information about the skill.
- SkillId
-
- Type: string
The ARN of the skill.
- SkillName
-
- Type: string
The name of the skill.
- SupportsLinking
-
- Type: boolean
Linking support for a skill.
SmartHomeAppliance
Description
A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.
Members
Sort
Description
An object representing a sort criteria.
Members
Ssml
Tag
Description
A key-value pair that can be associated with a resource.
Members
Text
Description
The text message.
Members
UnauthorizedException
Description
The caller has no permissions to operate on the resource involved in the API call.
Members
UpdateEndOfMeetingReminder
Description
Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
Members
- Enabled
-
- Type: boolean
Whether an end of meeting reminder is enabled or not.
- ReminderAtMinutes
-
- Type: Array of ints
Updates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
- ReminderType
-
- Type: string
The type of sound that users hear during the end of meeting reminder.
UpdateInstantBooking
Description
Updates settings for the instant booking feature that are applied to a room profile. If instant booking is enabled, Alexa automatically reserves a room if it is free when a user joins a meeting with Alexa.
Members
UpdateMeetingRoomConfiguration
Description
Updates meeting room settings of a room profile.
Members
- EndOfMeetingReminder
-
- Type: UpdateEndOfMeetingReminder structure
Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
- InstantBooking
-
- Type: UpdateInstantBooking structure
Settings to automatically book an available room available for a configured duration when joining a meeting with Alexa.
- RequireCheckIn
-
- Type: UpdateRequireCheckIn structure
Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
- RoomUtilizationMetricsEnabled
-
- Type: boolean
Whether room utilization metrics are enabled or not.
UpdateRequireCheckIn
Description
Updates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.
Members
UserData
Description
Information related to a user.