SSMContacts / Client / get_contact_channel

get_contact_channel

SSMContacts.Client.get_contact_channel(**kwargs)

List details about a specific contact channel.

See also: AWS API Documentation

Request Syntax

response = client.get_contact_channel(
    ContactChannelId='string'
)

Parameters:

ContactChannelId (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the contact channel you want information about.

Return type:

dict

Returns:

Response Syntax

{
    'ContactArn': 'string',
    'ContactChannelArn': 'string',
    'Name': 'string',
    'Type': 'SMS'|'VOICE'|'EMAIL',
    'DeliveryAddress': {
        'SimpleAddress': 'string'
    },
    'ActivationStatus': 'ACTIVATED'|'NOT_ACTIVATED'
}

Response Structure

• (dict) –

  • ContactArn (string) –

    The ARN of the contact that the channel belongs to.

  • ContactChannelArn (string) –

    The ARN of the contact channel.

  • Name (string) –

    The name of the contact channel

  • Type (string) –

    The type of contact channel. The type is SMS, VOICE, or EMAIL.

  • 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

  • ActivationStatus (string) –

    A Boolean value indicating if the contact channel has been activated or not.

Exceptions

• SSMContacts.Client.exceptions.AccessDeniedException

• SSMContacts.Client.exceptions.DataEncryptionException

• SSMContacts.Client.exceptions.InternalServerException

• SSMContacts.Client.exceptions.ResourceNotFoundException

• SSMContacts.Client.exceptions.ThrottlingException

• SSMContacts.Client.exceptions.ValidationException

Examples

The following get-contact-channel example lists the details of a contact channel.

response = client.get_contact_channel(
    ContactChannelId='arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
)

print(response)

Expected Output:

{
    'ActivationStatus': 'ACTIVATED',
    'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
    'ContactChannelArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
    'DeliveryAddress': {
        'SimpleAddress': '+15005550199',
    },
    'Name': 'akuas sms',
    'Type': 'SMS',
    'ResponseMetadata': {
        '...': '...',
    },
}