describeEntity method

Future<DescribeEntityResponse> describeEntity({ required String email, required String organizationId, })

Returns basic details about an entity in WorkMail.

May throw EntityNotFoundException. May throw InvalidParameterException. May throw OrganizationNotFoundException. May throw OrganizationStateException.

Parameter email : The email under which the entity exists.

Parameter organizationId : The identifier for the organization under which the entity exists.

Implementation

Future<DescribeEntityResponse> describeEntity({
  required String email,
  required String organizationId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'WorkMailService.DescribeEntity'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Email': email,
      'OrganizationId': organizationId,
    },
  );

  return DescribeEntityResponse.fromJson(jsonResponse.body);
}