describeStandardsControls method

Future<DescribeStandardsControlsResponse> describeStandardsControls({ required String standardsSubscriptionArn, int? maxResults, String? nextToken, })

Returns a list of security standards controls.

For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.

May throw InternalException. May throw InvalidInputException. May throw InvalidAccessException. May throw ResourceNotFoundException.

Parameter standardsSubscriptionArn : The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of the standards you have enabled, use the GetEnabledStandards operation.

Parameter maxResults : The maximum number of security standard controls to return.

Parameter nextToken : The token that is required for pagination. On your first call to the DescribeStandardsControls operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Implementation

Future<DescribeStandardsControlsResponse> describeStandardsControls({
  required String standardsSubscriptionArn,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(
      standardsSubscriptionArn, 'standardsSubscriptionArn');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'MaxResults': [maxResults.toString()],
    if (nextToken != null) 'NextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/standards/controls/${standardsSubscriptionArn.split('/').map(Uri.encodeComponent).join('/')}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeStandardsControlsResponse.fromJson(response);
}