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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Creating a Request

data DescribeTableRestoreStatus Source #

See: newDescribeTableRestoreStatus smart constructor.

Constructors

DescribeTableRestoreStatus'

Fields

clusterIdentifier :: Maybe Text
The Amazon Redshift cluster that the table is being restored to.
marker :: Maybe Text
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.
maxRecords :: Maybe Int
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.
tableRestoreRequestId :: Maybe Text
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.

Instances

Instances details

ToHeaders DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods toHeaders :: DescribeTableRestoreStatus -> [Header] #
ToPath DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods toPath :: DescribeTableRestoreStatus -> ByteString #
ToQuery DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods toQuery :: DescribeTableRestoreStatus -> QueryString #
AWSPager DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods page :: DescribeTableRestoreStatus -> AWSResponse DescribeTableRestoreStatus -> Maybe DescribeTableRestoreStatus #
AWSRequest DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Associated Types type AWSResponse DescribeTableRestoreStatus # Methods request :: (Service -> Service) -> DescribeTableRestoreStatus -> Request DescribeTableRestoreStatus # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTableRestoreStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTableRestoreStatus))) #
Generic DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Associated Types type Rep DescribeTableRestoreStatus :: Type -> Type # Methods from :: DescribeTableRestoreStatus -> Rep DescribeTableRestoreStatus x # to :: Rep DescribeTableRestoreStatus x -> DescribeTableRestoreStatus #
Read DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods readsPrec :: Int -> ReadS DescribeTableRestoreStatus # readList :: ReadS [DescribeTableRestoreStatus] # readPrec :: ReadPrec DescribeTableRestoreStatus # readListPrec :: ReadPrec [DescribeTableRestoreStatus] #
Show DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods showsPrec :: Int -> DescribeTableRestoreStatus -> ShowS # show :: DescribeTableRestoreStatus -> String # showList :: [DescribeTableRestoreStatus] -> ShowS #
NFData DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods rnf :: DescribeTableRestoreStatus -> () #
Eq DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods (==) :: DescribeTableRestoreStatus -> DescribeTableRestoreStatus -> Bool # (/=) :: DescribeTableRestoreStatus -> DescribeTableRestoreStatus -> Bool #
Hashable DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods hashWithSalt :: Int -> DescribeTableRestoreStatus -> Int # hash :: DescribeTableRestoreStatus -> Int #
type AWSResponse DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus type AWSResponse DescribeTableRestoreStatus = DescribeTableRestoreStatusResponse
type Rep DescribeTableRestoreStatus Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus type Rep DescribeTableRestoreStatus = D1 ('MetaData "DescribeTableRestoreStatus" "Amazonka.Redshift.DescribeTableRestoreStatus" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeTableRestoreStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "tableRestoreRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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 marker :: Maybe Text A pagination token that can be used in a subsequent DescribeTableRestoreStatus request. tableRestoreStatusDetails :: Maybe [TableRestoreStatus] A list of status details for one or more table restore requests. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeTableRestoreStatusResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Associated Types type Rep DescribeTableRestoreStatusResponse :: Type -> Type # Methods from :: DescribeTableRestoreStatusResponse -> Rep DescribeTableRestoreStatusResponse x # to :: Rep DescribeTableRestoreStatusResponse x -> DescribeTableRestoreStatusResponse #
Read DescribeTableRestoreStatusResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods readsPrec :: Int -> ReadS DescribeTableRestoreStatusResponse # readList :: ReadS [DescribeTableRestoreStatusResponse] # readPrec :: ReadPrec DescribeTableRestoreStatusResponse # readListPrec :: ReadPrec [DescribeTableRestoreStatusResponse] #
Show DescribeTableRestoreStatusResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods showsPrec :: Int -> DescribeTableRestoreStatusResponse -> ShowS # show :: DescribeTableRestoreStatusResponse -> String # showList :: [DescribeTableRestoreStatusResponse] -> ShowS #
NFData DescribeTableRestoreStatusResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods rnf :: DescribeTableRestoreStatusResponse -> () #
Eq DescribeTableRestoreStatusResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus Methods (==) :: DescribeTableRestoreStatusResponse -> DescribeTableRestoreStatusResponse -> Bool # (/=) :: DescribeTableRestoreStatusResponse -> DescribeTableRestoreStatusResponse -> Bool #
type Rep DescribeTableRestoreStatusResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTableRestoreStatus type Rep DescribeTableRestoreStatusResponse = D1 ('MetaData "DescribeTableRestoreStatusResponse" "Amazonka.Redshift.DescribeTableRestoreStatus" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeTableRestoreStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tableRestoreStatusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TableRestoreStatus])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTableRestoreStatusResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTableRestoreStatusResponse'`
-> 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.