Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Redshift.DescribeResize

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.

A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.

Synopsis

Creating a Request

data DescribeResize Source #

See: newDescribeResize smart constructor.

Constructors

DescribeResize'
Fields clusterIdentifier :: Text The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. By default, resize operations for all clusters defined for an Amazon Web Services account are returned.

Instances

Instances details

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

newDescribeResize Source #

Arguments

:: Text	`$sel:clusterIdentifier:DescribeResize'`
-> DescribeResize

Create a value of DescribeResize 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:

$sel:clusterIdentifier:DescribeResize', describeResize_clusterIdentifier - The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

By default, resize operations for all clusters defined for an Amazon Web Services account are returned.

Request Lenses

describeResize_clusterIdentifier :: Lens' DescribeResize Text Source #

The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

By default, resize operations for all clusters defined for an Amazon Web Services account are returned.

Destructuring the Response

data ResizeProgressMessage Source #

Describes the result of a cluster resize operation.

See: newResizeProgressMessage smart constructor.

Constructors

ResizeProgressMessage'

Fields

importTablesNotStarted :: Maybe [Text]
The names of tables that have not been yet imported.
Valid Values: List of table names
status :: Maybe Text
The status of the resize operation.
Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING
estimatedTimeToCompletionInSeconds :: Maybe Integer
The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.
avgResizeRateInMegaBytesPerSecond :: Maybe Double
The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.
targetNumberOfNodes :: Maybe Int
The number of nodes that the cluster will have after the resize operation is complete.
targetEncryptionType :: Maybe Text
The type of encryption for the cluster after the resize is complete.
Possible values are KMS and None.
targetNodeType :: Maybe Text
The node type that the cluster will have after the resize operation is complete.
importTablesInProgress :: Maybe [Text]
The names of tables that are being currently imported.
Valid Values: List of table names.
resizeType :: Maybe Text
An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.
importTablesCompleted :: Maybe [Text]
The names of tables that have been completely imported .
Valid Values: List of table names.
progressInMegaBytes :: Maybe Integer
While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).
dataTransferProgressPercent :: Maybe Double
The percent of data transferred from source cluster to target cluster.
totalResizeDataInMegaBytes :: Maybe Integer
The estimated total amount of data, in megabytes, on the cluster before the resize operation began.
targetClusterType :: Maybe Text
The cluster type after the resize operation is complete.
Valid Values: multi-node | single-node
message :: Maybe Text
An optional string to provide additional details about the resize action.
elapsedTimeInSeconds :: Maybe Integer
The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

Instances

Instances details

Eq ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods (==) :: ResizeProgressMessage -> ResizeProgressMessage -> Bool # (/=) :: ResizeProgressMessage -> ResizeProgressMessage -> Bool #
Read ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods readsPrec :: Int -> ReadS ResizeProgressMessage # readList :: ReadS [ResizeProgressMessage] # readPrec :: ReadPrec ResizeProgressMessage # readListPrec :: ReadPrec [ResizeProgressMessage] #
Show ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods showsPrec :: Int -> ResizeProgressMessage -> ShowS # show :: ResizeProgressMessage -> String # showList :: [ResizeProgressMessage] -> ShowS #
Generic ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Associated Types type Rep ResizeProgressMessage :: Type -> Type # Methods from :: ResizeProgressMessage -> Rep ResizeProgressMessage x # to :: Rep ResizeProgressMessage x -> ResizeProgressMessage #
NFData ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods rnf :: ResizeProgressMessage -> () #
Hashable ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods hashWithSalt :: Int -> ResizeProgressMessage -> Int # hash :: ResizeProgressMessage -> Int #
FromXML ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods parseXML :: [Node] -> Either String ResizeProgressMessage #
type Rep ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage type Rep ResizeProgressMessage = D1 ('MetaData "ResizeProgressMessage" "Amazonka.Redshift.Types.ResizeProgressMessage" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "ResizeProgressMessage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "importTablesNotStarted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "estimatedTimeToCompletionInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "avgResizeRateInMegaBytesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :: ((S1 ('MetaSel ('Just "targetNumberOfNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "targetEncryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "targetNodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "importTablesInProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: (((S1 ('MetaSel ('Just "resizeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "importTablesCompleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "progressInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "dataTransferProgressPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :: ((S1 ('MetaSel ('Just "totalResizeDataInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "targetClusterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "elapsedTimeInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))))

newResizeProgressMessage :: ResizeProgressMessage Source #

Create a value of ResizeProgressMessage 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:

$sel:importTablesNotStarted:ResizeProgressMessage', resizeProgressMessage_importTablesNotStarted - The names of tables that have not been yet imported.

Valid Values: List of table names

$sel:status:ResizeProgressMessage', resizeProgressMessage_status - The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

$sel:estimatedTimeToCompletionInSeconds:ResizeProgressMessage', resizeProgressMessage_estimatedTimeToCompletionInSeconds - The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

$sel:avgResizeRateInMegaBytesPerSecond:ResizeProgressMessage', resizeProgressMessage_avgResizeRateInMegaBytesPerSecond - The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

$sel:targetNumberOfNodes:ResizeProgressMessage', resizeProgressMessage_targetNumberOfNodes - The number of nodes that the cluster will have after the resize operation is complete.

$sel:targetEncryptionType:ResizeProgressMessage', resizeProgressMessage_targetEncryptionType - The type of encryption for the cluster after the resize is complete.

Possible values are KMS and None.

$sel:targetNodeType:ResizeProgressMessage', resizeProgressMessage_targetNodeType - The node type that the cluster will have after the resize operation is complete.

$sel:importTablesInProgress:ResizeProgressMessage', resizeProgressMessage_importTablesInProgress - The names of tables that are being currently imported.

Valid Values: List of table names.

$sel:resizeType:ResizeProgressMessage', resizeProgressMessage_resizeType - An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

$sel:importTablesCompleted:ResizeProgressMessage', resizeProgressMessage_importTablesCompleted - The names of tables that have been completely imported .

Valid Values: List of table names.

$sel:progressInMegaBytes:ResizeProgressMessage', resizeProgressMessage_progressInMegaBytes - While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

$sel:dataTransferProgressPercent:ResizeProgressMessage', resizeProgressMessage_dataTransferProgressPercent - The percent of data transferred from source cluster to target cluster.

$sel:totalResizeDataInMegaBytes:ResizeProgressMessage', resizeProgressMessage_totalResizeDataInMegaBytes - The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

$sel:targetClusterType:ResizeProgressMessage', resizeProgressMessage_targetClusterType - The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

$sel:message:ResizeProgressMessage', resizeProgressMessage_message - An optional string to provide additional details about the resize action.

$sel:elapsedTimeInSeconds:ResizeProgressMessage', resizeProgressMessage_elapsedTimeInSeconds - The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

Response Lenses

resizeProgressMessage_importTablesNotStarted :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that have not been yet imported.

Valid Values: List of table names

resizeProgressMessage_status :: Lens' ResizeProgressMessage (Maybe Text) Source #

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

resizeProgressMessage_estimatedTimeToCompletionInSeconds :: Lens' ResizeProgressMessage (Maybe Integer) Source #

The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

resizeProgressMessage_avgResizeRateInMegaBytesPerSecond :: Lens' ResizeProgressMessage (Maybe Double) Source #

The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

resizeProgressMessage_targetNumberOfNodes :: Lens' ResizeProgressMessage (Maybe Int) Source #

The number of nodes that the cluster will have after the resize operation is complete.

resizeProgressMessage_targetEncryptionType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The type of encryption for the cluster after the resize is complete.

Possible values are KMS and None.

resizeProgressMessage_targetNodeType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The node type that the cluster will have after the resize operation is complete.

resizeProgressMessage_importTablesInProgress :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that are being currently imported.

Valid Values: List of table names.

resizeProgressMessage_resizeType :: Lens' ResizeProgressMessage (Maybe Text) Source #

An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

resizeProgressMessage_importTablesCompleted :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that have been completely imported .

Valid Values: List of table names.

resizeProgressMessage_progressInMegaBytes :: Lens' ResizeProgressMessage (Maybe Integer) Source #

While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

resizeProgressMessage_dataTransferProgressPercent :: Lens' ResizeProgressMessage (Maybe Double) Source #

The percent of data transferred from source cluster to target cluster.

resizeProgressMessage_totalResizeDataInMegaBytes :: Lens' ResizeProgressMessage (Maybe Integer) Source #

The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

resizeProgressMessage_targetClusterType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

resizeProgressMessage_message :: Lens' ResizeProgressMessage (Maybe Text) Source #

An optional string to provide additional details about the resize action.

resizeProgressMessage_elapsedTimeInSeconds :: Lens' ResizeProgressMessage (Maybe Integer) Source #

The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.