AlexaForBusiness / Client / update_contact

update_contact#

AlexaForBusiness.Client.update_contact(**kwargs)#

Updates the contact details by the contact ARN.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

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