| 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.BatchModifyClusterSnapshots
Description
Modifies the settings for a set of cluster snapshots.
Synopsis
- data BatchModifyClusterSnapshots = BatchModifyClusterSnapshots' {}
- newBatchModifyClusterSnapshots :: BatchModifyClusterSnapshots
- batchModifyClusterSnapshots_manualSnapshotRetentionPeriod :: Lens' BatchModifyClusterSnapshots (Maybe Int)
- batchModifyClusterSnapshots_force :: Lens' BatchModifyClusterSnapshots (Maybe Bool)
- batchModifyClusterSnapshots_snapshotIdentifierList :: Lens' BatchModifyClusterSnapshots [Text]
- data BatchModifyClusterSnapshotsResponse = BatchModifyClusterSnapshotsResponse' {
- resources :: Maybe [Text]
- errors :: Maybe [SnapshotErrorMessage]
- httpStatus :: Int
- newBatchModifyClusterSnapshotsResponse :: Int -> BatchModifyClusterSnapshotsResponse
- batchModifyClusterSnapshotsResponse_resources :: Lens' BatchModifyClusterSnapshotsResponse (Maybe [Text])
- batchModifyClusterSnapshotsResponse_errors :: Lens' BatchModifyClusterSnapshotsResponse (Maybe [SnapshotErrorMessage])
- batchModifyClusterSnapshotsResponse_httpStatus :: Lens' BatchModifyClusterSnapshotsResponse Int
Creating a Request
data BatchModifyClusterSnapshots Source #
See: newBatchModifyClusterSnapshots smart constructor.
Constructors
| BatchModifyClusterSnapshots' | |
Fields
| |
Instances
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:manualSnapshotRetentionPeriod: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:force:BatchModifyClusterSnapshots', batchModifyClusterSnapshots_force - A boolean value indicating whether to override an exception if the
retention period has passed.
$sel:snapshotIdentifierList:BatchModifyClusterSnapshots', batchModifyClusterSnapshots_snapshotIdentifierList - A list of snapshot identifiers you want to modify.
Request Lenses
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.
batchModifyClusterSnapshots_force :: Lens' BatchModifyClusterSnapshots (Maybe Bool) Source #
A boolean value indicating whether to override an exception if the retention period has passed.
batchModifyClusterSnapshots_snapshotIdentifierList :: Lens' BatchModifyClusterSnapshots [Text] Source #
A list of snapshot identifiers you want to modify.
Destructuring the Response
data BatchModifyClusterSnapshotsResponse Source #
See: newBatchModifyClusterSnapshotsResponse smart constructor.
Constructors
| BatchModifyClusterSnapshotsResponse' | |
Fields
| |
Instances
newBatchModifyClusterSnapshotsResponse Source #
Arguments
| :: Int | |
| -> BatchModifyClusterSnapshotsResponse |
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:resources:BatchModifyClusterSnapshotsResponse', batchModifyClusterSnapshotsResponse_resources - A list of the snapshots that were modified.
$sel:errors:BatchModifyClusterSnapshotsResponse', batchModifyClusterSnapshotsResponse_errors - A list of any errors returned.
$sel:httpStatus:BatchModifyClusterSnapshotsResponse', batchModifyClusterSnapshotsResponse_httpStatus - The response's http status code.
Response Lenses
batchModifyClusterSnapshotsResponse_resources :: Lens' BatchModifyClusterSnapshotsResponse (Maybe [Text]) Source #
A list of the snapshots that were modified.
batchModifyClusterSnapshotsResponse_errors :: Lens' BatchModifyClusterSnapshotsResponse (Maybe [SnapshotErrorMessage]) Source #
A list of any errors returned.
batchModifyClusterSnapshotsResponse_httpStatus :: Lens' BatchModifyClusterSnapshotsResponse Int Source #
The response's http status code.