Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

Request Parameters

For information about the parameters that are common to all actions, seeCommon Parameters.

Response Elements

The following element is returned by the service.

Errors

For information about the errors that are common to all actions, seeCommon Errors.

Examples

Example

This example illustrates one usage of ModifySnapshotCopyRetentionPeriod.

Sample Request

https://redshift.us-east-2.amazonaws.com/       ?Action=ModifySnapshotCopyRetentionPeriod&ClusterIdentifier=mycluster&RetentionPeriod=15&SignatureMethod=HmacSHA256&SignatureVersion=4&Version=2012-12-01&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request&X-Amz-Date=20190825T160000Z&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date&X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<ModifySnapshotCopyRetentionPeriodResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">  <ModifySnapshotCopyRetentionPeriodResult>    <Cluster>      <AllowVersionUpgrade>true</AllowVersionUpgrade>      <ClusterIdentifier>mycluster</ClusterIdentifier>      <NumberOfNodes>1</NumberOfNodes>      <AvailabilityZone>us-east-2a</AvailabilityZone>      <ClusterVersion>1.0</ClusterVersion>      <ManualSnapshotRetentionPeriod>-1</ManualSnapshotRetentionPeriod>      <ClusterAvailabilityStatus>Available</ClusterAvailabilityStatus>      <Endpoint>        <Port>5439</Port>        <Address>mycluster.cmeaswqeuae.us-east-2.redshift.amazonaws.com</Address>      </Endpoint>      <VpcId>vpc-a1abc1a1</VpcId>      <PubliclyAccessible>false</PubliclyAccessible>      <ClusterCreateTime>2019-12-27T17:48:01.504Z</ClusterCreateTime>      <ClusterSnapshotCopyStatus>        <ManualSnapshotRetentionPeriod>-1</ManualSnapshotRetentionPeriod>        <DestinationRegion>us-east-1</DestinationRegion>        <RetentionPeriod>15</RetentionPeriod>      </ClusterSnapshotCopyStatus>      <MasterUsername>adminuser</MasterUsername>      <DBName>dev</DBName>      <EnhancedVpcRouting>false</EnhancedVpcRouting>      <IamRoles/>      <ClusterSecurityGroups/>      <NodeType>dc2.large</NodeType>      <ClusterSubnetGroupName>default</ClusterSubnetGroupName>      <NextMaintenanceWindowStartTime>2020-01-26T23:15:00Z</NextMaintenanceWindowStartTime>      <DeferredMaintenanceWindows>        <DeferredMaintenanceWindow>          <DeferMaintenanceEndTime>2020-01-26T19:39:15.075Z</DeferMaintenanceEndTime>          <DeferMaintenanceIdentifier>dfm-VcfYqSYqQ4tdXOqbKwOo</DeferMaintenanceIdentifier>          <DeferMaintenanceStartTime>2019-12-27T19:39:15.075Z</DeferMaintenanceStartTime>        </DeferredMaintenanceWindow>      </DeferredMaintenanceWindows>      <Tags>        <Tag>          <Value>newtag</Value>          <Key>mytag</Key>        </Tag>      </Tags>      <VpcSecurityGroups>        <VpcSecurityGroup>          <VpcSecurityGroupId>sh-a1a123ab</VpcSecurityGroupId>          <Status>active</Status>        </VpcSecurityGroup>      </VpcSecurityGroups>      <ClusterParameterGroups>        <ClusterParameterGroup>          <ParameterGroupName>default.redshift-1.0</ParameterGroupName>          <ParameterApplyStatus>in-sync</ParameterApplyStatus>        </ClusterParameterGroup>      </ClusterParameterGroups>      <Encrypted>false</Encrypted>      <MaintenanceTrackName>current</MaintenanceTrackName>      <PendingModifiedValues/>      <PreferredMaintenanceWindow>sun:23:15-mon:03:15</PreferredMaintenanceWindow>      <AutomatedSnapshotRetentionPeriod>1</AutomatedSnapshotRetentionPeriod>      <ClusterStatus>available</ClusterStatus>    </Cluster>  </ModifySnapshotCopyRetentionPeriodResult>  <ResponseMetadata>    <RequestId>f24fc770-28f3-11ea-9467-b9a67a99da45</RequestId>  </ResponseMetadata></ModifySnapshotCopyRetentionPeriodResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.