copy_backup_to_region

CloudHSMV2.Client.copy_backup_to_region(**kwargs)

Copy an AWS CloudHSM cluster backup to a different region.

See also: AWS API Documentation

Request Syntax

response = client.copy_backup_to_region(
    DestinationRegion='string',
    BackupId='string',
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

• DestinationRegion (string) --

  [REQUIRED]

  The AWS region that will contain your copied CloudHSM cluster backup.

• BackupId (string) --

  [REQUIRED]

  The ID of the backup that will be copied to the destination region.

• TagList (list) --

  Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.

  • (dict) --

    Contains a tag. A tag is a key-value pair.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) -- [REQUIRED]

      The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'DestinationBackup': {
        'CreateTimestamp': datetime(2015, 1, 1),
        'SourceRegion': 'string',
        'SourceBackup': 'string',
        'SourceCluster': 'string'
    }
}

Response Structure

• (dict) --

  • DestinationBackup (dict) --

    Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the source backup.

    You will need to use the sourceBackupID returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region.

    • CreateTimestamp (datetime) --

      The date and time when both the source backup was created.

    • SourceRegion (string) --

      The AWS region that contains the source backup from which the new backup was copied.

    • SourceBackup (string) --

      The identifier (ID) of the source backup from which the new backup was copied.

    • SourceCluster (string) --

      The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Exceptions

• CloudHSMV2.Client.exceptions.CloudHsmAccessDeniedException
• CloudHSMV2.Client.exceptions.CloudHsmInternalFailureException
• CloudHSMV2.Client.exceptions.CloudHsmInvalidRequestException
• CloudHSMV2.Client.exceptions.CloudHsmResourceNotFoundException
• CloudHSMV2.Client.exceptions.CloudHsmServiceException
• CloudHSMV2.Client.exceptions.CloudHsmTagException