SSMContacts / Client / describe_engagement

describe_engagement

SSMContacts.Client.describe_engagement(**kwargs)

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

See also: AWS API Documentation

Request Syntax

response = client.describe_engagement(
    EngagementId='string'
)

Parameters:

EngagementId (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the engagement you want the details of.

Return type:

dict

Returns:

Response Syntax

{
    'ContactArn': 'string',
    'EngagementArn': 'string',
    'Sender': 'string',
    'Subject': 'string',
    'Content': 'string',
    'PublicSubject': 'string',
    'PublicContent': 'string',
    'IncidentId': 'string',
    'StartTime': datetime(2015, 1, 1),
    'StopTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • ContactArn (string) –

    The ARN of the escalation plan or contacts involved in the engagement.

  • EngagementArn (string) –

    The ARN of the engagement.

  • Sender (string) –

    The user that started the engagement.

  • Subject (string) –

    The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

  • Content (string) –

    The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

  • PublicSubject (string) –

    The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

  • PublicContent (string) –

    The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

  • IncidentId (string) –

    The ARN of the incident in which the engagement occurred.

  • StartTime (datetime) –

    The time that the engagement started.

  • StopTime (datetime) –

    The time that the engagement ended.

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 describe-engagement example lists the details of an engagement to a contact or escalation plan. The subject and content are sent to the contact channels.

response = client.describe_engagement(
    EngagementId='arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
)

print(response)

Expected Output:

{
    'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
    'Content': 'Testing engagements',
    'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
    'PublicContent': 'Testing engagements',
    'PublicSubject': 'test',
    'Sender': 'tester',
    'StartTime': datetime(2021, 5, 18, 18, 25, 41, 1, 138, 0),
    'Subject': 'test',
    'ResponseMetadata': {
        '...': '...',
    },
}