describeWorkforce method

Future<DescribeWorkforceResponse> describeWorkforce({
  1. required String workforceName,
})

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

Parameter workforceName : The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

Implementation

Future<DescribeWorkforceResponse> describeWorkforce({
  required String workforceName,
}) async {
  ArgumentError.checkNotNull(workforceName, 'workforceName');
  _s.validateStringLength(
    'workforceName',
    workforceName,
    1,
    63,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'SageMaker.DescribeWorkforce'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'WorkforceName': workforceName,
    },
  );

  return DescribeWorkforceResponse.fromJson(jsonResponse.body);
}