get_address_book

AlexaForBusiness.Client.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