SSMContacts / Client / update_contact_channel

update_contact_channel#

SSMContacts.Client.update_contact_channel(**kwargs)#

Updates a contact’s contact channel.

See also: AWS API Documentation

Request Syntax

response = client.update_contact_channel(
    ContactChannelId='string',
    Name='string',
    DeliveryAddress={
        'SimpleAddress': 'string'
    }
)
Parameters:

  • ContactChannelId (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the contact channel you want to update.

  • Name (string) – The name of the contact channel.

  • DeliveryAddress (dict) –

    The details that Incident Manager uses when trying to engage the contact channel.

    • SimpleAddress (string) –

      The format is dependent on the type of the contact channel. The following are the expected formats:

      • SMS - ‘+’ followed by the country code and phone number

      • VOICE - ‘+’ followed by the country code and phone number

      • EMAIL - any standard email format

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • SSMContacts.Client.exceptions.AccessDeniedException

  • SSMContacts.Client.exceptions.ConflictException

  • SSMContacts.Client.exceptions.DataEncryptionException

  • SSMContacts.Client.exceptions.InternalServerException

  • SSMContacts.Client.exceptions.ResourceNotFoundException

  • SSMContacts.Client.exceptions.ThrottlingException

  • SSMContacts.Client.exceptions.ValidationException

Examples

The following update-contact-channel example updates the name and delivery address of a contact channel.

response = client.update_contact_channel(
    ContactChannelId='arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad',
    DeliveryAddress={
        'SimpleAddress': '+15005550198',
    },
    Name='akuas voice channel',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}