Describe Table Restore Status

redshift_describe_table_restore_status

R Documentation

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action¶

Description¶

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

Usage¶

redshift_describe_table_restore_status(ClusterIdentifier,
  TableRestoreRequestId, MaxRecords, Marker)

Arguments¶

ClusterIdentifier

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

TableRestoreRequestId

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

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.

Marker

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

Value¶

A list with the following syntax:

list(
  TableRestoreStatusDetails = list(
    list(
      TableRestoreRequestId = "string",
      Status = "PENDING"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"CANCELED",
      Message = "string",
      RequestTime = as.POSIXct(
        "2015-01-01"
      ),
      ProgressInMegaBytes = 123,
      TotalDataInMegaBytes = 123,
      ClusterIdentifier = "string",
      SnapshotIdentifier = "string",
      SourceDatabaseName = "string",
      SourceSchemaName = "string",
      SourceTableName = "string",
      TargetDatabaseName = "string",
      TargetSchemaName = "string",
      NewTableName = "string"
    )
  ),
  Marker = "string"
)

Request syntax¶

svc$describe_table_restore_status(
  ClusterIdentifier = "string",
  TableRestoreRequestId = "string",
  MaxRecords = 123,
  Marker = "string"
)