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.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

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 #
AWSRequest DescribeResize Source #
Instance details Defined in Amazonka.Redshift.DescribeResize Associated Types type AWSResponse DescribeResize # Methods request :: (Service -> Service) -> DescribeResize -> Request DescribeResize # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeResize -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeResize))) #
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 #
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 #
NFData DescribeResize Source #
Instance details Defined in Amazonka.Redshift.DescribeResize Methods rnf :: DescribeResize -> () #
Eq DescribeResize Source #
Instance details Defined in Amazonka.Redshift.DescribeResize Methods (==) :: DescribeResize -> DescribeResize -> Bool # (/=) :: DescribeResize -> DescribeResize -> Bool #
Hashable DescribeResize Source #
Instance details Defined in Amazonka.Redshift.DescribeResize Methods hashWithSalt :: Int -> DescribeResize -> Int # hash :: DescribeResize -> Int #
type AWSResponse DescribeResize Source #
Instance details Defined in Amazonka.Redshift.DescribeResize type AWSResponse DescribeResize = ResizeProgressMessage
type Rep DescribeResize Source #
Instance details Defined in Amazonka.Redshift.DescribeResize type Rep DescribeResize = D1 ('MetaData "DescribeResize" "Amazonka.Redshift.DescribeResize" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeResize'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeResize Source #

Arguments

:: Text	`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:

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

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.
dataTransferProgressPercent :: Maybe Double
The percent of data transferred from source cluster to target cluster.
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.
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.
importTablesCompleted :: Maybe [Text]
The names of tables that have been completely imported .
Valid Values: List of table names.
importTablesInProgress :: Maybe [Text]
The names of tables that are being currently imported.
Valid Values: List of table names.
importTablesNotStarted :: Maybe [Text]
The names of tables that have not been yet imported.
Valid Values: List of table names
message :: Maybe Text
An optional string to provide additional details about the resize action.
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).
resizeType :: Maybe Text
An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.
status :: Maybe Text
The status of the resize operation.
Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING
targetClusterType :: Maybe Text
The cluster type after the resize operation is complete.
Valid Values: multi-node | single-node
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.
targetNumberOfNodes :: Maybe Int
The number of nodes that the cluster will have after the resize operation is complete.
totalResizeDataInMegaBytes :: Maybe Integer
The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

Instances

Instances details

FromXML ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods parseXML :: [Node] -> Either String ResizeProgressMessage #
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 #
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 #
NFData ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods rnf :: ResizeProgressMessage -> () #
Eq ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods (==) :: ResizeProgressMessage -> ResizeProgressMessage -> Bool # (/=) :: ResizeProgressMessage -> ResizeProgressMessage -> Bool #
Hashable ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage Methods hashWithSalt :: Int -> ResizeProgressMessage -> Int # hash :: ResizeProgressMessage -> Int #
type Rep ResizeProgressMessage Source #
Instance details Defined in Amazonka.Redshift.Types.ResizeProgressMessage type Rep ResizeProgressMessage = D1 ('MetaData "ResizeProgressMessage" "Amazonka.Redshift.Types.ResizeProgressMessage" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "ResizeProgressMessage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "avgResizeRateInMegaBytesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "dataTransferProgressPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "elapsedTimeInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "estimatedTimeToCompletionInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "importTablesCompleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "importTablesInProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "importTablesNotStarted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "progressInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "resizeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "targetClusterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "targetEncryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "targetNodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "targetNumberOfNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "totalResizeDataInMegaBytes") '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: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:dataTransferProgressPercent:ResizeProgressMessage', resizeProgressMessage_dataTransferProgressPercent - The percent of data transferred from source cluster to target cluster.

$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.

$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:importTablesCompleted:ResizeProgressMessage', resizeProgressMessage_importTablesCompleted - The names of tables that have been completely imported .

Valid Values: List of table names.

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

Valid Values: List of table names.

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

Valid Values: List of table names

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

$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:resizeType:ResizeProgressMessage', resizeProgressMessage_resizeType - An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

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

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

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

Valid Values: multi-node | single-node

$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:targetNumberOfNodes:ResizeProgressMessage', resizeProgressMessage_targetNumberOfNodes - The number of nodes that the cluster will have after the resize operation is complete.

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

Response Lenses

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_dataTransferProgressPercent :: Lens' ResizeProgressMessage (Maybe Double) Source #

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

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.

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_importTablesCompleted :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that have been completely imported .

Valid Values: List of table names.

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

The names of tables that are being currently imported.

Valid Values: List of table names.

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

The names of tables that have not been yet imported.

Valid Values: List of table names

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

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

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_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_status :: Lens' ResizeProgressMessage (Maybe Text) Source #

The status of the resize operation.

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

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

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

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_targetNumberOfNodes :: Lens' ResizeProgressMessage (Maybe Int) Source #

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

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

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