describeTableRestoreStatus method

Future<TableRestoreStatusMessage> describeTableRestoreStatus({String? clusterIdentifier, String? marker, int? maxRecords, String? tableRestoreRequestId})

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.

May throw TableRestoreNotFoundFault. May throw ClusterNotFoundFault.

Parameter clusterIdentifier : The Amazon Redshift cluster that the table is being restored to.

Parameter marker : An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Parameter maxRecords : The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Parameter tableRestoreRequestId : The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

Implementation

Future<TableRestoreStatusMessage> describeTableRestoreStatus({
  String? clusterIdentifier,
  String? marker,
  int? maxRecords,
  String? tableRestoreRequestId,
}) async {
  _s.validateStringLength(
    'clusterIdentifier',
    clusterIdentifier,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'marker',
    marker,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'tableRestoreRequestId',
    tableRestoreRequestId,
    0,
    2147483647,
  );
  final $request = <String, dynamic>{};
  clusterIdentifier?.also((arg) => $request['ClusterIdentifier'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  tableRestoreRequestId
      ?.also((arg) => $request['TableRestoreRequestId'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeTableRestoreStatus',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeTableRestoreStatusMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeTableRestoreStatusResult',
  );
  return TableRestoreStatusMessage.fromXml($result);
}