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 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.
Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
The NextToken value that you received in the previous response. Use this value to get more backups.
-
max_results
(Optional[BackupsMaxSize], default:
None
)
–
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
(Optional[Filters], default:
None
)
–
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. The sourceBackupID of a source backup is returned by the CopyBackupToRegion 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 the neverExpires 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
(Optional[Boolean], default:
None
)
–
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.
-
sort_ascending
(Optional[Boolean], default:
None
)
–
Designates whether or not to sort the return backups by ascending chronological order of generation.
Raises:
Source code in docs_src/capo_cloudhsm_v2/_services/async_cloud_hsmv2.py
| async def describe_backups(
self,
*,
config_overrides: Optional[AsyncCloudHSMV2ClientConfig] = None,
next_token: Optional["capo_cloudhsm_v2.types.next_token.NextToken"] = None,
max_results: Optional[
"capo_cloudhsm_v2.types.backups_max_size.BackupsMaxSize"
] = None,
filters: Optional["capo_cloudhsm_v2.types.filters.Filters"] = None,
shared: Optional["capo_cloudhsm_v2.types.boolean.Boolean"] = None,
sort_ascending: Optional["capo_cloudhsm_v2.types.boolean.Boolean"] = None,
) -> "capo_cloudhsm_v2.types.describe_backups_response.DescribeBackupsResponse":
"""<p>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.</p> <p>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 <code>NextToken</code> value. Use this value in a subsequent <code>DescribeBackups</code> request to get more backups. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more backups to get.</p> <p> <b>Cross-account use:</b> Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.</p>
Args:
next_token: <p>The <code>NextToken</code> value that you received in the previous response. Use this value to get more backups.</p>
max_results: <p>The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a <code>NextToken</code> value.</p>
filters: <p>One or more filters to limit the items returned in the response.</p> <p>Use the <code>backupIds</code> filter to return only the specified backups. Specify backups by their backup identifier (ID).</p> <p>Use the <code>sourceBackupIds</code> filter to return only the backups created from a source backup. The <code>sourceBackupID</code> of a source backup is returned by the <a>CopyBackupToRegion</a> operation.</p> <p>Use the <code>clusterIds</code> filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).</p> <p>Use the <code>states</code> filter to return only backups that match the specified state.</p> <p>Use the <code>neverExpires</code> filter to return backups filtered by the value in the <code>neverExpires</code> parameter. <code>True</code> returns all backups exempt from the backup retention policy. <code>False</code> returns all backups with a backup retention policy defined at the cluster.</p>
shared: <p>Describe backups that are shared with you.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/cli/latest/reference/ram/promote-resource-share-created-from-policy.html">PromoteResourceShareCreatedFromPolicy</a> API operation. For more information about sharing backups, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html"> Working with shared backups</a> in the CloudHSM User Guide.</p> </note>
sort_ascending: <p>Designates whether or not to sort the return backups by ascending chronological order of generation.</p>
Raises:
capo_cloudhsm_v2.errors.cloud_hsm_access_denied_exception.CloudHsmAccessDeniedException: <p>The request was rejected because the requester does not have permission to perform the requested operation.</p>
capo_cloudhsm_v2.errors.cloud_hsm_internal_failure_exception.CloudHsmInternalFailureException: <p>The request was rejected because of an CloudHSM internal failure. The request can be retried.</p>
capo_cloudhsm_v2.errors.cloud_hsm_invalid_request_exception.CloudHsmInvalidRequestException: <p>The request was rejected because it is not a valid request.</p>
capo_cloudhsm_v2.errors.cloud_hsm_resource_not_found_exception.CloudHsmResourceNotFoundException: <p>The request was rejected because it refers to a resource that cannot be found.</p>
capo_cloudhsm_v2.errors.cloud_hsm_service_exception.CloudHsmServiceException: <p>The request was rejected because an error occurred.</p>
capo_cloudhsm_v2.errors.cloud_hsm_tag_exception.CloudHsmTagException: <p>The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.</p>
capo_cloudhsm_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_cloudhsm_v2.types.describe_backups_request.DescribeBackupsRequest]",
) -> AsyncOperationResponse[
"capo_cloudhsm_v2.types.describe_backups_response.DescribeBackupsResponse"
]:
import capo_cloudhsm_v2._operations.baldr_api_service.describe_backups
(
output,
http_response,
) = await capo_cloudhsm_v2._operations.baldr_api_service.describe_backups.async_describe_backups(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeBackups")
)
input_: capo_cloudhsm_v2.types.describe_backups_request.DescribeBackupsRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if filters is not None:
input_["filters"] = filters
if shared is not None:
input_["shared"] = shared
if sort_ascending is not None:
input_["sort_ascending"] = sort_ascending
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|