Table of Contents
A low-level client representing Alexa For Business:
import boto3
client = boto3.client('alexaforbusiness')
These are the available methods:
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.
See also: AWS API Documentation
Request Syntax
response = client.approve_skill(
SkillId='string'
)
[REQUIRED]
The unique identifier of the skill.
{}
Response Structure
Associates a contact with a given address book.
See also: AWS API Documentation
Request Syntax
response = client.associate_contact_with_address_book(
ContactArn='string',
AddressBookArn='string'
)
[REQUIRED]
The ARN of the contact to associate with an address book.
[REQUIRED]
The ARN of the address book with which to associate the contact.
dict
Response Syntax
{}
Response Structure
Associates a device with the specified network profile.
See also: AWS API Documentation
Request Syntax
response = client.associate_device_with_network_profile(
DeviceArn='string',
NetworkProfileArn='string'
)
[REQUIRED]
The device ARN.
[REQUIRED]
The ARN of the network profile to associate with a device.
dict
Response Syntax
{}
Response Structure
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.
See also: AWS API Documentation
Request Syntax
response = client.associate_device_with_room(
DeviceArn='string',
RoomArn='string'
)
dict
Response Syntax
{}
Response Structure
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
See also: AWS API Documentation
Request Syntax
response = client.associate_skill_group_with_room(
SkillGroupArn='string',
RoomArn='string'
)
dict
Response Syntax
{}
Response Structure
Associates a skill with a skill group.
See also: AWS API Documentation
Request Syntax
response = client.associate_skill_with_skill_group(
SkillGroupArn='string',
SkillId='string'
)
[REQUIRED]
The unique identifier of the skill.
dict
Response Syntax
{}
Response Structure
Makes a private skill available for enrolled users to enable on their devices.
See also: AWS API Documentation
Request Syntax
response = client.associate_skill_with_users(
SkillId='string'
)
[REQUIRED]
The private skill ID you want to make available to enrolled users.
{}
Response Structure
Check if an operation can be paginated.
Creates an address book with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_address_book(
Name='string',
Description='string',
ClientRequestToken='string'
)
[REQUIRED]
The name of the address book.
A unique, user-specified identifier for the request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'AddressBookArn': 'string'
}
Response Structure
(dict) --
AddressBookArn (string) --
The ARN of the newly created address book.
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
See also: AWS API Documentation
Request Syntax
response = client.create_business_report_schedule(
ScheduleName='string',
S3BucketName='string',
S3KeyPrefix='string',
Format='CSV'|'CSV_ZIP',
ContentRange={
'Interval': 'ONE_DAY'|'ONE_WEEK'
},
Recurrence={
'StartDate': 'string'
},
ClientRequestToken='string'
)
[REQUIRED]
The format of the generated report (individual CSV files or zipped files of individual files).
[REQUIRED]
The content range of the reports.
The interval of the content range.
The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
The start date.
The client request token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ScheduleArn': 'string'
}
Response Structure
(dict) --
ScheduleArn (string) --
The ARN of the business report schedule.
Adds a new conference provider under the user's AWS account.
See also: AWS API Documentation
Request Syntax
response = client.create_conference_provider(
ConferenceProviderName='string',
ConferenceProviderType='CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
IPDialIn={
'Endpoint': 'string',
'CommsProtocol': 'SIP'|'SIPS'|'H323'
},
PSTNDialIn={
'CountryCode': 'string',
'PhoneNumber': 'string',
'OneClickIdDelay': 'string',
'OneClickPinDelay': 'string'
},
MeetingSetting={
'RequirePin': 'YES'|'NO'|'OPTIONAL'
},
ClientRequestToken='string'
)
[REQUIRED]
The name of the conference provider.
[REQUIRED]
Represents a type within a list of predefined types.
The IP endpoint and protocol for calling.
The IP address.
The protocol, including SIP, SIPS, and H323.
The information for PSTN conferencing.
The zip code.
The phone number to call to join the conference.
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.
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.
[REQUIRED]
The meeting settings for the conference provider.
The values that indicate whether the pin is always required.
The request token of the client.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ConferenceProviderArn': 'string'
}
Response Structure
(dict) --
ConferenceProviderArn (string) --
The ARN of the newly-created conference provider.
Creates a contact with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_contact(
DisplayName='string',
FirstName='string',
LastName='string',
PhoneNumber='string',
PhoneNumbers=[
{
'Number': 'string',
'Type': 'MOBILE'|'WORK'|'HOME'
},
],
SipAddresses=[
{
'Uri': 'string',
'Type': 'WORK'
},
],
ClientRequestToken='string'
)
[REQUIRED]
The first name of the contact that is used to call the contact on the device.
The list of phone numbers for the contact.
The phone number for the contact containing the raw number and phone number type.
The raw value of the phone number.
The type of the phone number.
The list of SIP addresses for the contact.
The SIP address for the contact containing the URI and SIP address type.
The URI for the SIP address.
The type of the SIP address.
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactArn': 'string'
}
Response Structure
(dict) --
ContactArn (string) --
The ARN of the newly created address book.
Creates a gateway group with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_gateway_group(
Name='string',
Description='string',
ClientRequestToken='string'
)
[REQUIRED]
The name of the gateway group.
[REQUIRED]
A unique, user-specified identifier for the request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'GatewayGroupArn': 'string'
}
Response Structure
(dict) --
GatewayGroupArn (string) --
The ARN of the created gateway group.
Creates a network profile with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_network_profile(
NetworkProfileName='string',
Description='string',
Ssid='string',
SecurityType='OPEN'|'WEP'|'WPA_PSK'|'WPA2_PSK'|'WPA2_ENTERPRISE',
EapMethod='EAP_TLS',
CurrentPassword='string',
NextPassword='string',
CertificateAuthorityArn='string',
TrustAnchors=[
'string',
],
ClientRequestToken='string'
)
[REQUIRED]
The name of the network profile associated with a device.
[REQUIRED]
The SSID of the Wi-Fi network.
[REQUIRED]
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.
[REQUIRED]
A unique, user-specified identifier for the request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'NetworkProfileArn': 'string'
}
Response Structure
(dict) --
NetworkProfileArn (string) --
The ARN of the network profile associated with a device.
Creates a new room profile with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_profile(
ProfileName='string',
Timezone='string',
Address='string',
DistanceUnit='METRIC'|'IMPERIAL',
TemperatureUnit='FAHRENHEIT'|'CELSIUS',
WakeWord='ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
ClientRequestToken='string',
SetupModeDisabled=True|False,
MaxVolumeLimit=123,
PSTNEnabled=True|False
)
[REQUIRED]
The name of a room profile.
[REQUIRED]
The time zone used by a room profile.
[REQUIRED]
The valid address for the room.
[REQUIRED]
The distance unit to be used by devices in the profile.
[REQUIRED]
The temperature unit to be used by devices in the profile.
[REQUIRED]
A wake word for Alexa, Echo, Amazon, or a computer.
The user-specified token that is used during the creation of a profile.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProfileArn': 'string'
}
Response Structure
(dict) --
ProfileArn (string) --
The ARN of the newly created room profile in the response.
Creates a room with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_room(
RoomName='string',
Description='string',
ProfileArn='string',
ProviderCalendarId='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name for the room.
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
The tags for the room.
A key-value pair that can be associated with a resource.
The key of a tag. Tag keys are case-sensitive.
The value of a tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{
'RoomArn': 'string'
}
Response Structure
(dict) --
RoomArn (string) --
The ARN of the newly created room in the response.
Creates a skill group with a specified name and description.
See also: AWS API Documentation
Request Syntax
response = client.create_skill_group(
SkillGroupName='string',
Description='string',
ClientRequestToken='string'
)
[REQUIRED]
The name for the skill group.
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'SkillGroupArn': 'string'
}
Response Structure
(dict) --
SkillGroupArn (string) --
The ARN of the newly created skill group in the response.
Creates a user.
See also: AWS API Documentation
Request Syntax
response = client.create_user(
UserId='string',
FirstName='string',
LastName='string',
Email='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN for the user.
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
The tags for the user.
A key-value pair that can be associated with a resource.
The key of a tag. Tag keys are case-sensitive.
The value of a tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{
'UserArn': 'string'
}
Response Structure
(dict) --
UserArn (string) --
The ARN of the newly created user in the response.
Deletes an address book by the address book ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_address_book(
AddressBookArn='string'
)
[REQUIRED]
The ARN of the address book to delete.
{}
Response Structure
Deletes the recurring report delivery schedule with the specified schedule ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_business_report_schedule(
ScheduleArn='string'
)
[REQUIRED]
The ARN of the business report schedule.
{}
Response Structure
Deletes a conference provider.
See also: AWS API Documentation
Request Syntax
response = client.delete_conference_provider(
ConferenceProviderArn='string'
)
[REQUIRED]
The ARN of the conference provider.
{}
Response Structure
Deletes a contact by the contact ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_contact(
ContactArn='string'
)
[REQUIRED]
The ARN of the contact to delete.
{}
Response Structure
Removes a device from Alexa For Business.
See also: AWS API Documentation
Request Syntax
response = client.delete_device(
DeviceArn='string'
)
[REQUIRED]
The ARN of the device for which to request details.
{}
Response Structure
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.
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. This action can be called once every 24 hours for a specific shared device.
See also: AWS API Documentation
Request Syntax
response = client.delete_device_usage_data(
DeviceArn='string',
DeviceUsageType='VOICE'
)
[REQUIRED]
The ARN of the device.
[REQUIRED]
The type of usage data to delete.
dict
Response Syntax
{}
Response Structure
Deletes a gateway group.
See also: AWS API Documentation
Request Syntax
response = client.delete_gateway_group(
GatewayGroupArn='string'
)
[REQUIRED]
The ARN of the gateway group to delete.
{}
Response Structure
Deletes a network profile by the network profile ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_network_profile(
NetworkProfileArn='string'
)
[REQUIRED]
The ARN of the network profile associated with a device.
{}
Response Structure
Deletes a room profile by the profile ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_profile(
ProfileArn='string'
)
{}
Response Structure
Deletes a room by the room ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_room(
RoomArn='string'
)
{}
Response Structure
Deletes room skill parameter details by room, skill, and parameter key ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_room_skill_parameter(
RoomArn='string',
SkillId='string',
ParameterKey='string'
)
[REQUIRED]
The ID of the skill from which to remove the room skill parameter details.
[REQUIRED]
The room skill parameter key for which to remove details.
dict
Response Syntax
{}
Response Structure
Unlinks a third-party account from a skill.
See also: AWS API Documentation
Request Syntax
response = client.delete_skill_authorization(
SkillId='string',
RoomArn='string'
)
[REQUIRED]
The unique identifier of a skill.
dict
Response Syntax
{}
Response Structure
Deletes a skill group by skill group ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_skill_group(
SkillGroupArn='string'
)
{}
Response Structure
Deletes a specified user by user ARN and enrollment ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
UserArn='string',
EnrollmentId='string'
)
[REQUIRED]
The ARN of the user's enrollment in the organization. Required.
dict
Response Syntax
{}
Response Structure
Disassociates a contact from a given address book.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_contact_from_address_book(
ContactArn='string',
AddressBookArn='string'
)
[REQUIRED]
The ARN of the contact to disassociate from an address book.
[REQUIRED]
The ARN of the address from which to disassociate the contact.
dict
Response Syntax
{}
Response Structure
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.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_device_from_room(
DeviceArn='string'
)
{}
Response Structure
Disassociates a skill from a skill group.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_skill_from_skill_group(
SkillGroupArn='string',
SkillId='string'
)
[REQUIRED]
The ARN of a skill group to associate to a skill.
dict
Response Syntax
{}
Response Structure
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_skill_from_users(
SkillId='string'
)
[REQUIRED]
The private skill ID you want to make unavailable for enrolled users.
{}
Response Structure
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_skill_group_from_room(
SkillGroupArn='string',
RoomArn='string'
)
dict
Response Syntax
{}
Response Structure
Forgets smart home appliances associated to a room.
See also: AWS API Documentation
Request Syntax
response = client.forget_smart_home_appliances(
RoomArn='string'
)
[REQUIRED]
The room that the appliances are associated with.
{}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets address the book details by the address book ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_address_book(
AddressBookArn='string'
)
[REQUIRED]
The ARN of the address book for which to request details.
{
'AddressBook': {
'AddressBookArn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
The details of the requested address book.
The ARN of the address book.
The name of the address book.
The description of the address book.
Retrieves the existing conference preferences.
See also: AWS API Documentation
Request Syntax
response = client.get_conference_preference()
{
'Preference': {
'DefaultConferenceProviderArn': 'string'
}
}
Response Structure
The conference preference.
The ARN of the default conference provider.
Gets details about a specific conference provider.
See also: AWS API Documentation
Request Syntax
response = client.get_conference_provider(
ConferenceProviderArn='string'
)
[REQUIRED]
The ARN of the newly created conference provider.
{
'ConferenceProvider': {
'Arn': 'string',
'Name': 'string',
'Type': 'CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
'IPDialIn': {
'Endpoint': 'string',
'CommsProtocol': 'SIP'|'SIPS'|'H323'
},
'PSTNDialIn': {
'CountryCode': 'string',
'PhoneNumber': 'string',
'OneClickIdDelay': 'string',
'OneClickPinDelay': 'string'
},
'MeetingSetting': {
'RequirePin': 'YES'|'NO'|'OPTIONAL'
}
}
}
Response Structure
The conference provider.
The ARN of the newly created conference provider.
The name of the conference provider.
The type of conference providers.
The IP endpoint and protocol for calling.
The IP address.
The protocol, including SIP, SIPS, and H323.
The information for PSTN conferencing.
The zip code.
The phone number to call to join the conference.
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.
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.
The meeting settings for the conference provider.
The values that indicate whether the pin is always required.
Gets the contact details by the contact ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_contact(
ContactArn='string'
)
[REQUIRED]
The ARN of the contact for which to request details.
{
'Contact': {
'ContactArn': 'string',
'DisplayName': 'string',
'FirstName': 'string',
'LastName': 'string',
'PhoneNumber': 'string',
'PhoneNumbers': [
{
'Number': 'string',
'Type': 'MOBILE'|'WORK'|'HOME'
},
],
'SipAddresses': [
{
'Uri': 'string',
'Type': 'WORK'
},
]
}
}
Response Structure
The details of the requested contact.
The ARN of the contact.
The name of the contact to display on the console.
The first name of the contact, used to call the contact on the device.
The last name of the contact, used to call the contact on the device.
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.
The list of phone numbers for the contact.
The phone number for the contact containing the raw number and phone number type.
The raw value of the phone number.
The type of the phone number.
The list of SIP addresses for the contact.
The SIP address for the contact containing the URI and SIP address type.
The URI for the SIP address.
The type of the SIP address.
Gets the details of a device by device ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_device(
DeviceArn='string'
)
{
'Device': {
'DeviceArn': 'string',
'DeviceSerialNumber': 'string',
'DeviceType': 'string',
'DeviceName': 'string',
'SoftwareVersion': 'string',
'MacAddress': 'string',
'RoomArn': 'string',
'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED'|'FAILED',
'DeviceStatusInfo': {
'DeviceStatusDetails': [
{
'Feature': 'BLUETOOTH'|'VOLUME'|'NOTIFICATIONS'|'LISTS'|'SKILLS'|'NETWORK_PROFILE'|'SETTINGS'|'ALL',
'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'
},
],
'ConnectionStatus': 'ONLINE'|'OFFLINE'
},
'NetworkProfileInfo': {
'NetworkProfileArn': 'string',
'CertificateArn': 'string',
'CertificateExpirationTime': datetime(2015, 1, 1)
}
}
}
Response Structure
The details of the device requested. Required.
The ARN of a device.
The serial number of a device.
The type of a device.
The name of a device.
The software version of a device.
The MAC address of a device.
The room ARN of a device.
The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
Detailed information about a device's status.
One or more device status detail descriptions.
Details of a device’s status.
The list of available features on the device.
The device status detail code.
The latest available information about the connection status of a device.
Detailed information about a device's network profile.
The ARN of the network profile associated with a device.
The ARN of the certificate associated with a device.
The time (in epoch) when the certificate expires.
Retrieves the details of a gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_gateway(
GatewayArn='string'
)
[REQUIRED]
The ARN of the gateway to get.
{
'Gateway': {
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'GatewayGroupArn': 'string',
'SoftwareVersion': 'string'
}
}
Response Structure
The details of the gateway.
The ARN of the gateway.
The name of the gateway.
The description of the gateway.
The ARN of the gateway group that the gateway is associated to.
The software version of the gateway. The gateway automatically updates its software version during normal operation.
Retrieves the details of a gateway group.
See also: AWS API Documentation
Request Syntax
response = client.get_gateway_group(
GatewayGroupArn='string'
)
[REQUIRED]
The ARN of the gateway group to get.
{
'GatewayGroup': {
'Arn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
The details of the gateway group.
The ARN of the gateway group.
The name of the gateway group.
The description of the gateway group.
Retrieves the configured values for the user enrollment invitation email template.
See also: AWS API Documentation
Request Syntax
response = client.get_invitation_configuration()
{
'OrganizationName': 'string',
'ContactEmail': 'string',
'PrivateSkillIds': [
'string',
]
}
Response Structure
The name of the organization sending the enrollment invite to a user.
The email ID of the organization or individual contact that the enrolled user can use.
The list of private skill IDs that you want to recommend to the user to enable in the invitation.
Gets the network profile details by the network profile ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_network_profile(
NetworkProfileArn='string'
)
[REQUIRED]
The ARN of the network profile associated with a device.
{
'NetworkProfile': {
'NetworkProfileArn': 'string',
'NetworkProfileName': 'string',
'Description': 'string',
'Ssid': 'string',
'SecurityType': 'OPEN'|'WEP'|'WPA_PSK'|'WPA2_PSK'|'WPA2_ENTERPRISE',
'EapMethod': 'EAP_TLS',
'CurrentPassword': 'string',
'NextPassword': 'string',
'CertificateAuthorityArn': 'string',
'TrustAnchors': [
'string',
]
}
}
Response Structure
The network profile associated with a device.
The ARN of the network profile associated with a device.
The name of the network profile associated with a device.
Detailed information about a device's network profile.
The SSID of the Wi-Fi network.
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
The current password of the Wi-Fi network.
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.
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.
Create a paginator for an operation.
Gets the details of a room profile by profile ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_profile(
ProfileArn='string'
)
{
'Profile': {
'ProfileArn': 'string',
'ProfileName': 'string',
'IsDefault': True|False,
'Address': 'string',
'Timezone': 'string',
'DistanceUnit': 'METRIC'|'IMPERIAL',
'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
'SetupModeDisabled': True|False,
'MaxVolumeLimit': 123,
'PSTNEnabled': True|False,
'AddressBookArn': 'string'
}
}
Response Structure
The details of the room profile requested. Required.
The ARN of a room profile.
The name of a room profile.
Retrieves if the profile is default or not.
The address of a room profile.
The time zone of a room profile.
The distance unit of a room profile.
The temperature unit of a room profile.
The wake word of a room profile.
The setup mode of a room profile.
The max volume limit of a room profile.
The PSTN setting of a room profile.
The ARN of the address book.
Gets room details by room ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_room(
RoomArn='string'
)
{
'Room': {
'RoomArn': 'string',
'RoomName': 'string',
'Description': 'string',
'ProviderCalendarId': 'string',
'ProfileArn': 'string'
}
}
Response Structure
The details of the room requested.
The ARN of a room.
The name of a room.
The description of a room.
The provider calendar ARN of a room.
The profile ARN of a room.
Gets room skill parameter details by room, skill, and parameter key ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_room_skill_parameter(
RoomArn='string',
SkillId='string',
ParameterKey='string'
)
[REQUIRED]
The ARN of the skill from which to get the room skill parameter details. Required.
[REQUIRED]
The room skill parameter key for which to get details. Required.
dict
Response Syntax
{
'RoomSkillParameter': {
'ParameterKey': 'string',
'ParameterValue': 'string'
}
}
Response Structure
(dict) --
RoomSkillParameter (dict) --
The details of the room skill parameter requested. Required.
ParameterKey (string) --
The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
ParameterValue (string) --
The parameter value of a room skill parameter.
Gets skill group details by skill group ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_skill_group(
SkillGroupArn='string'
)
{
'SkillGroup': {
'SkillGroupArn': 'string',
'SkillGroupName': 'string',
'Description': 'string'
}
}
Response Structure
The details of the skill group requested. Required.
The ARN of a skill group.
The name of a skill group.
The description of a skill group.
Returns an object that can wait for some condition.
Lists the details of the schedules that a user configured.
See also: AWS API Documentation
Request Syntax
response = client.list_business_report_schedules(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'BusinessReportSchedules': [
{
'ScheduleArn': 'string',
'ScheduleName': 'string',
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Format': 'CSV'|'CSV_ZIP',
'ContentRange': {
'Interval': 'ONE_DAY'|'ONE_WEEK'
},
'Recurrence': {
'StartDate': 'string'
},
'LastBusinessReport': {
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED',
'FailureCode': 'ACCESS_DENIED'|'NO_SUCH_BUCKET'|'INTERNAL_FAILURE',
'S3Location': {
'Path': 'string',
'BucketName': 'string'
},
'DeliveryTime': datetime(2015, 1, 1),
'DownloadUrl': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BusinessReportSchedules (list) --
The schedule of the reports.
(dict) --
The schedule of the usage report.
ScheduleArn (string) --
The ARN of the business report schedule.
ScheduleName (string) --
The name identifier of the schedule.
S3BucketName (string) --
The S3 bucket name of the output reports.
S3KeyPrefix (string) --
The S3 key where the report is delivered.
Format (string) --
The format of the generated report (individual CSV files or zipped files of individual files).
ContentRange (dict) --
The content range of the reports.
Interval (string) --
The interval of the content range.
Recurrence (dict) --
The recurrence of the reports.
StartDate (string) --
The start date.
LastBusinessReport (dict) --
The details of the last business report delivery for a specified time interval.
Status (string) --
The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
FailureCode (string) --
The failure code.
S3Location (dict) --
The S3 location of the output reports.
Path (string) --
The path of the business report.
BucketName (string) --
The S3 bucket name of the output reports.
DeliveryTime (datetime) --
The time of report delivery.
DownloadUrl (string) --
The download link where a user can download the report.
NextToken (string) --
The token used to list the remaining schedules from the previous API call.
Lists conference providers under a specific AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_conference_providers(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'ConferenceProviders': [
{
'Arn': 'string',
'Name': 'string',
'Type': 'CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
'IPDialIn': {
'Endpoint': 'string',
'CommsProtocol': 'SIP'|'SIPS'|'H323'
},
'PSTNDialIn': {
'CountryCode': 'string',
'PhoneNumber': 'string',
'OneClickIdDelay': 'string',
'OneClickPinDelay': 'string'
},
'MeetingSetting': {
'RequirePin': 'YES'|'NO'|'OPTIONAL'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConferenceProviders (list) --
The conference providers.
(dict) --
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.
Arn (string) --
The ARN of the newly created conference provider.
Name (string) --
The name of the conference provider.
Type (string) --
The type of conference providers.
IPDialIn (dict) --
The IP endpoint and protocol for calling.
Endpoint (string) --
The IP address.
CommsProtocol (string) --
The protocol, including SIP, SIPS, and H323.
PSTNDialIn (dict) --
The information for PSTN conferencing.
CountryCode (string) --
The zip code.
PhoneNumber (string) --
The phone number to call to join the conference.
OneClickIdDelay (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 (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.
MeetingSetting (dict) --
The meeting settings for the conference provider.
RequirePin (string) --
The values that indicate whether the pin is always required.
NextToken (string) --
The tokens used for pagination.
Lists the device event history, including device connection status, for up to 30 days.
See also: AWS API Documentation
Request Syntax
response = client.list_device_events(
DeviceArn='string',
EventType='CONNECTION_STATUS'|'DEVICE_STATUS',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of a device.
dict
Response Syntax
{
'DeviceEvents': [
{
'Type': 'CONNECTION_STATUS'|'DEVICE_STATUS',
'Value': 'string',
'Timestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DeviceEvents (list) --
The device events requested for the device ARN.
(dict) --
The list of device events.
Type (string) --
The type of device event.
Value (string) --
The value of the event.
Timestamp (datetime) --
The time (in epoch) when the event occurred.
NextToken (string) --
The token returned to indicate that there is more data available.
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
See also: AWS API Documentation
Request Syntax
response = client.list_gateway_groups(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'GatewayGroups': [
{
'Arn': 'string',
'Name': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GatewayGroups (list) --
The gateway groups in the list.
(dict) --
The summary of a gateway group.
Arn (string) --
The ARN of the gateway group.
Name (string) --
The name of the gateway group.
Description (string) --
The description of the gateway group.
NextToken (string) --
The token used to paginate though multiple pages of gateway group summaries.
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.
See also: AWS API Documentation
Request Syntax
response = client.list_gateways(
GatewayGroupArn='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Gateways': [
{
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'GatewayGroupArn': 'string',
'SoftwareVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Gateways (list) --
The gateways in the list.
(dict) --
The summary of a gateway.
Arn (string) --
The ARN of the gateway.
Name (string) --
The name of the gateway.
Description (string) --
The description of the gateway.
GatewayGroupArn (string) --
The ARN of the gateway group that the gateway is associated to.
SoftwareVersion (string) --
The software version of the gateway. The gateway automatically updates its software version during normal operation.
NextToken (string) --
The token used to paginate though multiple pages of gateway summaries.
Lists all enabled skills in a specific skill group.
See also: AWS API Documentation
Request Syntax
response = client.list_skills(
SkillGroupArn='string',
EnablementType='ENABLED'|'PENDING',
SkillType='PUBLIC'|'PRIVATE'|'ALL',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'SkillSummaries': [
{
'SkillId': 'string',
'SkillName': 'string',
'SupportsLinking': True|False,
'EnablementType': 'ENABLED'|'PENDING',
'SkillType': 'PUBLIC'|'PRIVATE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SkillSummaries (list) --
The list of enabled skills requested. Required.
(dict) --
The summary of skills.
SkillId (string) --
The ARN of the skill summary.
SkillName (string) --
The name of the skill.
SupportsLinking (boolean) --
Linking support for a skill.
EnablementType (string) --
Whether the skill is enabled under the user's account, or if it requires linking to be used.
SkillType (string) --
Whether the skill is publicly available or is a private skill.
NextToken (string) --
The token returned to indicate that there is more data available.
Lists all categories in the Alexa skill store.
See also: AWS API Documentation
Request Syntax
response = client.list_skills_store_categories(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'CategoryList': [
{
'CategoryId': 123,
'CategoryName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CategoryList (list) --
The list of categories.
(dict) --
The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.
CategoryId (integer) --
The ID of the skill store category.
CategoryName (string) --
The name of the skill store category.
NextToken (string) --
The tokens used for pagination.
Lists all skills in the Alexa skill store by category.
See also: AWS API Documentation
Request Syntax
response = client.list_skills_store_skills_by_category(
CategoryId=123,
NextToken='string',
MaxResults=123
)
[REQUIRED]
The category ID for which the skills are being retrieved from the skill store.
dict
Response Syntax
{
'SkillsStoreSkills': [
{
'SkillId': 'string',
'SkillName': 'string',
'ShortDescription': 'string',
'IconUrl': 'string',
'SampleUtterances': [
'string',
],
'SkillDetails': {
'ProductDescription': 'string',
'InvocationPhrase': 'string',
'ReleaseDate': 'string',
'EndUserLicenseAgreement': 'string',
'GenericKeywords': [
'string',
],
'BulletPoints': [
'string',
],
'NewInThisVersionBulletPoints': [
'string',
],
'SkillTypes': [
'string',
],
'Reviews': {
'string': 'string'
},
'DeveloperInfo': {
'DeveloperName': 'string',
'PrivacyPolicy': 'string',
'Email': 'string',
'Url': 'string'
}
},
'SupportsLinking': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SkillsStoreSkills (list) --
The skill store skills.
(dict) --
The detailed information about an Alexa skill.
SkillId (string) --
The ARN of the skill.
SkillName (string) --
The name of the skill.
ShortDescription (string) --
Short description about the skill.
IconUrl (string) --
The URL where the skill icon resides.
SampleUtterances (list) --
Sample utterances that interact with the skill.
SkillDetails (dict) --
Information about the skill.
ProductDescription (string) --
The description of the product.
InvocationPhrase (string) --
The phrase used to trigger the skill.
ReleaseDate (string) --
The date when the skill was released.
EndUserLicenseAgreement (string) --
The URL of the end user license agreement.
GenericKeywords (list) --
The generic keywords associated with the skill that can be used to find a skill.
BulletPoints (list) --
The details about what the skill supports organized as bullet points.
NewInThisVersionBulletPoints (list) --
The updates added in bullet points.
SkillTypes (list) --
The types of skills.
Reviews (dict) --
The list of reviews for the skill, including Key and Value pair.
DeveloperInfo (dict) --
The details about the developer that published the skill.
DeveloperName (string) --
The name of the developer.
PrivacyPolicy (string) --
The URL of the privacy policy.
Email (string) --
The email of the developer.
Url (string) --
The website of the developer.
SupportsLinking (boolean) --
Linking support for a skill.
NextToken (string) --
The tokens used for pagination.
Lists all of the smart home appliances associated with a room.
See also: AWS API Documentation
Request Syntax
response = client.list_smart_home_appliances(
RoomArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The room that the appliances are associated with.
dict
Response Syntax
{
'SmartHomeAppliances': [
{
'FriendlyName': 'string',
'Description': 'string',
'ManufacturerName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SmartHomeAppliances (list) --
The smart home appliances.
(dict) --
A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.
FriendlyName (string) --
The friendly name of the smart home appliance.
Description (string) --
The description of the smart home appliance.
ManufacturerName (string) --
The name of the manufacturer of the smart home appliance.
NextToken (string) --
The tokens used for pagination.
Lists all tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
Arn='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of the specified resource for which to list tags.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
The tags requested for the specified resource.
(dict) --
A key-value pair that can be associated with a resource.
Key (string) --
The key of a tag. Tag keys are case-sensitive.
Value (string) --
The value of a tag. Tag values are case-sensitive and can be null.
NextToken (string) --
The token returned to indicate that there is more data available.
Sets the conference preferences on a specific conference provider at the account level.
See also: AWS API Documentation
Request Syntax
response = client.put_conference_preference(
ConferencePreference={
'DefaultConferenceProviderArn': 'string'
}
)
[REQUIRED]
The conference preference of a specific conference provider.
The ARN of the default conference provider.
{}
Response Structure
Configures the email template for the user enrollment invitation with the specified attributes.
See also: AWS API Documentation
Request Syntax
response = client.put_invitation_configuration(
OrganizationName='string',
ContactEmail='string',
PrivateSkillIds=[
'string',
]
)
[REQUIRED]
The name of the organization sending the enrollment invite to a user.
The list of private skill IDs that you want to recommend to the user to enable in the invitation.
dict
Response Syntax
{}
Response Structure
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
See also: AWS API Documentation
Request Syntax
response = client.put_room_skill_parameter(
RoomArn='string',
SkillId='string',
RoomSkillParameter={
'ParameterKey': 'string',
'ParameterValue': 'string'
}
)
[REQUIRED]
The ARN of the skill associated with the room skill parameter. Required.
[REQUIRED]
The updated room skill parameter. Required.
The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
The parameter value of a room skill parameter.
dict
Response Syntax
{}
Response Structure
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.
See also: AWS API Documentation
Request Syntax
response = client.put_skill_authorization(
AuthorizationResult={
'string': 'string'
},
SkillId='string',
RoomArn='string'
)
[REQUIRED]
The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.
[REQUIRED]
The unique identifier of a skill.
dict
Response Syntax
{}
Response Structure
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
See also: AWS API Documentation
Request Syntax
response = client.register_avs_device(
ClientId='string',
UserCode='string',
ProductId='string',
DeviceSerialNumber='string',
AmazonId='string'
)
[REQUIRED]
The client ID of the OEM used for code-based linking authorization on an AVS device.
[REQUIRED]
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.
[REQUIRED]
The product ID used to identify your AVS device during authorization.
[REQUIRED]
The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
[REQUIRED]
The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
dict
Response Syntax
{
'DeviceArn': 'string'
}
Response Structure
(dict) --
DeviceArn (string) --
The ARN of the device.
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.
See also: AWS API Documentation
Request Syntax
response = client.reject_skill(
SkillId='string'
)
[REQUIRED]
The unique identifier of the skill.
{}
Response Structure
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
See also: AWS API Documentation
Request Syntax
response = client.resolve_room(
UserId='string',
SkillId='string'
)
[REQUIRED]
The ARN of the user. Required.
[REQUIRED]
The ARN of the skill that was requested. Required.
dict
Response Syntax
{
'RoomArn': 'string',
'RoomName': 'string',
'RoomSkillParameters': [
{
'ParameterKey': 'string',
'ParameterValue': 'string'
},
]
}
Response Structure
(dict) --
RoomArn (string) --
The ARN of the room from which the skill request was invoked.
RoomName (string) --
The name of the room from which the skill request was invoked.
RoomSkillParameters (list) --
Response to get the room profile request. Required.
(dict) --
A skill parameter associated with a room.
ParameterKey (string) --
The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
ParameterValue (string) --
The parameter value of a room skill parameter.
Revokes an invitation and invalidates the enrollment URL.
See also: AWS API Documentation
Request Syntax
response = client.revoke_invitation(
UserArn='string',
EnrollmentId='string'
)
dict
Response Syntax
{}
Response Structure
Searches address books and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_address_books(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
NextToken='string',
MaxResults=123
)
The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'AddressBooks': [
{
'AddressBookArn': 'string',
'Name': 'string',
'Description': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
AddressBooks (list) --
The address books that meet the specified set of filter criteria, in sort order.
(dict) --
Information related to an address book.
AddressBookArn (string) --
The ARN of the address book.
Name (string) --
The name of the address book.
Description (string) --
The description of the address book.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of address books returned.
Searches contacts and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_contacts(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
NextToken='string',
MaxResults=123
)
The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Contacts': [
{
'ContactArn': 'string',
'DisplayName': 'string',
'FirstName': 'string',
'LastName': 'string',
'PhoneNumber': 'string',
'PhoneNumbers': [
{
'Number': 'string',
'Type': 'MOBILE'|'WORK'|'HOME'
},
],
'SipAddresses': [
{
'Uri': 'string',
'Type': 'WORK'
},
]
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Contacts (list) --
The contacts that meet the specified set of filter criteria, in sort order.
(dict) --
Information related to a contact.
ContactArn (string) --
The ARN of the contact.
DisplayName (string) --
The name of the contact to display on the console.
FirstName (string) --
The first name of the contact, used to call the contact on the device.
LastName (string) --
The last name of the contact, used to call the contact on the device.
PhoneNumber (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 (list) --
The list of phone numbers for the contact.
(dict) --
The phone number for the contact containing the raw number and phone number type.
Number (string) --
The raw value of the phone number.
Type (string) --
The type of the phone number.
SipAddresses (list) --
The list of SIP addresses for the contact.
(dict) --
The SIP address for the contact containing the URI and SIP address type.
Uri (string) --
The URI for the SIP address.
Type (string) --
The type of the SIP address.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of contacts returned.
Searches devices and lists the ones that meet a set of filter criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_devices(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
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.
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.
The key of a filter.
The values of a filter.
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.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Devices': [
{
'DeviceArn': 'string',
'DeviceSerialNumber': 'string',
'DeviceType': 'string',
'DeviceName': 'string',
'SoftwareVersion': 'string',
'MacAddress': 'string',
'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED'|'FAILED',
'NetworkProfileArn': 'string',
'NetworkProfileName': 'string',
'RoomArn': 'string',
'RoomName': 'string',
'DeviceStatusInfo': {
'DeviceStatusDetails': [
{
'Feature': 'BLUETOOTH'|'VOLUME'|'NOTIFICATIONS'|'LISTS'|'SKILLS'|'NETWORK_PROFILE'|'SETTINGS'|'ALL',
'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'
},
],
'ConnectionStatus': 'ONLINE'|'OFFLINE'
}
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Devices (list) --
The devices that meet the specified set of filter criteria, in sort order.
(dict) --
Device attributes.
DeviceArn (string) --
The ARN of a device.
DeviceSerialNumber (string) --
The serial number of a device.
DeviceType (string) --
The type of a device.
DeviceName (string) --
The name of a device.
SoftwareVersion (string) --
The software version of a device.
MacAddress (string) --
The MAC address of a device.
DeviceStatus (string) --
The status of a device.
NetworkProfileArn (string) --
The ARN of the network profile associated with a device.
NetworkProfileName (string) --
The name of the network profile associated with a device.
RoomArn (string) --
The room ARN associated with a device.
RoomName (string) --
The name of the room associated with a device.
DeviceStatusInfo (dict) --
Detailed information about a device's status.
DeviceStatusDetails (list) --
One or more device status detail descriptions.
(dict) --
Details of a device’s status.
Feature (string) --
The list of available features on the device.
Code (string) --
The device status detail code.
ConnectionStatus (string) --
The latest available information about the connection status of a device.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of devices returned.
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_network_profiles(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.
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.
The key of a filter.
The values of a filter.
The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'NetworkProfiles': [
{
'NetworkProfileArn': 'string',
'NetworkProfileName': 'string',
'Description': 'string',
'Ssid': 'string',
'SecurityType': 'OPEN'|'WEP'|'WPA_PSK'|'WPA2_PSK'|'WPA2_ENTERPRISE',
'EapMethod': 'EAP_TLS',
'CertificateAuthorityArn': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
NetworkProfiles (list) --
The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.
(dict) --
The data associated with a network profile.
NetworkProfileArn (string) --
The ARN of the network profile associated with a device.
NetworkProfileName (string) --
The name of the network profile associated with a device.
Description (string) --
Detailed information about a device's network profile.
Ssid (string) --
The SSID of the Wi-Fi network.
SecurityType (string) --
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
EapMethod (string) --
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
CertificateAuthorityArn (string) --
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
NextToken (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 (integer) --
The total number of network profiles returned.
Searches room profiles and lists the ones that meet a set of filter criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_profiles(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Profiles': [
{
'ProfileArn': 'string',
'ProfileName': 'string',
'IsDefault': True|False,
'Address': 'string',
'Timezone': 'string',
'DistanceUnit': 'METRIC'|'IMPERIAL',
'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Profiles (list) --
The profiles that meet the specified set of filter criteria, in sort order.
(dict) --
The data of a room profile.
ProfileArn (string) --
The ARN of a room profile.
ProfileName (string) --
The name of a room profile.
IsDefault (boolean) --
Retrieves if the profile data is default or not.
Address (string) --
The address of a room profile.
Timezone (string) --
The timezone of a room profile.
DistanceUnit (string) --
The distance unit of a room profile.
TemperatureUnit (string) --
The temperature unit of a room profile.
WakeWord (string) --
The wake word of a room profile.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of room profiles returned.
Searches rooms and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_rooms(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Rooms': [
{
'RoomArn': 'string',
'RoomName': 'string',
'Description': 'string',
'ProviderCalendarId': 'string',
'ProfileArn': 'string',
'ProfileName': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Rooms (list) --
The rooms that meet the specified set of filter criteria, in sort order.
(dict) --
The data of a room.
RoomArn (string) --
The ARN of a room.
RoomName (string) --
The name of a room.
Description (string) --
The description of a room.
ProviderCalendarId (string) --
The provider calendar ARN of a room.
ProfileArn (string) --
The profile ARN of a room.
ProfileName (string) --
The profile name of a room.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of rooms returned.
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_skill_groups(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'SkillGroups': [
{
'SkillGroupArn': 'string',
'SkillGroupName': 'string',
'Description': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
SkillGroups (list) --
The skill groups that meet the filter criteria, in sort order.
(dict) --
The attributes of a skill group.
SkillGroupArn (string) --
The skill group ARN of a skill group.
SkillGroupName (string) --
The skill group name of a skill group.
Description (string) --
The description of a skill group.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of skill groups returned.
Searches users and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_users(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Users': [
{
'UserArn': 'string',
'FirstName': 'string',
'LastName': 'string',
'Email': 'string',
'EnrollmentStatus': 'INITIALIZED'|'PENDING'|'REGISTERED'|'DISASSOCIATING'|'DEREGISTERING',
'EnrollmentId': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Users (list) --
The users that meet the specified set of filter criteria, in sort order.
(dict) --
Information related to a user.
UserArn (string) --
The ARN of a user.
FirstName (string) --
The first name of a user.
LastName (string) --
The last name of a user.
Email (string) --
The email of a user.
EnrollmentStatus (string) --
The enrollment status of a user.
EnrollmentId (string) --
The enrollment ARN of a user.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of users returned.
Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
See also: AWS API Documentation
Request Syntax
response = client.send_announcement(
RoomFilters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
Content={
'TextList': [
{
'Locale': 'en-US',
'Value': 'string'
},
],
'SsmlList': [
{
'Locale': 'en-US',
'Value': 'string'
},
],
'AudioList': [
{
'Locale': 'en-US',
'Location': 'string'
},
]
},
TimeToLiveInSeconds=123,
ClientRequestToken='string'
)
[REQUIRED]
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.
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.
The key of a filter.
The values of a filter.
[REQUIRED]
The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
The list of text messages.
The text message.
The locale of the text message. Currently, en-US is supported.
The value of the text message.
The list of SSML messages.
The SSML message. For more information, see SSML Reference .
The locale of the SSML message. Currently, en-US is supported.
The value of the SSML message in the correct SSML format. The audio tag is not supported.
The list of audio messages.
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>
The locale of the audio message. Currently, en-US is supported.
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 .
[REQUIRED]
The unique, user-specified identifier for the request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'AnnouncementArn': 'string'
}
Response Structure
(dict) --
AnnouncementArn (string) --
The identifier of the announcement.
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.
See also: AWS API Documentation
Request Syntax
response = client.send_invitation(
UserArn='string'
)
{}
Response Structure
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:
See also: AWS API Documentation
Request Syntax
response = client.start_device_sync(
RoomArn='string',
DeviceArn='string',
Features=[
'BLUETOOTH'|'VOLUME'|'NOTIFICATIONS'|'LISTS'|'SKILLS'|'NETWORK_PROFILE'|'SETTINGS'|'ALL',
]
)
[REQUIRED]
Request structure to start the device sync. Required.
dict
Response Syntax
{}
Response Structure
Initiates the discovery of any smart home appliances associated with the room.
See also: AWS API Documentation
Request Syntax
response = client.start_smart_home_appliance_discovery(
RoomArn='string'
)
[REQUIRED]
The room where smart home appliance discovery was initiated.
{}
Response Structure
Adds metadata tags to a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
Arn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN of the resource to which to add metadata tags. Required.
[REQUIRED]
The tags to be added to the specified resource. Do not provide system tags. Required.
A key-value pair that can be associated with a resource.
The key of a tag. Tag keys are case-sensitive.
The value of a tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{}
Response Structure
Removes metadata tags from a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
Arn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource from which to remove metadata tags. Required.
[REQUIRED]
The tags to be removed from the specified resource. Do not provide system tags. Required.
dict
Response Syntax
{}
Response Structure
Updates address book details by the address book ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_address_book(
AddressBookArn='string',
Name='string',
Description='string'
)
[REQUIRED]
The ARN of the room to update.
dict
Response Syntax
{}
Response Structure
Updates the configuration of the report delivery schedule with the specified schedule ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_business_report_schedule(
ScheduleArn='string',
S3BucketName='string',
S3KeyPrefix='string',
Format='CSV'|'CSV_ZIP',
ScheduleName='string',
Recurrence={
'StartDate': 'string'
}
)
[REQUIRED]
The ARN of the business report schedule.
The recurrence of the reports.
The start date.
dict
Response Syntax
{}
Response Structure
Updates an existing conference provider's settings.
See also: AWS API Documentation
Request Syntax
response = client.update_conference_provider(
ConferenceProviderArn='string',
ConferenceProviderType='CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
IPDialIn={
'Endpoint': 'string',
'CommsProtocol': 'SIP'|'SIPS'|'H323'
},
PSTNDialIn={
'CountryCode': 'string',
'PhoneNumber': 'string',
'OneClickIdDelay': 'string',
'OneClickPinDelay': 'string'
},
MeetingSetting={
'RequirePin': 'YES'|'NO'|'OPTIONAL'
}
)
[REQUIRED]
The ARN of the conference provider.
[REQUIRED]
The type of the conference provider.
The IP endpoint and protocol for calling.
The IP address.
The protocol, including SIP, SIPS, and H323.
The information for PSTN conferencing.
The zip code.
The phone number to call to join the conference.
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.
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.
[REQUIRED]
The meeting settings for the conference provider.
The values that indicate whether the pin is always required.
dict
Response Syntax
{}
Response Structure
Updates the contact details by the contact ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_contact(
ContactArn='string',
DisplayName='string',
FirstName='string',
LastName='string',
PhoneNumber='string',
PhoneNumbers=[
{
'Number': 'string',
'Type': 'MOBILE'|'WORK'|'HOME'
},
],
SipAddresses=[
{
'Uri': 'string',
'Type': 'WORK'
},
]
)
[REQUIRED]
The ARN of the contact to update.
The list of phone numbers for the contact.
The phone number for the contact containing the raw number and phone number type.
The raw value of the phone number.
The type of the phone number.
The list of SIP addresses for the contact.
The SIP address for the contact containing the URI and SIP address type.
The URI for the SIP address.
The type of the SIP address.
dict
Response Syntax
{}
Response Structure
Updates the device name by device ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_device(
DeviceArn='string',
DeviceName='string'
)
dict
Response Syntax
{}
Response Structure
Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
See also: AWS API Documentation
Request Syntax
response = client.update_gateway(
GatewayArn='string',
Name='string',
Description='string',
SoftwareVersion='string'
)
[REQUIRED]
The ARN of the gateway to update.
dict
Response Syntax
{}
Response Structure
Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
See also: AWS API Documentation
Request Syntax
response = client.update_gateway_group(
GatewayGroupArn='string',
Name='string',
Description='string'
)
[REQUIRED]
The ARN of the gateway group to update.
dict
Response Syntax
{}
Response Structure
Updates a network profile by the network profile ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_network_profile(
NetworkProfileArn='string',
NetworkProfileName='string',
Description='string',
CurrentPassword='string',
NextPassword='string',
CertificateAuthorityArn='string',
TrustAnchors=[
'string',
]
)
[REQUIRED]
The ARN of the network profile associated with a device.
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.
dict
Response Syntax
{}
Response Structure
Updates an existing room profile by room profile ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_profile(
ProfileArn='string',
ProfileName='string',
IsDefault=True|False,
Timezone='string',
Address='string',
DistanceUnit='METRIC'|'IMPERIAL',
TemperatureUnit='FAHRENHEIT'|'CELSIUS',
WakeWord='ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
SetupModeDisabled=True|False,
MaxVolumeLimit=123,
PSTNEnabled=True|False
)
dict
Response Syntax
{}
Response Structure
Updates room details by room ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_room(
RoomArn='string',
RoomName='string',
Description='string',
ProviderCalendarId='string',
ProfileArn='string'
)
dict
Response Syntax
{}
Response Structure
Updates skill group details by skill group ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_skill_group(
SkillGroupArn='string',
SkillGroupName='string',
Description='string'
)
dict
Response Syntax
{}
Response Structure
The available paginators are:
paginator = client.get_paginator('list_business_report_schedules')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_business_report_schedules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'BusinessReportSchedules': [
{
'ScheduleArn': 'string',
'ScheduleName': 'string',
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Format': 'CSV'|'CSV_ZIP',
'ContentRange': {
'Interval': 'ONE_DAY'|'ONE_WEEK'
},
'Recurrence': {
'StartDate': 'string'
},
'LastBusinessReport': {
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED',
'FailureCode': 'ACCESS_DENIED'|'NO_SUCH_BUCKET'|'INTERNAL_FAILURE',
'S3Location': {
'Path': 'string',
'BucketName': 'string'
},
'DeliveryTime': datetime(2015, 1, 1),
'DownloadUrl': 'string'
}
},
],
}
Response Structure
The schedule of the reports.
The schedule of the usage report.
The ARN of the business report schedule.
The name identifier of the schedule.
The S3 bucket name of the output reports.
The S3 key where the report is delivered.
The format of the generated report (individual CSV files or zipped files of individual files).
The content range of the reports.
The interval of the content range.
The recurrence of the reports.
The start date.
The details of the last business report delivery for a specified time interval.
The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
The failure code.
The S3 location of the output reports.
The path of the business report.
The S3 bucket name of the output reports.
The time of report delivery.
The download link where a user can download the report.
paginator = client.get_paginator('list_conference_providers')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_conference_providers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'ConferenceProviders': [
{
'Arn': 'string',
'Name': 'string',
'Type': 'CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
'IPDialIn': {
'Endpoint': 'string',
'CommsProtocol': 'SIP'|'SIPS'|'H323'
},
'PSTNDialIn': {
'CountryCode': 'string',
'PhoneNumber': 'string',
'OneClickIdDelay': 'string',
'OneClickPinDelay': 'string'
},
'MeetingSetting': {
'RequirePin': 'YES'|'NO'|'OPTIONAL'
}
},
],
}
Response Structure
The conference providers.
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.
The ARN of the newly created conference provider.
The name of the conference provider.
The type of conference providers.
The IP endpoint and protocol for calling.
The IP address.
The protocol, including SIP, SIPS, and H323.
The information for PSTN conferencing.
The zip code.
The phone number to call to join the conference.
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.
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.
The meeting settings for the conference provider.
The values that indicate whether the pin is always required.
paginator = client.get_paginator('list_device_events')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_device_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DeviceArn='string',
EventType='CONNECTION_STATUS'|'DEVICE_STATUS',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of a device.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DeviceEvents': [
{
'Type': 'CONNECTION_STATUS'|'DEVICE_STATUS',
'Value': 'string',
'Timestamp': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
DeviceEvents (list) --
The device events requested for the device ARN.
(dict) --
The list of device events.
Type (string) --
The type of device event.
Value (string) --
The value of the event.
Timestamp (datetime) --
The time (in epoch) when the event occurred.
paginator = client.get_paginator('list_skills')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_skills().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SkillGroupArn='string',
EnablementType='ENABLED'|'PENDING',
SkillType='PUBLIC'|'PRIVATE'|'ALL',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SkillSummaries': [
{
'SkillId': 'string',
'SkillName': 'string',
'SupportsLinking': True|False,
'EnablementType': 'ENABLED'|'PENDING',
'SkillType': 'PUBLIC'|'PRIVATE'
},
],
}
Response Structure
(dict) --
SkillSummaries (list) --
The list of enabled skills requested. Required.
(dict) --
The summary of skills.
SkillId (string) --
The ARN of the skill summary.
SkillName (string) --
The name of the skill.
SupportsLinking (boolean) --
Linking support for a skill.
EnablementType (string) --
Whether the skill is enabled under the user's account, or if it requires linking to be used.
SkillType (string) --
Whether the skill is publicly available or is a private skill.
paginator = client.get_paginator('list_skills_store_categories')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_skills_store_categories().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'CategoryList': [
{
'CategoryId': 123,
'CategoryName': 'string'
},
],
}
Response Structure
The list of categories.
The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.
The ID of the skill store category.
The name of the skill store category.
paginator = client.get_paginator('list_skills_store_skills_by_category')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_skills_store_skills_by_category().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CategoryId=123,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The category ID for which the skills are being retrieved from the skill store.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SkillsStoreSkills': [
{
'SkillId': 'string',
'SkillName': 'string',
'ShortDescription': 'string',
'IconUrl': 'string',
'SampleUtterances': [
'string',
],
'SkillDetails': {
'ProductDescription': 'string',
'InvocationPhrase': 'string',
'ReleaseDate': 'string',
'EndUserLicenseAgreement': 'string',
'GenericKeywords': [
'string',
],
'BulletPoints': [
'string',
],
'NewInThisVersionBulletPoints': [
'string',
],
'SkillTypes': [
'string',
],
'Reviews': {
'string': 'string'
},
'DeveloperInfo': {
'DeveloperName': 'string',
'PrivacyPolicy': 'string',
'Email': 'string',
'Url': 'string'
}
},
'SupportsLinking': True|False
},
],
}
Response Structure
(dict) --
SkillsStoreSkills (list) --
The skill store skills.
(dict) --
The detailed information about an Alexa skill.
SkillId (string) --
The ARN of the skill.
SkillName (string) --
The name of the skill.
ShortDescription (string) --
Short description about the skill.
IconUrl (string) --
The URL where the skill icon resides.
SampleUtterances (list) --
Sample utterances that interact with the skill.
SkillDetails (dict) --
Information about the skill.
ProductDescription (string) --
The description of the product.
InvocationPhrase (string) --
The phrase used to trigger the skill.
ReleaseDate (string) --
The date when the skill was released.
EndUserLicenseAgreement (string) --
The URL of the end user license agreement.
GenericKeywords (list) --
The generic keywords associated with the skill that can be used to find a skill.
BulletPoints (list) --
The details about what the skill supports organized as bullet points.
NewInThisVersionBulletPoints (list) --
The updates added in bullet points.
SkillTypes (list) --
The types of skills.
Reviews (dict) --
The list of reviews for the skill, including Key and Value pair.
DeveloperInfo (dict) --
The details about the developer that published the skill.
DeveloperName (string) --
The name of the developer.
PrivacyPolicy (string) --
The URL of the privacy policy.
Email (string) --
The email of the developer.
Url (string) --
The website of the developer.
SupportsLinking (boolean) --
Linking support for a skill.
paginator = client.get_paginator('list_smart_home_appliances')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_smart_home_appliances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
RoomArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The room that the appliances are associated with.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SmartHomeAppliances': [
{
'FriendlyName': 'string',
'Description': 'string',
'ManufacturerName': 'string'
},
],
}
Response Structure
(dict) --
SmartHomeAppliances (list) --
The smart home appliances.
(dict) --
A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.
FriendlyName (string) --
The friendly name of the smart home appliance.
Description (string) --
The description of the smart home appliance.
ManufacturerName (string) --
The name of the manufacturer of the smart home appliance.
paginator = client.get_paginator('list_tags')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_tags().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Arn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the specified resource for which to list tags.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
}
Response Structure
(dict) --
Tags (list) --
The tags requested for the specified resource.
(dict) --
A key-value pair that can be associated with a resource.
Key (string) --
The key of a tag. Tag keys are case-sensitive.
Value (string) --
The value of a tag. Tag values are case-sensitive and can be null.
paginator = client.get_paginator('search_devices')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_devices().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
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.
The key of a filter.
The values of a filter.
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.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Devices': [
{
'DeviceArn': 'string',
'DeviceSerialNumber': 'string',
'DeviceType': 'string',
'DeviceName': 'string',
'SoftwareVersion': 'string',
'MacAddress': 'string',
'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED'|'FAILED',
'NetworkProfileArn': 'string',
'NetworkProfileName': 'string',
'RoomArn': 'string',
'RoomName': 'string',
'DeviceStatusInfo': {
'DeviceStatusDetails': [
{
'Feature': 'BLUETOOTH'|'VOLUME'|'NOTIFICATIONS'|'LISTS'|'SKILLS'|'NETWORK_PROFILE'|'SETTINGS'|'ALL',
'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'
},
],
'ConnectionStatus': 'ONLINE'|'OFFLINE'
}
},
],
'TotalCount': 123
}
Response Structure
(dict) --
Devices (list) --
The devices that meet the specified set of filter criteria, in sort order.
(dict) --
Device attributes.
DeviceArn (string) --
The ARN of a device.
DeviceSerialNumber (string) --
The serial number of a device.
DeviceType (string) --
The type of a device.
DeviceName (string) --
The name of a device.
SoftwareVersion (string) --
The software version of a device.
MacAddress (string) --
The MAC address of a device.
DeviceStatus (string) --
The status of a device.
NetworkProfileArn (string) --
The ARN of the network profile associated with a device.
NetworkProfileName (string) --
The name of the network profile associated with a device.
RoomArn (string) --
The room ARN associated with a device.
RoomName (string) --
The name of the room associated with a device.
DeviceStatusInfo (dict) --
Detailed information about a device's status.
DeviceStatusDetails (list) --
One or more device status detail descriptions.
(dict) --
Details of a device’s status.
Feature (string) --
The list of available features on the device.
Code (string) --
The device status detail code.
ConnectionStatus (string) --
The latest available information about the connection status of a device.
TotalCount (integer) --
The total number of devices returned.
paginator = client.get_paginator('search_profiles')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Profiles': [
{
'ProfileArn': 'string',
'ProfileName': 'string',
'IsDefault': True|False,
'Address': 'string',
'Timezone': 'string',
'DistanceUnit': 'METRIC'|'IMPERIAL',
'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER'
},
],
'TotalCount': 123
}
Response Structure
(dict) --
Profiles (list) --
The profiles that meet the specified set of filter criteria, in sort order.
(dict) --
The data of a room profile.
ProfileArn (string) --
The ARN of a room profile.
ProfileName (string) --
The name of a room profile.
IsDefault (boolean) --
Retrieves if the profile data is default or not.
Address (string) --
The address of a room profile.
Timezone (string) --
The timezone of a room profile.
DistanceUnit (string) --
The distance unit of a room profile.
TemperatureUnit (string) --
The temperature unit of a room profile.
WakeWord (string) --
The wake word of a room profile.
TotalCount (integer) --
The total number of room profiles returned.
paginator = client.get_paginator('search_rooms')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_rooms().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Rooms': [
{
'RoomArn': 'string',
'RoomName': 'string',
'Description': 'string',
'ProviderCalendarId': 'string',
'ProfileArn': 'string',
'ProfileName': 'string'
},
],
'TotalCount': 123
}
Response Structure
(dict) --
Rooms (list) --
The rooms that meet the specified set of filter criteria, in sort order.
(dict) --
The data of a room.
RoomArn (string) --
The ARN of a room.
RoomName (string) --
The name of a room.
Description (string) --
The description of a room.
ProviderCalendarId (string) --
The provider calendar ARN of a room.
ProfileArn (string) --
The profile ARN of a room.
ProfileName (string) --
The profile name of a room.
TotalCount (integer) --
The total number of rooms returned.
paginator = client.get_paginator('search_skill_groups')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_skill_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SkillGroups': [
{
'SkillGroupArn': 'string',
'SkillGroupName': 'string',
'Description': 'string'
},
],
'TotalCount': 123
}
Response Structure
(dict) --
SkillGroups (list) --
The skill groups that meet the filter criteria, in sort order.
(dict) --
The attributes of a skill group.
SkillGroupArn (string) --
The skill group ARN of a skill group.
SkillGroupName (string) --
The skill group name of a skill group.
Description (string) --
The description of a skill group.
TotalCount (integer) --
The total number of skill groups returned.
paginator = client.get_paginator('search_users')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_users().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
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.
The key of a filter.
The values of a filter.
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Users': [
{
'UserArn': 'string',
'FirstName': 'string',
'LastName': 'string',
'Email': 'string',
'EnrollmentStatus': 'INITIALIZED'|'PENDING'|'REGISTERED'|'DISASSOCIATING'|'DEREGISTERING',
'EnrollmentId': 'string'
},
],
'TotalCount': 123
}
Response Structure
(dict) --
Users (list) --
The users that meet the specified set of filter criteria, in sort order.
(dict) --
Information related to a user.
UserArn (string) --
The ARN of a user.
FirstName (string) --
The first name of a user.
LastName (string) --
The last name of a user.
Email (string) --
The email of a user.
EnrollmentStatus (string) --
The enrollment status of a user.
EnrollmentId (string) --
The enrollment ARN of a user.
TotalCount (integer) --
The total number of users returned.