describeUser method

Future<DescribeUserResponse> describeUser({
  1. required String instanceId,
  2. required String userId,
})

Describes the specified user. You can find the instance ID in the Connect Customer console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

May throw InternalServiceException. May throw InvalidParameterException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

Parameter instanceId : The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameter userId : The identifier of the user account.

Implementation

Future<DescribeUserResponse> describeUser({
  required String instanceId,
  required String userId,
}) async {
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/users/${Uri.encodeComponent(instanceId)}/${Uri.encodeComponent(userId)}',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeUserResponse.fromJson(response);
}