describeSnapshotCopyGrants method

Future<SnapshotCopyGrantMessage> describeSnapshotCopyGrants({ String? marker, int? maxRecords, String? snapshotCopyGrantName, List<String>? tagKeys, List<String>? tagValues, })

Returns a list of snapshot copy grants owned by the AWS account in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

May throw SnapshotCopyGrantNotFoundFault. May throw InvalidTagFault.

Parameter marker : An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant 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.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

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 snapshotCopyGrantName : The name of the snapshot copy grant.

Parameter tagKeys : A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources 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 resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Implementation

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