AWS API Changes

2021/03/01 - Alexa For Business - 6 updated api methods

Changes Added support for optional tags in CreateAddressBook, CreateConferenceProvider, CreateContact, CreateGatewayGroup, CreateNetworkProfile and RegisterAVSDevice APIs.

CreateAddressBook (updated)

Link ¶
Changes (request)

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates an address book with the specified details.

See also: AWS API Documentation

Request Syntax

client.create_address_book(
    Name='string',
    Description='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Name

string

param Name

[REQUIRED]

The name of the address book.

type Description

string

param Description

The description of the address book.

type ClientRequestToken

string

param ClientRequestToken

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

This field is autopopulated if not provided.

type Tags

list

param Tags

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

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

rtype

dict

returns

Response Syntax

{
    'AddressBookArn': 'string'
}

Response Structure

(dict) --
- AddressBookArn (string) --
  
  The ARN of the newly created address book.

CreateConferenceProvider (updated)

Link ¶
Changes (request)

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Adds a new conference provider under the user's AWS account.

See also: AWS API Documentation

Request Syntax

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

type ConferenceProviderName

string

param ConferenceProviderName

[REQUIRED]

The name of the conference provider.

type ConferenceProviderType

string

param ConferenceProviderType

[REQUIRED]

Represents a type within a list of predefined types.

type IPDialIn

dict

param IPDialIn

The IP endpoint and protocol for calling.

Endpoint (string) -- [REQUIRED]

The IP address.
CommsProtocol (string) -- [REQUIRED]

The protocol, including SIP, SIPS, and H323.

type PSTNDialIn

dict

param PSTNDialIn

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.

type MeetingSetting

dict

param MeetingSetting

[REQUIRED]

The meeting settings for the conference provider.

RequirePin (string) -- [REQUIRED]

The values that indicate whether the pin is always required.

type ClientRequestToken

string

param ClientRequestToken

The request token of the client.

This field is autopopulated if not provided.

type Tags

list

param Tags

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

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

rtype

dict

returns

Response Syntax

{
    'ConferenceProviderArn': 'string'
}

Response Structure

(dict) --
- ConferenceProviderArn (string) --
  
  The ARN of the newly-created conference provider.

CreateContact (updated)

Link ¶
Changes (request)

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a contact with the specified details.

See also: AWS API Documentation

Request Syntax

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

type DisplayName

string

param DisplayName

The name of the contact to display on the console.

type FirstName

string

param FirstName

[REQUIRED]

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

type LastName

string

param LastName

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

type PhoneNumber

string

param PhoneNumber

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.

type PhoneNumbers

list

param PhoneNumbers

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.

type SipAddresses

list

param SipAddresses

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.

type ClientRequestToken

string

param ClientRequestToken

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

This field is autopopulated if not provided.

type Tags

list

param Tags

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

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

rtype

dict

returns

Response Syntax

{
    'ContactArn': 'string'
}

Response Structure

(dict) --
- ContactArn (string) --
  
  The ARN of the newly created address book.

CreateGatewayGroup (updated)

Link ¶
Changes (request)

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a gateway group with the specified details.

See also: AWS API Documentation

Request Syntax

client.create_gateway_group(
    Name='string',
    Description='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Name

string

param Name

[REQUIRED]

The name of the gateway group.

type Description

string

param Description

The description of the gateway group.

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

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

This field is autopopulated if not provided.

type Tags

list

param Tags

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

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

rtype

dict

returns

Response Syntax

{
    'GatewayGroupArn': 'string'
}

Response Structure

(dict) --
- GatewayGroupArn (string) --
  
  The ARN of the created gateway group.

CreateNetworkProfile (updated)

Link ¶
Changes (request)

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a network profile with the specified details.

See also: AWS API Documentation

Request Syntax

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

type NetworkProfileName

string

param NetworkProfileName

[REQUIRED]

The name of the network profile associated with a device.

type Description

string

param Description

Detailed information about a device's network profile.

type Ssid

string

param Ssid

[REQUIRED]

The SSID of the Wi-Fi network.

type SecurityType

string

param SecurityType

[REQUIRED]

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

type EapMethod

string

param EapMethod

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

type CurrentPassword

string

param CurrentPassword

The current password of the Wi-Fi network.

type NextPassword

string

param NextPassword

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.

type CertificateAuthorityArn

string

param CertificateAuthorityArn

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

type TrustAnchors

list

param TrustAnchors

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

(string) --

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

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

This field is autopopulated if not provided.

type Tags

list

param Tags

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

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

rtype

dict

returns

Response Syntax

{
    'NetworkProfileArn': 'string'
}

Response Structure

(dict) --
- NetworkProfileArn (string) --
  
  The ARN of the network profile associated with a device.

RegisterAVSDevice (updated)

Link ¶
Changes (request)

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

See also: AWS API Documentation

Request Syntax

client.register_avs_device(
    ClientId='string',
    UserCode='string',
    ProductId='string',
    DeviceSerialNumber='string',
    AmazonId='string',
    RoomArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ClientId

string

param ClientId

[REQUIRED]

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

type UserCode

string

param UserCode

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

type ProductId

string

param ProductId

[REQUIRED]

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

type DeviceSerialNumber

string

param DeviceSerialNumber

The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

type AmazonId

string

param AmazonId

[REQUIRED]

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

type RoomArn

string

param RoomArn

The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

type Tags

list

param Tags

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

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

rtype

dict

returns

Response Syntax

{
    'DeviceArn': 'string'
}

Response Structure

(dict) --
- DeviceArn (string) --
  
  The ARN of the device.