| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Redshift.DescribeTableRestoreStatus
Description
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.
This operation returns paginated results.
Synopsis
- data DescribeTableRestoreStatus = DescribeTableRestoreStatus' {}
- newDescribeTableRestoreStatus :: DescribeTableRestoreStatus
- describeTableRestoreStatus_clusterIdentifier :: Lens' DescribeTableRestoreStatus (Maybe Text)
- describeTableRestoreStatus_marker :: Lens' DescribeTableRestoreStatus (Maybe Text)
- describeTableRestoreStatus_maxRecords :: Lens' DescribeTableRestoreStatus (Maybe Int)
- describeTableRestoreStatus_tableRestoreRequestId :: Lens' DescribeTableRestoreStatus (Maybe Text)
- data DescribeTableRestoreStatusResponse = DescribeTableRestoreStatusResponse' {}
- newDescribeTableRestoreStatusResponse :: Int -> DescribeTableRestoreStatusResponse
- describeTableRestoreStatusResponse_marker :: Lens' DescribeTableRestoreStatusResponse (Maybe Text)
- describeTableRestoreStatusResponse_tableRestoreStatusDetails :: Lens' DescribeTableRestoreStatusResponse (Maybe [TableRestoreStatus])
- describeTableRestoreStatusResponse_httpStatus :: Lens' DescribeTableRestoreStatusResponse Int
Creating a Request
data DescribeTableRestoreStatus Source #
See: newDescribeTableRestoreStatus smart constructor.
Constructors
| DescribeTableRestoreStatus' | |
Fields
| |
Instances
newDescribeTableRestoreStatus :: DescribeTableRestoreStatus Source #
Create a value of DescribeTableRestoreStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTableRestoreStatus, describeTableRestoreStatus_clusterIdentifier - The Amazon Redshift cluster that the table is being restored to.
DescribeTableRestoreStatus, describeTableRestoreStatus_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.
$sel:maxRecords:DescribeTableRestoreStatus', describeTableRestoreStatus_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.
DescribeTableRestoreStatus, describeTableRestoreStatus_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.
Request Lenses
describeTableRestoreStatus_clusterIdentifier :: Lens' DescribeTableRestoreStatus (Maybe Text) Source #
The Amazon Redshift cluster that the table is being restored to.
describeTableRestoreStatus_marker :: Lens' DescribeTableRestoreStatus (Maybe Text) Source #
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.
describeTableRestoreStatus_maxRecords :: Lens' DescribeTableRestoreStatus (Maybe Int) Source #
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.
describeTableRestoreStatus_tableRestoreRequestId :: Lens' DescribeTableRestoreStatus (Maybe Text) Source #
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.
Destructuring the Response
data DescribeTableRestoreStatusResponse Source #
See: newDescribeTableRestoreStatusResponse smart constructor.
Constructors
| DescribeTableRestoreStatusResponse' | |
Fields
| |
Instances
newDescribeTableRestoreStatusResponse Source #
Arguments
| :: Int | |
| -> DescribeTableRestoreStatusResponse |
Create a value of DescribeTableRestoreStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTableRestoreStatus, describeTableRestoreStatusResponse_marker - A pagination token that can be used in a subsequent
DescribeTableRestoreStatus request.
$sel:tableRestoreStatusDetails:DescribeTableRestoreStatusResponse', describeTableRestoreStatusResponse_tableRestoreStatusDetails - A list of status details for one or more table restore requests.
$sel:httpStatus:DescribeTableRestoreStatusResponse', describeTableRestoreStatusResponse_httpStatus - The response's http status code.
Response Lenses
describeTableRestoreStatusResponse_marker :: Lens' DescribeTableRestoreStatusResponse (Maybe Text) Source #
A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.
describeTableRestoreStatusResponse_tableRestoreStatusDetails :: Lens' DescribeTableRestoreStatusResponse (Maybe [TableRestoreStatus]) Source #
A list of status details for one or more table restore requests.
describeTableRestoreStatusResponse_httpStatus :: Lens' DescribeTableRestoreStatusResponse Int Source #
The response's http status code.