describeGroup method

Future<DescribeGroupResponse> describeGroup({ required String awsAccountId, required String groupName, required String namespace, })

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

May throw AccessDeniedException. May throw InvalidParameterValueException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw PreconditionNotMetException. May throw InternalFailureException. May throw ResourceUnavailableException.

Parameter awsAccountId : The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Parameter groupName : The name of the group that you want to describe.

Parameter namespace : The namespace. Currently, you should set this to default.

Implementation

Future<DescribeGroupResponse> describeGroup({
  required String awsAccountId,
  required String groupName,
  required String namespace,
}) async {
  ArgumentError.checkNotNull(awsAccountId, 'awsAccountId');
  _s.validateStringLength(
    'awsAccountId',
    awsAccountId,
    12,
    12,
    isRequired: true,
  );
  ArgumentError.checkNotNull(groupName, 'groupName');
  _s.validateStringLength(
    'groupName',
    groupName,
    1,
    1152921504606846976,
    isRequired: true,
  );
  ArgumentError.checkNotNull(namespace, 'namespace');
  _s.validateStringLength(
    'namespace',
    namespace,
    0,
    64,
    isRequired: true,
  );
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/accounts/${Uri.encodeComponent(awsAccountId)}/namespaces/${Uri.encodeComponent(namespace)}/groups/${Uri.encodeComponent(groupName)}',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeGroupResponse.fromJson(response);
}