listKeys method

Future<ListKeysResponse> listKeys({ int? limit, String? marker, })

Gets a list of all customer master keys (CMKs) in the caller's AWS account and Region.

Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

Required permissions: kms:ListKeys (IAM policy)

Related operations:

• CreateKey
• DescribeKey
• ListAliases
• ListResourceTags

May throw DependencyTimeoutException. May throw KMSInternalException. May throw InvalidMarkerException.

Parameter limit : Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Parameter marker : Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Implementation

Future<ListKeysResponse> listKeys({
  int? limit,
  String? marker,
}) async {
  _s.validateNumRange(
    'limit',
    limit,
    1,
    1000,
  );
  _s.validateStringLength(
    'marker',
    marker,
    1,
    1024,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'TrentService.ListKeys'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (limit != null) 'Limit': limit,
      if (marker != null) 'Marker': marker,
    },
  );

  return ListKeysResponse.fromJson(jsonResponse.body);
}