Describe Backups
cloudhsmv2_describe_backups | R Documentation |
Gets information about backups of CloudHSM clusters¶
Description¶
Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.
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 describe_backups
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.
Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.
Usage¶
Arguments¶
NextToken
The
NextToken
value that you received in the previous response. Use this value to get more backups.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.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
sourceBackupIds
filter to return only the backups created from a source backup. ThesourceBackupID
of a source backup is returned by thecopy_backup_to_region
operation.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.Use the
neverExpires
filter to return backups filtered by the value in theneverExpires
parameter.True
returns all backups exempt from the backup retention policy.False
returns all backups with a backup retention policy defined at the cluster.Shared
Describe backups that are shared with you.
By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.
SortAscending
Designates whether or not to sort the return backups by ascending chronological order of generation.
Value¶
A list with the following syntax:
list(
Backups = list(
list(
BackupId = "string",
BackupArn = "string",
BackupState = "CREATE_IN_PROGRESS"|"READY"|"DELETED"|"PENDING_DELETION",
ClusterId = "string",
CreateTimestamp = as.POSIXct(
"2015-01-01"
),
CopyTimestamp = as.POSIXct(
"2015-01-01"
),
NeverExpires = TRUE|FALSE,
SourceRegion = "string",
SourceBackup = "string",
SourceCluster = "string",
DeleteTimestamp = as.POSIXct(
"2015-01-01"
),
TagList = list(
list(
Key = "string",
Value = "string"
)
),
HsmType = "string",
Mode = "FIPS"|"NON_FIPS"
)
),
NextToken = "string"
)