AlexaForBusiness

Table of Contents

Client

class AlexaForBusiness.Client

A low-level client representing Alexa For Business

Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.

import boto3

client = boto3.client('alexaforbusiness')

These are the available methods:

approve_skill(**kwargs)

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'
)
Parameters
SkillId (string) --

[REQUIRED]

The unique identifier of the skill.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.LimitExceededException
  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
associate_contact_with_address_book(**kwargs)

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'
)
Parameters
  • ContactArn (string) --

    [REQUIRED]

    The ARN of the contact to associate with an address book.

  • AddressBookArn (string) --

    [REQUIRED]

    The ARN of the address book with which to associate the contact.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.LimitExceededException
associate_device_with_network_profile(**kwargs)

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'
)
Parameters
  • DeviceArn (string) --

    [REQUIRED]

    The device ARN.

  • NetworkProfileArn (string) --

    [REQUIRED]

    The ARN of the network profile to associate with a device.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.DeviceNotRegisteredException
associate_device_with_room(**kwargs)

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'
)
Parameters
  • DeviceArn (string) -- The ARN of the device to associate to a room. Required.
  • RoomArn (string) -- The ARN of the room with which to associate the device. Required.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.LimitExceededException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.DeviceNotRegisteredException
associate_skill_group_with_room(**kwargs)

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'
)
Parameters
  • SkillGroupArn (string) -- The ARN of the skill group to associate with a room. Required.
  • RoomArn (string) -- The ARN of the room with which to associate the skill group. Required.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
associate_skill_with_skill_group(**kwargs)

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'
)
Parameters
  • SkillGroupArn (string) -- The ARN of the skill group to associate the skill to. Required.
  • SkillId (string) --

    [REQUIRED]

    The unique identifier of the skill.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.SkillNotLinkedException
associate_skill_with_users(**kwargs)

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'
)
Parameters
SkillId (string) --

[REQUIRED]

The private skill ID you want to make available to enrolled users.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.NotFoundException
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_address_book(**kwargs)

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'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the address book.

  • Description (string) -- The description of the address book.
  • ClientRequestToken (string) --

    A unique, user-specified identifier for the request that ensures idempotency.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'AddressBookArn': 'string'
}

Response Structure

  • (dict) --

    • AddressBookArn (string) --

      The ARN of the newly created address book.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
  • AlexaForBusiness.Client.exceptions.LimitExceededException
create_business_report_schedule(**kwargs)

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'|'THIRTY_DAYS'
    },
    Recurrence={
        'StartDate': 'string'
    },
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ScheduleName (string) -- The name identifier of the schedule.
  • S3BucketName (string) -- The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.
  • S3KeyPrefix (string) -- The S3 key where the report is delivered.
  • Format (string) --

    [REQUIRED]

    The format of the generated report (individual CSV files or zipped files of individual files).

  • ContentRange (dict) --

    [REQUIRED]

    The content range of the reports.

    • Interval (string) -- [REQUIRED]

      The interval of the content range.

  • Recurrence (dict) --

    The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

    • StartDate (string) --

      The start date.

  • ClientRequestToken (string) --

    The client request token.

    This field is autopopulated if not provided.

  • Tags (list) --

    The tags for the business report schedule.

    • (dict) --

      A key-value pair that can be associated with a resource.

      • Key (string) -- [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) -- [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type

dict

Returns

Response Syntax

{
    'ScheduleArn': 'string'
}

Response Structure

  • (dict) --

    • ScheduleArn (string) --

      The ARN of the business report schedule.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
create_conference_provider(**kwargs)

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'
)
Parameters
  • ConferenceProviderName (string) --

    [REQUIRED]

    The name of the conference provider.

  • ConferenceProviderType (string) --

    [REQUIRED]

    Represents a type within a list of predefined types.

  • IPDialIn (dict) --

    The IP endpoint and protocol for calling.

    • Endpoint (string) -- [REQUIRED]

      The IP address.

    • CommsProtocol (string) -- [REQUIRED]

      The protocol, including SIP, SIPS, and H323.

  • PSTNDialIn (dict) --

    The information for PSTN conferencing.

    • CountryCode (string) -- [REQUIRED]

      The zip code.

    • PhoneNumber (string) -- [REQUIRED]

      The phone number to call to join the conference.

    • OneClickIdDelay (string) -- [REQUIRED]

      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) -- [REQUIRED]

      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) --

    [REQUIRED]

    The meeting settings for the conference provider.

    • RequirePin (string) -- [REQUIRED]

      The values that indicate whether the pin is always required.

  • ClientRequestToken (string) --

    The request token of the client.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'ConferenceProviderArn': 'string'
}

Response Structure

  • (dict) --

    • ConferenceProviderArn (string) --

      The ARN of the newly-created conference provider.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
create_contact(**kwargs)

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'
)
Parameters
  • DisplayName (string) -- The name of the contact to display on the console.
  • FirstName (string) --

    [REQUIRED]

    The first name of the contact that is used to call the contact on the device.

  • LastName (string) -- The last name of the contact that is used to call the contact on the device.
  • PhoneNumber (string) -- The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
  • PhoneNumbers (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) -- [REQUIRED]

        The raw value of the phone number.

      • Type (string) -- [REQUIRED]

        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) -- [REQUIRED]

        The URI for the SIP address.

      • Type (string) -- [REQUIRED]

        The type of the SIP address.

  • ClientRequestToken (string) --

    A unique, user-specified identifier for this request that ensures idempotency.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'ContactArn': 'string'
}

Response Structure

  • (dict) --

    • ContactArn (string) --

      The ARN of the newly created address book.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
  • AlexaForBusiness.Client.exceptions.LimitExceededException
create_gateway_group(**kwargs)

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'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the gateway group.

  • Description (string) -- The description of the gateway group.
  • ClientRequestToken (string) --

    [REQUIRED]

    A unique, user-specified identifier for the request that ensures idempotency.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'GatewayGroupArn': 'string'
}

Response Structure

  • (dict) --

    • GatewayGroupArn (string) --

      The ARN of the created gateway group.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
  • AlexaForBusiness.Client.exceptions.LimitExceededException
create_network_profile(**kwargs)

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'
)
Parameters
  • NetworkProfileName (string) --

    [REQUIRED]

    The name of the network profile associated with a device.

  • Description (string) -- Detailed information about a device's network profile.
  • Ssid (string) --

    [REQUIRED]

    The SSID of the Wi-Fi network.

  • SecurityType (string) --

    [REQUIRED]

    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.
  • CurrentPassword (string) -- The current password of the Wi-Fi network.
  • NextPassword (string) -- The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
  • 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.
  • TrustAnchors (list) --

    The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

    • (string) --
  • ClientRequestToken (string) --

    [REQUIRED]

    A unique, user-specified identifier for the request that ensures idempotency.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'NetworkProfileArn': 'string'
}

Response Structure

  • (dict) --

    • NetworkProfileArn (string) --

      The ARN of the network profile associated with a device.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
  • AlexaForBusiness.Client.exceptions.LimitExceededException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.InvalidCertificateAuthorityException
  • AlexaForBusiness.Client.exceptions.InvalidServiceLinkedRoleStateException
create_profile(**kwargs)

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',
    Locale='string',
    ClientRequestToken='string',
    SetupModeDisabled=True|False,
    MaxVolumeLimit=123,
    PSTNEnabled=True|False,
    MeetingRoomConfiguration={
        'RoomUtilizationMetricsEnabled': True|False,
        'EndOfMeetingReminder': {
            'ReminderAtMinutes': [
                123,
            ],
            'ReminderType': 'ANNOUNCEMENT_TIME_CHECK'|'ANNOUNCEMENT_VARIABLE_TIME_LEFT'|'CHIME'|'KNOCK',
            'Enabled': True|False
        },
        'InstantBooking': {
            'DurationInMinutes': 123,
            'Enabled': True|False
        },
        'RequireCheckIn': {
            'ReleaseAfterMinutes': 123,
            'Enabled': True|False
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ProfileName (string) --

    [REQUIRED]

    The name of a room profile.

  • Timezone (string) --

    [REQUIRED]

    The time zone used by a room profile.

  • Address (string) --

    [REQUIRED]

    The valid address for the room.

  • DistanceUnit (string) --

    [REQUIRED]

    The distance unit to be used by devices in the profile.

  • TemperatureUnit (string) --

    [REQUIRED]

    The temperature unit to be used by devices in the profile.

  • WakeWord (string) --

    [REQUIRED]

    A wake word for Alexa, Echo, Amazon, or a computer.

  • Locale (string) -- The locale of the room profile. (This is currently only available to a limited preview audience.)
  • ClientRequestToken (string) --

    The user-specified token that is used during the creation of a profile.

    This field is autopopulated if not provided.

  • SetupModeDisabled (boolean) -- Whether room profile setup is enabled.
  • MaxVolumeLimit (integer) -- The maximum volume limit for a room profile.
  • PSTNEnabled (boolean) -- Whether PSTN calling is enabled.
  • MeetingRoomConfiguration (dict) --

    The meeting room settings of a room profile.

    • RoomUtilizationMetricsEnabled (boolean) --

      Whether room utilization metrics are enabled or not.

    • EndOfMeetingReminder (dict) --

      Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

      • ReminderAtMinutes (list) -- [REQUIRED]

        A range of 3 to 15 minutes that determines when the reminder begins.

        • (integer) --
      • ReminderType (string) -- [REQUIRED]

        The type of sound that users hear during the end of meeting reminder.

      • Enabled (boolean) -- [REQUIRED]

        Whether an end of meeting reminder is enabled or not.

    • InstantBooking (dict) --

      Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.

      • DurationInMinutes (integer) -- [REQUIRED]

        Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

      • Enabled (boolean) -- [REQUIRED]

        Whether instant booking is enabled or not.

    • RequireCheckIn (dict) --

      Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

      • ReleaseAfterMinutes (integer) -- [REQUIRED]

        Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

      • Enabled (boolean) -- [REQUIRED]

        Whether require check in is enabled or not.

  • Tags (list) --

    The tags for the profile.

    • (dict) --

      A key-value pair that can be associated with a resource.

      • Key (string) -- [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) -- [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type

dict

Returns

Response Syntax

{
    'ProfileArn': 'string'
}

Response Structure

  • (dict) --

    • ProfileArn (string) --

      The ARN of the newly created room profile in the response.

Exceptions

  • AlexaForBusiness.Client.exceptions.LimitExceededException
  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
create_room(**kwargs)

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'
        },
    ]
)
Parameters
  • RoomName (string) --

    [REQUIRED]

    The name for the room.

  • Description (string) -- The description for the room.
  • ProfileArn (string) -- The profile ARN for the room. This is required.
  • ProviderCalendarId (string) -- The calendar ARN for the room.
  • ClientRequestToken (string) --

    A unique, user-specified identifier for this request that ensures idempotency.

    This field is autopopulated if not provided.

  • Tags (list) --

    The tags for the room.

    • (dict) --

      A key-value pair that can be associated with a resource.

      • Key (string) -- [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) -- [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type

dict

Returns

Response Syntax

{
    'RoomArn': 'string'
}

Response Structure

  • (dict) --

    • RoomArn (string) --

      The ARN of the newly created room in the response.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
  • AlexaForBusiness.Client.exceptions.LimitExceededException
create_skill_group(**kwargs)

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',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • SkillGroupName (string) --

    [REQUIRED]

    The name for the skill group.

  • Description (string) -- The description for the skill group.
  • ClientRequestToken (string) --

    A unique, user-specified identifier for this request that ensures idempotency.

    This field is autopopulated if not provided.

  • Tags (list) --

    The tags for the skill group.

    • (dict) --

      A key-value pair that can be associated with a resource.

      • Key (string) -- [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) -- [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type

dict

Returns

Response Syntax

{
    'SkillGroupArn': 'string'
}

Response Structure

  • (dict) --

    • SkillGroupArn (string) --

      The ARN of the newly created skill group in the response.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
  • AlexaForBusiness.Client.exceptions.LimitExceededException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
create_user(**kwargs)

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'
        },
    ]
)
Parameters
  • UserId (string) --

    [REQUIRED]

    The ARN for the user.

  • FirstName (string) -- The first name for the user.
  • LastName (string) -- The last name for the user.
  • Email (string) -- The email address for the user.
  • ClientRequestToken (string) --

    A unique, user-specified identifier for this request that ensures idempotency.

    This field is autopopulated if not provided.

  • Tags (list) --

    The tags for the user.

    • (dict) --

      A key-value pair that can be associated with a resource.

      • Key (string) -- [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) -- [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type

dict

Returns

Response Syntax

{
    'UserArn': 'string'
}

Response Structure

  • (dict) --

    • UserArn (string) --

      The ARN of the newly created user in the response.

Exceptions

  • AlexaForBusiness.Client.exceptions.ResourceInUseException
  • AlexaForBusiness.Client.exceptions.LimitExceededException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
delete_address_book(**kwargs)

Deletes an address book by the address book ARN.

See also: AWS API Documentation

Request Syntax

response = client.delete_address_book(
    AddressBookArn='string'
)
Parameters
AddressBookArn (string) --

[REQUIRED]

The ARN of the address book to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
delete_business_report_schedule(**kwargs)

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'
)
Parameters
ScheduleArn (string) --

[REQUIRED]

The ARN of the business report schedule.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
delete_conference_provider(**kwargs)

Deletes a conference provider.

See also: AWS API Documentation

Request Syntax

response = client.delete_conference_provider(
    ConferenceProviderArn='string'
)
Parameters
ConferenceProviderArn (string) --

[REQUIRED]

The ARN of the conference provider.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
delete_contact(**kwargs)

Deletes a contact by the contact ARN.

See also: AWS API Documentation

Request Syntax

response = client.delete_contact(
    ContactArn='string'
)
Parameters
ContactArn (string) --

[REQUIRED]

The ARN of the contact to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
delete_device(**kwargs)

Removes a device from Alexa For Business.

See also: AWS API Documentation

Request Syntax

response = client.delete_device(
    DeviceArn='string'
)
Parameters
DeviceArn (string) --

[REQUIRED]

The ARN of the device for which to request details.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.InvalidCertificateAuthorityException
delete_device_usage_data(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_device_usage_data(
    DeviceArn='string',
    DeviceUsageType='VOICE'
)
Parameters
  • DeviceArn (string) --

    [REQUIRED]

    The ARN of the device.

  • DeviceUsageType (string) --

    [REQUIRED]

    The type of usage data to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.DeviceNotRegisteredException
  • AlexaForBusiness.Client.exceptions.LimitExceededException
delete_gateway_group(**kwargs)

Deletes a gateway group.

See also: AWS API Documentation

Request Syntax

response = client.delete_gateway_group(
    GatewayGroupArn='string'
)
Parameters
GatewayGroupArn (string) --

[REQUIRED]

The ARN of the gateway group to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ResourceAssociatedException
delete_network_profile(**kwargs)

Deletes a network profile by the network profile ARN.

See also: AWS API Documentation

Request Syntax

response = client.delete_network_profile(
    NetworkProfileArn='string'
)
Parameters
NetworkProfileArn (string) --

[REQUIRED]

The ARN of the network profile associated with a device.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ResourceInUseException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.NotFoundException
delete_profile(**kwargs)

Deletes a room profile by the profile ARN.

See also: AWS API Documentation

Request Syntax

response = client.delete_profile(
    ProfileArn='string'
)
Parameters
ProfileArn (string) -- The ARN of the room profile to delete. Required.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
delete_room(**kwargs)

Deletes a room by the room ARN.

See also: AWS API Documentation

Request Syntax

response = client.delete_room(
    RoomArn='string'
)
Parameters
RoomArn (string) -- The ARN of the room to delete. Required.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
delete_room_skill_parameter(**kwargs)

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'
)
Parameters
  • RoomArn (string) -- The ARN of the room from which to remove the room skill parameter details.
  • SkillId (string) --

    [REQUIRED]

    The ID of the skill from which to remove the room skill parameter details.

  • ParameterKey (string) --

    [REQUIRED]

    The room skill parameter key for which to remove details.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
delete_skill_authorization(**kwargs)

Unlinks a third-party account from a skill.

See also: AWS API Documentation

Request Syntax

response = client.delete_skill_authorization(
    SkillId='string',
    RoomArn='string'
)
Parameters
  • SkillId (string) --

    [REQUIRED]

    The unique identifier of a skill.

  • RoomArn (string) -- The room that the skill is authorized for.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
delete_skill_group(**kwargs)

Deletes a skill group by skill group ARN.

See also: AWS API Documentation

Request Syntax

response = client.delete_skill_group(
    SkillGroupArn='string'
)
Parameters
SkillGroupArn (string) -- The ARN of the skill group to delete. Required.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
delete_user(**kwargs)

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'
)
Parameters
  • UserArn (string) -- The ARN of the user to delete in the organization. Required.
  • EnrollmentId (string) --

    [REQUIRED]

    The ARN of the user's enrollment in the organization. Required.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
disassociate_contact_from_address_book(**kwargs)

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'
)
Parameters
  • ContactArn (string) --

    [REQUIRED]

    The ARN of the contact to disassociate from an address book.

  • AddressBookArn (string) --

    [REQUIRED]

    The ARN of the address from which to disassociate the contact.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

disassociate_device_from_room(**kwargs)

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'
)
Parameters
DeviceArn (string) -- The ARN of the device to disassociate from a room. Required.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.DeviceNotRegisteredException
disassociate_skill_from_skill_group(**kwargs)

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'
)
Parameters
  • SkillGroupArn (string) -- The unique identifier of a skill. Required.
  • SkillId (string) --

    [REQUIRED]

    The ARN of a skill group to associate to a skill.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.NotFoundException
disassociate_skill_from_users(**kwargs)

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'
)
Parameters
SkillId (string) --

[REQUIRED]

The private skill ID you want to make unavailable for enrolled users.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.NotFoundException
disassociate_skill_group_from_room(**kwargs)

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'
)
Parameters
  • SkillGroupArn (string) -- The ARN of the skill group to disassociate from a room. Required.
  • RoomArn (string) -- The ARN of the room from which the skill group is to be disassociated. Required.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
forget_smart_home_appliances(**kwargs)

Forgets smart home appliances associated to a room.

See also: AWS API Documentation

Request Syntax

response = client.forget_smart_home_appliances(
    RoomArn='string'
)
Parameters
RoomArn (string) --

[REQUIRED]

The room that the appliances are associated with.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_address_book(**kwargs)

Gets address the book details by the address book ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_address_book(
    AddressBookArn='string'
)
Parameters
AddressBookArn (string) --

[REQUIRED]

The ARN of the address book for which to request details.

Return type
dict
Returns
Response Syntax
{
    'AddressBook': {
        'AddressBookArn': 'string',
        'Name': 'string',
        'Description': 'string'
    }
}

Response Structure

  • (dict) --
    • AddressBook (dict) --

      The details of the requested 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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_conference_preference()

Retrieves the existing conference preferences.

See also: AWS API Documentation

Request Syntax

response = client.get_conference_preference()
Return type
dict
Returns
Response Syntax
{
    'Preference': {
        'DefaultConferenceProviderArn': 'string'
    }
}

Response Structure

  • (dict) --
    • Preference (dict) --

      The conference preference.

      • DefaultConferenceProviderArn (string) --

        The ARN of the default conference provider.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_conference_provider(**kwargs)

Gets details about a specific conference provider.

See also: AWS API Documentation

Request Syntax

response = client.get_conference_provider(
    ConferenceProviderArn='string'
)
Parameters
ConferenceProviderArn (string) --

[REQUIRED]

The ARN of the newly created conference provider.

Return type
dict
Returns
Response Syntax
{
    '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

  • (dict) --
    • ConferenceProvider (dict) --

      The conference provider.

      • 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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_contact(**kwargs)

Gets the contact details by the contact ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_contact(
    ContactArn='string'
)
Parameters
ContactArn (string) --

[REQUIRED]

The ARN of the contact for which to request details.

Return type
dict
Returns
Response Syntax
{
    '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

  • (dict) --
    • Contact (dict) --

      The details of the requested 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 either 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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_device(**kwargs)

Gets the details of a device by device ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_device(
    DeviceArn='string'
)
Parameters
DeviceArn (string) -- The ARN of the device for which to request details. Required.
Return type
dict
Returns
Response Syntax
{
    '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'|'PASSWORD_MANAGER_ACCESS_DENIED'|'CERTIFICATE_AUTHORITY_ACCESS_DENIED'
                },
            ],
            'ConnectionStatus': 'ONLINE'|'OFFLINE',
            'ConnectionStatusUpdatedTime': datetime(2015, 1, 1)
        },
        'NetworkProfileInfo': {
            'NetworkProfileArn': 'string',
            'CertificateArn': 'string',
            'CertificateExpirationTime': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --
    • Device (dict) --

      The details of the device requested. Required.

      • 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.

      • RoomArn (string) --

        The room ARN of a device.

      • DeviceStatus (string) --

        The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.

      • 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.

        • ConnectionStatusUpdatedTime (datetime) --

          The time (in epoch) when the device connection status changed.

      • NetworkProfileInfo (dict) --

        Detailed information about a device's network profile.

        • NetworkProfileArn (string) --

          The ARN of the network profile associated with a device.

        • CertificateArn (string) --

          The ARN of the certificate associated with a device.

        • CertificateExpirationTime (datetime) --

          The time (in epoch) when the certificate expires.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_gateway(**kwargs)

Retrieves the details of a gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_gateway(
    GatewayArn='string'
)
Parameters
GatewayArn (string) --

[REQUIRED]

The ARN of the gateway to get.

Return type
dict
Returns
Response Syntax
{
    'Gateway': {
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string',
        'GatewayGroupArn': 'string',
        'SoftwareVersion': 'string'
    }
}

Response Structure

  • (dict) --
    • Gateway (dict) --

      The details of the 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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_gateway_group(**kwargs)

Retrieves the details of a gateway group.

See also: AWS API Documentation

Request Syntax

response = client.get_gateway_group(
    GatewayGroupArn='string'
)
Parameters
GatewayGroupArn (string) --

[REQUIRED]

The ARN of the gateway group to get.

Return type
dict
Returns
Response Syntax
{
    'GatewayGroup': {
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string'
    }
}

Response Structure

  • (dict) --
    • GatewayGroup (dict) --

      The details of the 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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_invitation_configuration()

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

See also: AWS API Documentation

Request Syntax

response = client.get_invitation_configuration()
Return type
dict
Returns
Response Syntax
{
    'OrganizationName': 'string',
    'ContactEmail': 'string',
    'PrivateSkillIds': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • OrganizationName (string) --

      The name of the organization sending the enrollment invite to a user.

    • ContactEmail (string) --

      The email ID of the organization or individual contact that the enrolled user can use.

    • PrivateSkillIds (list) --

      The list of private skill IDs that you want to recommend to the user to enable in the invitation.

      • (string) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_network_profile(**kwargs)

Gets the network profile details by the network profile ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_network_profile(
    NetworkProfileArn='string'
)
Parameters
NetworkProfileArn (string) --

[REQUIRED]

The ARN of the network profile associated with a device.

Return type
dict
Returns
Response Syntax
{
    '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

  • (dict) --
    • NetworkProfile (dict) --

      The network profile associated with 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.

      • 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.

      • CurrentPassword (string) --

        The current password of the Wi-Fi network.

      • NextPassword (string) --

        The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

      • 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.

      • TrustAnchors (list) --

        The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.

        • (string) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.InvalidSecretsManagerResourceException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_profile(**kwargs)

Gets the details of a room profile by profile ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_profile(
    ProfileArn='string'
)
Parameters
ProfileArn (string) -- The ARN of the room profile for which to request details. Required.
Return type
dict
Returns
Response Syntax
{
    'Profile': {
        'ProfileArn': 'string',
        'ProfileName': 'string',
        'IsDefault': True|False,
        'Address': 'string',
        'Timezone': 'string',
        'DistanceUnit': 'METRIC'|'IMPERIAL',
        'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
        'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
        'Locale': 'string',
        'SetupModeDisabled': True|False,
        'MaxVolumeLimit': 123,
        'PSTNEnabled': True|False,
        'AddressBookArn': 'string',
        'MeetingRoomConfiguration': {
            'RoomUtilizationMetricsEnabled': True|False,
            'EndOfMeetingReminder': {
                'ReminderAtMinutes': [
                    123,
                ],
                'ReminderType': 'ANNOUNCEMENT_TIME_CHECK'|'ANNOUNCEMENT_VARIABLE_TIME_LEFT'|'CHIME'|'KNOCK',
                'Enabled': True|False
            },
            'InstantBooking': {
                'DurationInMinutes': 123,
                'Enabled': True|False
            },
            'RequireCheckIn': {
                'ReleaseAfterMinutes': 123,
                'Enabled': True|False
            }
        }
    }
}

Response Structure

  • (dict) --
    • Profile (dict) --

      The details of the room profile requested. Required.

      • ProfileArn (string) --

        The ARN of a room profile.

      • ProfileName (string) --

        The name of a room profile.

      • IsDefault (boolean) --

        Retrieves if the profile is default or not.

      • Address (string) --

        The address of a room profile.

      • Timezone (string) --

        The time zone 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.

      • Locale (string) --

        The locale of a room profile. (This is currently available only to a limited preview audience.)

      • SetupModeDisabled (boolean) --

        The setup mode of a room profile.

      • MaxVolumeLimit (integer) --

        The max volume limit of a room profile.

      • PSTNEnabled (boolean) --

        The PSTN setting of a room profile.

      • AddressBookArn (string) --

        The ARN of the address book.

      • MeetingRoomConfiguration (dict) --

        Meeting room settings of a room profile.

        • RoomUtilizationMetricsEnabled (boolean) --

          Whether room utilization metrics are enabled or not.

        • EndOfMeetingReminder (dict) --

          Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

          • ReminderAtMinutes (list) --

            A range of 3 to 15 minutes that determines when the reminder begins.

            • (integer) --
          • ReminderType (string) --

            The type of sound that users hear during the end of meeting reminder.

          • Enabled (boolean) --

            Whether an end of meeting reminder is enabled or not.

        • InstantBooking (dict) --

          Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.

          • DurationInMinutes (integer) --

            Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

          • Enabled (boolean) --

            Whether instant booking is enabled or not.

        • RequireCheckIn (dict) --

          Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

          • ReleaseAfterMinutes (integer) --

            Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

          • Enabled (boolean) --

            Whether require check in is enabled or not.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_room(**kwargs)

Gets room details by room ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_room(
    RoomArn='string'
)
Parameters
RoomArn (string) -- The ARN of the room for which to request details. Required.
Return type
dict
Returns
Response Syntax
{
    'Room': {
        'RoomArn': 'string',
        'RoomName': 'string',
        'Description': 'string',
        'ProviderCalendarId': 'string',
        'ProfileArn': 'string'
    }
}

Response Structure

  • (dict) --
    • Room (dict) --

      The details of the room requested.

      • 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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_room_skill_parameter(**kwargs)

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'
)
Parameters
  • RoomArn (string) -- The ARN of the room from which to get the room skill parameter details.
  • SkillId (string) --

    [REQUIRED]

    The ARN of the skill from which to get the room skill parameter details. Required.

  • ParameterKey (string) --

    [REQUIRED]

    The room skill parameter key for which to get details. Required.

Return type

dict

Returns

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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_skill_group(**kwargs)

Gets skill group details by skill group ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_skill_group(
    SkillGroupArn='string'
)
Parameters
SkillGroupArn (string) -- The ARN of the skill group for which to get details. Required.
Return type
dict
Returns
Response Syntax
{
    'SkillGroup': {
        'SkillGroupArn': 'string',
        'SkillGroupName': 'string',
        'Description': 'string'
    }
}

Response Structure

  • (dict) --
    • SkillGroup (dict) --

      The details of the skill group requested. Required.

      • SkillGroupArn (string) --

        The ARN of a skill group.

      • SkillGroupName (string) --

        The name of a skill group.

      • Description (string) --

        The description of a skill group.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_business_report_schedules(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_business_report_schedules(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token used to list the remaining schedules from the previous API call.
  • MaxResults (integer) -- The maximum number of schedules listed in the call.
Return type

dict

Returns

Response Syntax

{
    'BusinessReportSchedules': [
        {
            'ScheduleArn': 'string',
            'ScheduleName': 'string',
            'S3BucketName': 'string',
            'S3KeyPrefix': 'string',
            'Format': 'CSV'|'CSV_ZIP',
            'ContentRange': {
                'Interval': 'ONE_DAY'|'ONE_WEEK'|'THIRTY_DAYS'
            },
            '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.

list_conference_providers(**kwargs)

Lists conference providers under a specific AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_conference_providers(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The tokens used for pagination.
  • MaxResults (integer) -- The maximum number of conference providers to be returned, per paginated calls.
Return type

dict

Returns

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.

list_device_events(**kwargs)

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
)
Parameters
  • DeviceArn (string) --

    [REQUIRED]

    The ARN of a device.

  • EventType (string) -- The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
  • 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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.
  • MaxResults (integer) -- The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Return type

dict

Returns

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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
list_gateway_groups(**kwargs)

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
)
Parameters
  • NextToken (string) -- The token used to paginate though multiple pages of gateway group summaries.
  • MaxResults (integer) -- The maximum number of gateway group summaries to return. The default is 50.
Return type

dict

Returns

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.

list_gateways(**kwargs)

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
)
Parameters
  • GatewayGroupArn (string) -- The gateway group ARN for which to list gateways.
  • NextToken (string) -- The token used to paginate though multiple pages of gateway summaries.
  • MaxResults (integer) -- The maximum number of gateway summaries to return. The default is 50.
Return type

dict

Returns

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.

list_skills(**kwargs)

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
)
Parameters
  • SkillGroupArn (string) -- The ARN of the skill group for which to list enabled skills.
  • EnablementType (string) -- Whether the skill is enabled under the user's account.
  • SkillType (string) -- Whether the skill is publicly available or is a private skill.
  • 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 .
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Return type

dict

Returns

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.

list_skills_store_categories(**kwargs)

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
)
Parameters
  • NextToken (string) -- The tokens used for pagination.
  • MaxResults (integer) -- The maximum number of categories returned, per paginated calls.
Return type

dict

Returns

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.

list_skills_store_skills_by_category(**kwargs)

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
)
Parameters
  • CategoryId (integer) --

    [REQUIRED]

    The category ID for which the skills are being retrieved from the skill store.

  • NextToken (string) -- The tokens used for pagination.
  • MaxResults (integer) -- The maximum number of skills returned per paginated calls.
Return type

dict

Returns

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.

          • (string) --
        • 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.

            • (string) --
          • BulletPoints (list) --

            The details about what the skill supports organized as bullet points.

            • (string) --
          • NewInThisVersionBulletPoints (list) --

            The updates added in bullet points.

            • (string) --
          • SkillTypes (list) --

            The types of skills.

            • (string) --
          • Reviews (dict) --

            This member has been deprecated.

            The list of reviews for the skill, including Key and Value pair.

            • (string) --
              • (string) --
          • 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.

list_smart_home_appliances(**kwargs)

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'
)
Parameters
  • RoomArn (string) --

    [REQUIRED]

    The room that the appliances are associated with.

  • MaxResults (integer) -- The maximum number of appliances to be returned, per paginated calls.
  • NextToken (string) -- The tokens used for pagination.
Return type

dict

Returns

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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
list_tags(**kwargs)

Lists all tags for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags(
    Arn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The ARN of the specified resource for which to list tags.

  • 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 .
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Return type

dict

Returns

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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
put_conference_preference(**kwargs)

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'
    }
)
Parameters
ConferencePreference (dict) --

[REQUIRED]

The conference preference of a specific conference provider.

  • DefaultConferenceProviderArn (string) --

    The ARN of the default conference provider.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
put_invitation_configuration(**kwargs)

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',
    ]
)
Parameters
  • OrganizationName (string) --

    [REQUIRED]

    The name of the organization sending the enrollment invite to a user.

  • ContactEmail (string) -- The email ID of the organization or individual contact that the enrolled user can use.
  • PrivateSkillIds (list) --

    The list of private skill IDs that you want to recommend to the user to enable in the invitation.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
put_room_skill_parameter(**kwargs)

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'
    }
)
Parameters
  • RoomArn (string) -- The ARN of the room associated with the room skill parameter. Required.
  • SkillId (string) --

    [REQUIRED]

    The ARN of the skill associated with the room skill parameter. Required.

  • RoomSkillParameter (dict) --

    [REQUIRED]

    The updated room skill parameter. Required.

    • ParameterKey (string) -- [REQUIRED]

      The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.

    • ParameterValue (string) -- [REQUIRED]

      The parameter value of a room skill parameter.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
put_skill_authorization(**kwargs)

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'
)
Parameters
  • AuthorizationResult (dict) --

    [REQUIRED]

    The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.

    • (string) --
      • (string) --
  • SkillId (string) --

    [REQUIRED]

    The unique identifier of a skill.

  • RoomArn (string) -- The room that the skill is authorized for.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.UnauthorizedException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
register_avs_device(**kwargs)

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',
    RoomArn='string'
)
Parameters
  • ClientId (string) --

    [REQUIRED]

    The client ID of the OEM used for code-based linking authorization on an AVS device.

  • UserCode (string) --

    [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.

  • ProductId (string) --

    [REQUIRED]

    The product ID used to identify your AVS device during authorization.

  • DeviceSerialNumber (string) -- The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
  • AmazonId (string) --

    [REQUIRED]

    The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

  • RoomArn (string) -- The ARN of the room with which to associate your AVS device.
Return type

dict

Returns

Response Syntax

{
    'DeviceArn': 'string'
}

Response Structure

  • (dict) --

    • DeviceArn (string) --

      The ARN of the device.

Exceptions

  • AlexaForBusiness.Client.exceptions.LimitExceededException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.InvalidDeviceException
reject_skill(**kwargs)

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'
)
Parameters
SkillId (string) --

[REQUIRED]

The unique identifier of the skill.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.NotFoundException
resolve_room(**kwargs)

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'
)
Parameters
  • UserId (string) --

    [REQUIRED]

    The ARN of the user. Required.

  • SkillId (string) --

    [REQUIRED]

    The ARN of the skill that was requested. Required.

Return type

dict

Returns

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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
revoke_invitation(**kwargs)

Revokes an invitation and invalidates the enrollment URL.

See also: AWS API Documentation

Request Syntax

response = client.revoke_invitation(
    UserArn='string',
    EnrollmentId='string'
)
Parameters
  • UserArn (string) -- The ARN of the user for whom to revoke an enrollment invitation. Required.
  • EnrollmentId (string) -- The ARN of the enrollment invitation to revoke. Required.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
search_address_books(**kwargs)

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
)
Parameters
  • Filters (list) --

    The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

  • 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 only includes results beyond the token, up to the value specified by MaxResults.
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Return type

dict

Returns

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.

search_contacts(**kwargs)

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
)
Parameters
  • Filters (list) --

    The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

  • 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 only includes results beyond the token, up to the value specified by MaxResults.
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Return type

dict

Returns

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.

search_devices(**kwargs)

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'
        },
    ]
)
Parameters
  • 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 .
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • Filters (list) --

    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.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    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.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

Return type

dict

Returns

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'|'PASSWORD_MANAGER_ACCESS_DENIED'|'CERTIFICATE_AUTHORITY_ACCESS_DENIED'
                    },
                ],
                'ConnectionStatus': 'ONLINE'|'OFFLINE',
                'ConnectionStatusUpdatedTime': datetime(2015, 1, 1)
            },
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    '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.

          • ConnectionStatusUpdatedTime (datetime) --

            The time (in epoch) when the device connection status changed.

        • CreatedTime (datetime) --

          The time (in epoch) when the device data was created.

    • NextToken (string) --

      The token returned to indicate that there is more data available.

    • TotalCount (integer) --

      The total number of devices returned.

search_network_profiles(**kwargs)

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'
        },
    ]
)
Parameters
  • 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.
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • Filters (list) --

    The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

Return type

dict

Returns

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.

search_profiles(**kwargs)

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'
        },
    ]
)
Parameters
  • 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 .
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • Filters (list) --

    The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

Return type

dict

Returns

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',
            'Locale': 'string'
        },
    ],
    '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 time zone 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.

        • Locale (string) --

          The locale of a room profile. (This is currently available only to a limited preview audience.)

    • NextToken (string) --

      The token returned to indicate that there is more data available.

    • TotalCount (integer) --

      The total number of room profiles returned.

search_rooms(**kwargs)

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'
        },
    ]
)
Parameters
  • 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 .
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • Filters (list) --

    The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

Return type

dict

Returns

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.

search_skill_groups(**kwargs)

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'
        },
    ]
)
Parameters
  • 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 . Required.
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • Filters (list) --

    The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

Return type

dict

Returns

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.

search_users(**kwargs)

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'
        },
    ]
)
Parameters
  • 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 . Required.
  • MaxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
  • Filters (list) --

    The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

Return type

dict

Returns

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.

send_announcement(**kwargs)

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'
)
Parameters
  • RoomFilters (list) --

    [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.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • Content (dict) --

    [REQUIRED]

    The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

    • TextList (list) --

      The list of text messages.

      • (dict) --

        The text message.

        • Locale (string) -- [REQUIRED]

          The locale of the text message. Currently, en-US is supported.

        • Value (string) -- [REQUIRED]

          The value of the text message.

    • SsmlList (list) --

      The list of SSML messages.

      • (dict) --

        The SSML message. For more information, see SSML Reference .

        • Locale (string) -- [REQUIRED]

          The locale of the SSML message. Currently, en-US is supported.

        • Value (string) -- [REQUIRED]

          The value of the SSML message in the correct SSML format. The audio tag is not supported.

    • AudioList (list) --

      The list of audio messages.

      • (dict) --

        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>
        • Locale (string) -- [REQUIRED]

          The locale of the audio message. Currently, en-US is supported.

        • Location (string) -- [REQUIRED]

          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 .

  • TimeToLiveInSeconds (integer) -- The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.
  • ClientRequestToken (string) --

    [REQUIRED]

    The unique, user-specified identifier for the request that ensures idempotency.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'AnnouncementArn': 'string'
}

Response Structure

  • (dict) --

    • AnnouncementArn (string) --

      The identifier of the announcement.

Exceptions

  • AlexaForBusiness.Client.exceptions.LimitExceededException
  • AlexaForBusiness.Client.exceptions.AlreadyExistsException
send_invitation(**kwargs)

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'
)
Parameters
UserArn (string) -- The ARN of the user to whom to send an invitation. Required.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.InvalidUserStatusException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
start_device_sync(**kwargs)

Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:

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

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',
    ]
)
Parameters
  • RoomArn (string) -- The ARN of the room with which the device to sync is associated. Required.
  • DeviceArn (string) -- The ARN of the device to sync. Required.
  • Features (list) --

    [REQUIRED]

    Request structure to start the device sync. Required.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.DeviceNotRegisteredException
start_smart_home_appliance_discovery(**kwargs)

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'
)
Parameters
RoomArn (string) --

[REQUIRED]

The room where smart home appliance discovery was initiated.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
tag_resource(**kwargs)

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'
        },
    ]
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The ARN of the resource to which to add metadata tags. Required.

  • Tags (list) --

    [REQUIRED]

    The tags to be added to the specified resource. Do not provide system tags. Required.

    • (dict) --

      A key-value pair that can be associated with a resource.

      • Key (string) -- [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) -- [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
untag_resource(**kwargs)

Removes metadata tags from a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    Arn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The ARN of the resource from which to remove metadata tags. Required.

  • TagKeys (list) --

    [REQUIRED]

    The tags to be removed from the specified resource. Do not provide system tags. Required.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
update_address_book(**kwargs)

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'
)
Parameters
  • AddressBookArn (string) --

    [REQUIRED]

    The ARN of the room to update.

  • Name (string) -- The updated name of the room.
  • Description (string) -- The updated description of the room.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.NameInUseException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
update_business_report_schedule(**kwargs)

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'
    }
)
Parameters
  • ScheduleArn (string) --

    [REQUIRED]

    The ARN of the business report schedule.

  • S3BucketName (string) -- The S3 location 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).
  • ScheduleName (string) -- The name identifier of the schedule.
  • Recurrence (dict) --

    The recurrence of the reports.

    • StartDate (string) --

      The start date.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
update_conference_provider(**kwargs)

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'
    }
)
Parameters
  • ConferenceProviderArn (string) --

    [REQUIRED]

    The ARN of the conference provider.

  • ConferenceProviderType (string) --

    [REQUIRED]

    The type of the conference provider.

  • IPDialIn (dict) --

    The IP endpoint and protocol for calling.

    • Endpoint (string) -- [REQUIRED]

      The IP address.

    • CommsProtocol (string) -- [REQUIRED]

      The protocol, including SIP, SIPS, and H323.

  • PSTNDialIn (dict) --

    The information for PSTN conferencing.

    • CountryCode (string) -- [REQUIRED]

      The zip code.

    • PhoneNumber (string) -- [REQUIRED]

      The phone number to call to join the conference.

    • OneClickIdDelay (string) -- [REQUIRED]

      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) -- [REQUIRED]

      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) --

    [REQUIRED]

    The meeting settings for the conference provider.

    • RequirePin (string) -- [REQUIRED]

      The values that indicate whether the pin is always required.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
update_contact(**kwargs)

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'
        },
    ]
)
Parameters
  • ContactArn (string) --

    [REQUIRED]

    The ARN of the contact to update.

  • DisplayName (string) -- The updated display name of the contact.
  • FirstName (string) -- The updated first name of the contact.
  • LastName (string) -- The updated last name of the contact.
  • PhoneNumber (string) -- The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
  • PhoneNumbers (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) -- [REQUIRED]

        The raw value of the phone number.

      • Type (string) -- [REQUIRED]

        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) -- [REQUIRED]

        The URI for the SIP address.

      • Type (string) -- [REQUIRED]

        The type of the SIP address.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
update_device(**kwargs)

Updates the device name by device ARN.

See also: AWS API Documentation

Request Syntax

response = client.update_device(
    DeviceArn='string',
    DeviceName='string'
)
Parameters
  • DeviceArn (string) -- The ARN of the device to update. Required.
  • DeviceName (string) -- The updated device name. Required.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.DeviceNotRegisteredException
update_gateway(**kwargs)

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'
)
Parameters
  • GatewayArn (string) --

    [REQUIRED]

    The ARN of the gateway to update.

  • Name (string) -- The updated name of the gateway.
  • Description (string) -- The updated description of the gateway.
  • SoftwareVersion (string) -- The updated software version of the gateway. The gateway automatically updates its software version during normal operation.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.NameInUseException
update_gateway_group(**kwargs)

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'
)
Parameters
  • GatewayGroupArn (string) --

    [REQUIRED]

    The ARN of the gateway group to update.

  • Name (string) -- The updated name of the gateway group.
  • Description (string) -- The updated description of the gateway group.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.NameInUseException
update_network_profile(**kwargs)

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',
    ]
)
Parameters
  • NetworkProfileArn (string) --

    [REQUIRED]

    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.
  • CurrentPassword (string) -- The current password of the Wi-Fi network.
  • NextPassword (string) -- The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
  • 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.
  • TrustAnchors (list) --

    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.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.NameInUseException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
  • AlexaForBusiness.Client.exceptions.InvalidCertificateAuthorityException
  • AlexaForBusiness.Client.exceptions.InvalidSecretsManagerResourceException
update_profile(**kwargs)

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',
    Locale='string',
    SetupModeDisabled=True|False,
    MaxVolumeLimit=123,
    PSTNEnabled=True|False,
    MeetingRoomConfiguration={
        'RoomUtilizationMetricsEnabled': True|False,
        'EndOfMeetingReminder': {
            'ReminderAtMinutes': [
                123,
            ],
            'ReminderType': 'ANNOUNCEMENT_TIME_CHECK'|'ANNOUNCEMENT_VARIABLE_TIME_LEFT'|'CHIME'|'KNOCK',
            'Enabled': True|False
        },
        'InstantBooking': {
            'DurationInMinutes': 123,
            'Enabled': True|False
        },
        'RequireCheckIn': {
            'ReleaseAfterMinutes': 123,
            'Enabled': True|False
        }
    }
)
Parameters
  • ProfileArn (string) -- The ARN of the room profile to update. Required.
  • ProfileName (string) -- The updated name for the room profile.
  • IsDefault (boolean) -- Sets the profile as default if selected. If this is missing, no update is done to the default status.
  • Timezone (string) -- The updated timezone for the room profile.
  • Address (string) -- The updated address for the room profile.
  • DistanceUnit (string) -- The updated distance unit for the room profile.
  • TemperatureUnit (string) -- The updated temperature unit for the room profile.
  • WakeWord (string) -- The updated wake word for the room profile.
  • Locale (string) -- The updated locale for the room profile. (This is currently only available to a limited preview audience.)
  • SetupModeDisabled (boolean) -- Whether the setup mode of the profile is enabled.
  • MaxVolumeLimit (integer) -- The updated maximum volume limit for the room profile.
  • PSTNEnabled (boolean) -- Whether the PSTN setting of the room profile is enabled.
  • MeetingRoomConfiguration (dict) --

    The updated meeting room settings of a room profile.

    • RoomUtilizationMetricsEnabled (boolean) --

      Whether room utilization metrics are enabled or not.

    • EndOfMeetingReminder (dict) --

      Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

      • ReminderAtMinutes (list) --

        Updates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

        • (integer) --
      • ReminderType (string) --

        The type of sound that users hear during the end of meeting reminder.

      • Enabled (boolean) --

        Whether an end of meeting reminder is enabled or not.

    • InstantBooking (dict) --

      Settings to automatically book an available room available for a configured duration when joining a meeting with Alexa.

      • DurationInMinutes (integer) --

        Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

      • Enabled (boolean) --

        Whether instant booking is enabled or not.

    • RequireCheckIn (dict) --

      Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

      • ReleaseAfterMinutes (integer) --

        Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

      • Enabled (boolean) --

        Whether require check in is enabled or not.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.NameInUseException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException
update_room(**kwargs)

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'
)
Parameters
  • RoomArn (string) -- The ARN of the room to update.
  • RoomName (string) -- The updated name for the room.
  • Description (string) -- The updated description for the room.
  • ProviderCalendarId (string) -- The updated provider calendar ARN for the room.
  • ProfileArn (string) -- The updated profile ARN for the room.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.NameInUseException
update_skill_group(**kwargs)

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'
)
Parameters
  • SkillGroupArn (string) -- The ARN of the skill group to update.
  • SkillGroupName (string) -- The updated name for the skill group.
  • Description (string) -- The updated description for the skill group.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException
  • AlexaForBusiness.Client.exceptions.NameInUseException
  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException

Paginators

The available paginators are:

class AlexaForBusiness.Paginator.ListBusinessReportSchedules
paginator = client.get_paginator('list_business_report_schedules')
paginate(**kwargs)

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'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'BusinessReportSchedules': [
        {
            'ScheduleArn': 'string',
            'ScheduleName': 'string',
            'S3BucketName': 'string',
            'S3KeyPrefix': 'string',
            'Format': 'CSV'|'CSV_ZIP',
            'ContentRange': {
                'Interval': 'ONE_DAY'|'ONE_WEEK'|'THIRTY_DAYS'
            },
            '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

  • (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.

class AlexaForBusiness.Paginator.ListConferenceProviders
paginator = client.get_paginator('list_conference_providers')
paginate(**kwargs)

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'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
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'
            }
        },
    ],

}

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.

class AlexaForBusiness.Paginator.ListDeviceEvents
paginator = client.get_paginator('list_device_events')
paginate(**kwargs)

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'
    }
)
Parameters
  • DeviceArn (string) --

    [REQUIRED]

    The ARN of a device.

  • EventType (string) -- The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class AlexaForBusiness.Paginator.ListSkills
paginator = client.get_paginator('list_skills')
paginate(**kwargs)

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'
    }
)
Parameters
  • SkillGroupArn (string) -- The ARN of the skill group for which to list enabled skills.
  • EnablementType (string) -- Whether the skill is enabled under the user's account.
  • SkillType (string) -- Whether the skill is publicly available or is a private skill.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class AlexaForBusiness.Paginator.ListSkillsStoreCategories
paginator = client.get_paginator('list_skills_store_categories')
paginate(**kwargs)

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'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'CategoryList': [
        {
            'CategoryId': 123,
            'CategoryName': '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.

class AlexaForBusiness.Paginator.ListSkillsStoreSkillsByCategory
paginator = client.get_paginator('list_skills_store_skills_by_category')
paginate(**kwargs)

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'
    }
)
Parameters
  • CategoryId (integer) --

    [REQUIRED]

    The category ID for which the skills are being retrieved from the skill store.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

          • (string) --
        • 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.

            • (string) --
          • BulletPoints (list) --

            The details about what the skill supports organized as bullet points.

            • (string) --
          • NewInThisVersionBulletPoints (list) --

            The updates added in bullet points.

            • (string) --
          • SkillTypes (list) --

            The types of skills.

            • (string) --
          • Reviews (dict) --

            This member has been deprecated.

            The list of reviews for the skill, including Key and Value pair.

            • (string) --
              • (string) --
          • 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.

class AlexaForBusiness.Paginator.ListSmartHomeAppliances
paginator = client.get_paginator('list_smart_home_appliances')
paginate(**kwargs)

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'
    }
)
Parameters
  • RoomArn (string) --

    [REQUIRED]

    The room that the appliances are associated with.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class AlexaForBusiness.Paginator.ListTags
paginator = client.get_paginator('list_tags')
paginate(**kwargs)

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'
    }
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The ARN of the specified resource for which to list tags.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class AlexaForBusiness.Paginator.SearchDevices
paginator = client.get_paginator('search_devices')
paginate(**kwargs)

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'
    }
)
Parameters
  • Filters (list) --

    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.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    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.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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'|'PASSWORD_MANAGER_ACCESS_DENIED'|'CERTIFICATE_AUTHORITY_ACCESS_DENIED'
                    },
                ],
                'ConnectionStatus': 'ONLINE'|'OFFLINE',
                'ConnectionStatusUpdatedTime': datetime(2015, 1, 1)
            },
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    '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.

          • ConnectionStatusUpdatedTime (datetime) --

            The time (in epoch) when the device connection status changed.

        • CreatedTime (datetime) --

          The time (in epoch) when the device data was created.

    • TotalCount (integer) --

      The total number of devices returned.

class AlexaForBusiness.Paginator.SearchProfiles
paginator = client.get_paginator('search_profiles')
paginate(**kwargs)

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'
    }
)
Parameters
  • Filters (list) --

    The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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',
            'Locale': '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 time zone 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.

        • Locale (string) --

          The locale of a room profile. (This is currently available only to a limited preview audience.)

    • TotalCount (integer) --

      The total number of room profiles returned.

class AlexaForBusiness.Paginator.SearchRooms
paginator = client.get_paginator('search_rooms')
paginate(**kwargs)

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'
    }
)
Parameters
  • Filters (list) --

    The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class AlexaForBusiness.Paginator.SearchSkillGroups
paginator = client.get_paginator('search_skill_groups')
paginate(**kwargs)

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'
    }
)
Parameters
  • Filters (list) --

    The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class AlexaForBusiness.Paginator.SearchUsers
paginator = client.get_paginator('search_users')
paginate(**kwargs)

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'
    }
)
Parameters
  • Filters (list) --

    The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

    • (dict) --

      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.

      • Key (string) -- [REQUIRED]

        The key of a filter.

      • Values (list) -- [REQUIRED]

        The values of a filter.

        • (string) --
  • SortCriteria (list) --

    The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

    • (dict) --

      An object representing a sort criteria.

      • Key (string) -- [REQUIRED]

        The sort key of a sort object.

      • Value (string) -- [REQUIRED]

        The sort value of a sort object.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.