describeEngagement method

Future<DescribeEngagementResult> describeEngagement({
  1. required String engagementId,
})

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.

May throw AccessDeniedException. May throw DataEncryptionException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

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

Implementation

Future<DescribeEngagementResult> describeEngagement({
  required String engagementId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'SSMContacts.DescribeEngagement'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'EngagementId': engagementId,
    },
  );

  return DescribeEngagementResult.fromJson(jsonResponse.body);
}