AlexaForBusiness / Client / create_address_book

create_address_book#

AlexaForBusiness.Client.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',
    Tags=[
        {
            'Key': 'string',
            'Value': '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.

  • Tags (list) –

    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.

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