AWS CloudHSM V2

2018/07/30 - AWS CloudHSM V2 - 1 new 1 updated api methods

Changes  This update to the AWS CloudHSM API adds copy-backup-to-region, which allows you to copy a backup of a cluster from one region to another. The copied backup can be used in the destination region to create a new AWS CloudHSM cluster as a clone of the original cluster.

CopyBackupToRegion (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.copy_backup_to_region(
    DestinationRegion='string',
    BackupId='string'
)
type DestinationRegion

string

param DestinationRegion

[REQUIRED]

type BackupId

string

param BackupId

[REQUIRED]

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • DestinationBackup (dict) --

      • CreateTimestamp (datetime) --

      • SourceRegion (string) --

      • SourceBackup (string) --

      • SourceCluster (string) --

DescribeBackups (updated) Link ¶
Changes (request, response)
Request 
{'SortAscending': 'boolean'}
Response 
{'Backups': {'CopyTimestamp': 'timestamp',
             'SourceBackup': 'string',
             'SourceCluster': 'string',
             'SourceRegion': 'string'}}

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

See also: AWS API Documentation

Request Syntax

client.describe_backups(
    NextToken='string',
    MaxResults=123,
    Filters={
        'string': [
            'string',
        ]
    },
    SortAscending=True|False
)
type NextToken

string

param NextToken

The NextToken value that you received in the previous response. Use this value to get more backups.

type MaxResults

integer

param MaxResults

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

type Filters

dict

param Filters

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

  • (string) --

    • (list) --

      • (string) --

type SortAscending

boolean

param SortAscending

rtype

dict

returns

Response Syntax

{
    'Backups': [
        {
            'BackupId': 'string',
            'BackupState': 'CREATE_IN_PROGRESS'|'READY'|'DELETED',
            'ClusterId': 'string',
            'CreateTimestamp': datetime(2015, 1, 1),
            'CopyTimestamp': datetime(2015, 1, 1),
            'SourceRegion': 'string',
            'SourceBackup': 'string',
            'SourceCluster': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Backups (list) --

      A list of backups.

      • (dict) --

        Contains information about a backup of an AWS CloudHSM cluster.

        • BackupId (string) --

          The identifier (ID) of the backup.

        • BackupState (string) --

          The state of the backup.

        • ClusterId (string) --

          The identifier (ID) of the cluster that was backed up.

        • CreateTimestamp (datetime) --

          The date and time when the backup was created.

        • CopyTimestamp (datetime) --

        • SourceRegion (string) --

        • SourceBackup (string) --

        • SourceCluster (string) --

    • NextToken (string) --

      An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.