Backup / Client / list_restore_access_backup_vaults

list_restore_access_backup_vaults

Backup.Client.list_restore_access_backup_vaults(**kwargs)

Returns a list of restore access backup vaults associated with a specified backup vault.

See also: AWS API Documentation

Request Syntax

response = client.list_restore_access_backup_vaults(
    BackupVaultName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • BackupVaultName (string) –

    [REQUIRED]

    The name of the backup vault for which to list associated restore access backup vaults.

  • NextToken (string) – The pagination token from a previous request to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of items to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'RestoreAccessBackupVaults': [
        {
            'RestoreAccessBackupVaultArn': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'ApprovalDate': datetime(2015, 1, 1),
            'VaultState': 'CREATING'|'AVAILABLE'|'FAILED',
            'LatestRevokeRequest': {
                'MpaSessionArn': 'string',
                'Status': 'PENDING'|'FAILED',
                'StatusMessage': 'string',
                'InitiationDate': datetime(2015, 1, 1),
                'ExpiryDate': datetime(2015, 1, 1)
            }
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The pagination token to use in a subsequent request to retrieve the next set of results.

    • RestoreAccessBackupVaults (list) –

      A list of restore access backup vaults associated with the specified backup vault.

      • (dict) –

        Contains information about a restore access backup vault.

        • RestoreAccessBackupVaultArn (string) –

          The ARN of the restore access backup vault.

        • CreationDate (datetime) –

          The date and time when the restore access backup vault was created.

        • ApprovalDate (datetime) –

          The date and time when the restore access backup vault was approved.

        • VaultState (string) –

          The current state of the restore access backup vault.

        • LatestRevokeRequest (dict) –

          Information about the latest request to revoke access to this backup vault.

          • MpaSessionArn (string) –

            The ARN of the MPA session associated with this revoke request.

          • Status (string) –

            The current status of the revoke request.

          • StatusMessage (string) –

            A message describing the current status of the revoke request.

          • InitiationDate (datetime) –

            The date and time when the revoke request was initiated.

          • ExpiryDate (datetime) –

            The date and time when the revoke request will expire.

Exceptions

  • Backup.Client.exceptions.ResourceNotFoundException

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.MissingParameterValueException

  • Backup.Client.exceptions.ServiceUnavailableException