amazonka-redshift-2.0: Amazon Redshift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Redshift.BatchModifyClusterSnapshots

Description

Modifies the settings for a set of cluster snapshots.

Synopsis

Creating a Request

data BatchModifyClusterSnapshots Source #

See: newBatchModifyClusterSnapshots smart constructor.

Constructors

BatchModifyClusterSnapshots' 

Fields

  • force :: Maybe Bool

    A boolean value indicating whether to override an exception if the retention period has passed.

  • manualSnapshotRetentionPeriod :: Maybe Int

    The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

    The number must be either -1 or an integer between 1 and 3,653.

    If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

  • snapshotIdentifierList :: [Text]

    A list of snapshot identifiers you want to modify.

Instances

Instances details
ToHeaders BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

ToPath BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

ToQuery BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

AWSRequest BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

Generic BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

Associated Types

type Rep BatchModifyClusterSnapshots :: Type -> Type #

Read BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

Show BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

NFData BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

Eq BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

Hashable BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

type AWSResponse BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

type Rep BatchModifyClusterSnapshots Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

type Rep BatchModifyClusterSnapshots = D1 ('MetaData "BatchModifyClusterSnapshots" "Amazonka.Redshift.BatchModifyClusterSnapshots" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "BatchModifyClusterSnapshots'" 'PrefixI 'True) (S1 ('MetaSel ('Just "force") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "manualSnapshotRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "snapshotIdentifierList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newBatchModifyClusterSnapshots :: BatchModifyClusterSnapshots Source #

Create a value of BatchModifyClusterSnapshots 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:force:BatchModifyClusterSnapshots', batchModifyClusterSnapshots_force - A boolean value indicating whether to override an exception if the retention period has passed.

BatchModifyClusterSnapshots, batchModifyClusterSnapshots_manualSnapshotRetentionPeriod - The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

The number must be either -1 or an integer between 1 and 3,653.

If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

$sel:snapshotIdentifierList:BatchModifyClusterSnapshots', batchModifyClusterSnapshots_snapshotIdentifierList - A list of snapshot identifiers you want to modify.

Request Lenses

batchModifyClusterSnapshots_force :: Lens' BatchModifyClusterSnapshots (Maybe Bool) Source #

A boolean value indicating whether to override an exception if the retention period has passed.

batchModifyClusterSnapshots_manualSnapshotRetentionPeriod :: Lens' BatchModifyClusterSnapshots (Maybe Int) Source #

The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

The number must be either -1 or an integer between 1 and 3,653.

If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

Destructuring the Response

data BatchModifyClusterSnapshotsResponse Source #

Constructors

BatchModifyClusterSnapshotsResponse' 

Fields

Instances

Instances details
Generic BatchModifyClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

Read BatchModifyClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

Show BatchModifyClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

NFData BatchModifyClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

Eq BatchModifyClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

type Rep BatchModifyClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Redshift.BatchModifyClusterSnapshots

type Rep BatchModifyClusterSnapshotsResponse = D1 ('MetaData "BatchModifyClusterSnapshotsResponse" "Amazonka.Redshift.BatchModifyClusterSnapshots" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "BatchModifyClusterSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SnapshotErrorMessage])) :*: (S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchModifyClusterSnapshotsResponse Source #

Create a value of BatchModifyClusterSnapshotsResponse 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:errors:BatchModifyClusterSnapshotsResponse', batchModifyClusterSnapshotsResponse_errors - A list of any errors returned.

$sel:resources:BatchModifyClusterSnapshotsResponse', batchModifyClusterSnapshotsResponse_resources - A list of the snapshots that were modified.

$sel:httpStatus:BatchModifyClusterSnapshotsResponse', batchModifyClusterSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses