Backup / Client / get_backup_vault_access_policy

get_backup_vault_access_policy#

Backup.Client.get_backup_vault_access_policy(**kwargs)#

Returns the access policy document that is associated with the named backup vault.

Request Syntax

response = client.get_backup_vault_access_policy(
    BackupVaultName='string'
)

Parameters:

BackupVaultName (string) –

[REQUIRED]

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

Return type:

dict

Returns:

Response Syntax

{
    'BackupVaultName': 'string',
    'BackupVaultArn': 'string',
    'Policy': 'string'
}

Response Structure

(dict) –
- BackupVaultName (string) –
  
  The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
- BackupVaultArn (string) –
  
  An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
- Policy (string) –
  
  The backup vault access policy document in JSON format.

Exceptions

Backup.Client.exceptions.ResourceNotFoundException
Backup.Client.exceptions.InvalidParameterValueException
Backup.Client.exceptions.MissingParameterValueException
Backup.Client.exceptions.ServiceUnavailableException