describeOrganizationConfigRuleStatuses method

Future<DescribeOrganizationConfigRuleStatusesResponse> describeOrganizationConfigRuleStatuses({ int? limit, String? nextToken, List<String>? organizationConfigRuleNames, })

Provides organization Config rule deployment status for an organization.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.

May throw InvalidLimitException. May throw InvalidNextTokenException. May throw NoSuchOrganizationConfigRuleException. May throw OrganizationAccessDeniedException.

Parameter limit : The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

Parameter nextToken : The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Parameter organizationConfigRuleNames : The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.

Implementation

Future<DescribeOrganizationConfigRuleStatusesResponse>
    describeOrganizationConfigRuleStatuses({
  int? limit,
  String? nextToken,
  List<String>? organizationConfigRuleNames,
}) async {
  _s.validateNumRange(
    'limit',
    limit,
    0,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'StarlingDoveService.DescribeOrganizationConfigRuleStatuses'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (limit != null) 'Limit': limit,
      if (nextToken != null) 'NextToken': nextToken,
      if (organizationConfigRuleNames != null)
        'OrganizationConfigRuleNames': organizationConfigRuleNames,
    },
  );

  return DescribeOrganizationConfigRuleStatusesResponse.fromJson(
      jsonResponse.body);
}