describeHsmConfigurations method

Future<HsmConfigurationMessage> describeHsmConfigurations({ String? hsmConfigurationIdentifier, String? marker, int? maxRecords, List<String>? tagKeys, List<String>? tagValues, })

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.

May throw HsmConfigurationNotFoundFault. May throw InvalidTagFault.

Parameter hsmConfigurationIdentifier : The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.

Parameter marker : An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Parameter maxRecords : The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Parameter tagKeys : A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.

Parameter tagValues : A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

Implementation

Future<HsmConfigurationMessage> describeHsmConfigurations({
  String? hsmConfigurationIdentifier,
  String? marker,
  int? maxRecords,
  List<String>? tagKeys,
  List<String>? tagValues,
}) async {
  _s.validateStringLength(
    'hsmConfigurationIdentifier',
    hsmConfigurationIdentifier,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'marker',
    marker,
    0,
    2147483647,
  );
  final $request = <String, dynamic>{};
  hsmConfigurationIdentifier
      ?.also((arg) => $request['HsmConfigurationIdentifier'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  tagKeys?.also((arg) => $request['TagKeys'] = arg);
  tagValues?.also((arg) => $request['TagValues'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeHsmConfigurations',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeHsmConfigurationsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeHsmConfigurationsResult',
  );
  return HsmConfigurationMessage.fromXml($result);
}