2018/03/29 - Alexa For Business - 12 new api methods
Changes Adds operations for creating and managing address books of phone contacts for use in A4B managed shared devices.
Gets the contact details by the contact ARN.
See also: AWS API Documentation
Request Syntax
client.get_contact(
ContactArn='string'
)
string
[REQUIRED]
The ARN of the contact for which to request details.
dict
Response Syntax
{
'Contact': {
'ContactArn': 'string',
'DisplayName': 'string',
'FirstName': 'string',
'LastName': 'string',
'PhoneNumber': 'string'
}
}
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 AWS management console.
FirstName (string) --
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.
Updates address book details by the address book ARN.
See also: AWS API Documentation
Request Syntax
client.update_address_book(
AddressBookArn='string',
Name='string',
Description='string'
)
string
[REQUIRED]
The ARN of the room to update.
string
The updated name of the room.
string
The updated description of the room.
dict
Response Syntax
{}
Response Structure
(dict) --
Searches contacts and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
client.search_contacts(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
NextToken='string',
MaxResults=123
)
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) --
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.
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.
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.
dict
Response Syntax
{
'Contacts': [
{
'ContactArn': 'string',
'DisplayName': 'string',
'FirstName': 'string',
'LastName': 'string',
'PhoneNumber': 'string'
},
],
'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 AWS management console.
FirstName (string) --
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.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of contacts returned.
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',
ClientRequestToken='string'
)
string
The name of the contact to display on the AWS management console.
string
[REQUIRED]
The first name of the contact that is used to call the contact on the device.
string
The last name of the contact that is used to call the contact on the device.
string
[REQUIRED]
The phone number of the contact in E164 format.
string
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactArn': 'string'
}
Response Structure
(dict) --
ContactArn (string) --
The ARN of the newly created address book.
Gets address the book details by the address book ARN.
See also: AWS API Documentation
Request Syntax
client.get_address_book(
AddressBookArn='string'
)
string
[REQUIRED]
The ARN of the address book for which to request details.
dict
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.
Associates a contact to a given address book.
See also: AWS API Documentation
Request Syntax
client.associate_contact_with_address_book(
ContactArn='string',
AddressBookArn='string'
)
string
[REQUIRED]
The ARN of the contact to associate with an address book.
string
[REQUIRED]
The ARN of the address book with which to associate the contact.
dict
Response Syntax
{}
Response Structure
(dict) --
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'
)
string
[REQUIRED]
The name of the address book.
string
The description of the address book.
string
A unique, user-specified identifier for the request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'AddressBookArn': 'string'
}
Response Structure
(dict) --
AddressBookArn (string) --
The ARN of the newly created address book.
Searches address books and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
client.search_address_books(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
NextToken='string',
MaxResults=123
)
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) --
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.
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.
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.
dict
Response Syntax
{
'AddressBooks': [
{
'AddressBookArn': 'string',
'Name': 'string',
'Description': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
AddressBooks (list) --
The address books that meet the specified set of filter criteria, in sort order.
(dict) --
Information related to an address book.
AddressBookArn (string) --
The ARN of the address book.
Name (string) --
The name of the address book.
Description (string) --
The description of the address book.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of address books returned.
Deletes an address book by the address book ARN.
See also: AWS API Documentation
Request Syntax
client.delete_address_book(
AddressBookArn='string'
)
string
[REQUIRED]
The ARN of the address book to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates a contact from a given address book.
See also: AWS API Documentation
Request Syntax
client.disassociate_contact_from_address_book(
ContactArn='string',
AddressBookArn='string'
)
string
[REQUIRED]
The ARN of the contact to disassociate from an address book.
string
[REQUIRED]
The ARN of the address from which to disassociate the contact.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a contact by the contact ARN.
See also: AWS API Documentation
Request Syntax
client.delete_contact(
ContactArn='string'
)
string
[REQUIRED]
The ARN of the contact to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the contact details by the contact ARN.
See also: AWS API Documentation
Request Syntax
client.update_contact(
ContactArn='string',
DisplayName='string',
FirstName='string',
LastName='string',
PhoneNumber='string'
)
string
[REQUIRED]
The ARN of the contact to update.
string
The updated display name of the contact.
string
The updated first name of the contact.
string
The updated last name of the contact.
string
The updated phone number of the contact.
dict
Response Syntax
{}
Response Structure
(dict) --