2026/08/06 - AWS Backup - 6 new2 updated api methods
Changes AWS Backup now lets you create read-only access points for Amazon S3 recovery points, enabling you to access backup data using S3 APIs without initiating a restore.
Returns the backup access points associated with the specified recovery point.
If you own the recovery point and have shared it with other accounts, the response includes backup access points created by those accounts.
See also: AWS API Documentation
Request Syntax
client.list_backup_access_points_by_recovery_point(
MaxResults=123,
NextToken='string',
RecoveryPointArn='string'
)
integer
The maximum number of items to be returned.
string
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the recovery point whose backup access points you want to list.
dict
Response Syntax
{
'BackupAccessPoints': [
{
'AccessPointArn': 'string',
'AccessPointMetadata': {
'string': 'string'
},
'BackupVaultArn': 'string',
'BackupVaultName': 'string',
'CreationTime': datetime(2015, 1, 1),
'Name': 'string',
'RecoveryPointArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'Status': 'AVAILABLE'|'CREATING'|'DELETING'|'DISASSOCIATED'|'DISASSOCIATING'|'EXPIRED'|'FAILED',
'StatusMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BackupAccessPoints (list) --
A list of backup access points, each containing metadata such as its name, ARN, status, and associated recovery point.
(dict) --
Contains metadata about a backup access point.
AccessPointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the backup access point.
AccessPointMetadata (dict) --
Metadata for the backup access point. After the backup access point reaches the AVAILABLE status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time.
(string) --
(string) --
BackupVaultArn (string) --
The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.
BackupVaultName (string) --
The name of the backup vault that contains the recovery point.
CreationTime (datetime) --
The date and time that the backup access point was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Name (string) --
The name of the backup access point.
RecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.
ResourceType (string) --
The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.
Status (string) --
The current status of the backup access point.
StatusMessage (string) --
A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.
NextToken (string) --
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Deletes a backup access point. This deletes the underlying Amazon S3 access point and, if no other backup access points remain for the recovery point, resumes lifecycle transitions for that recovery point.
Always delete backup access points using this operation rather than deleting the underlying Amazon S3 access point directly.
See also: AWS API Documentation
Request Syntax
client.delete_backup_access_point(
AccessPointArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the backup access point to delete.
None
Creates a backup access point for an Amazon S3 recovery point. A backup access point provides on-demand, read-only access to the backup data in a recovery point through an Amazon S3 access point, without initiating a restore.
While a backup access point is active for a recovery point, Backup pauses lifecycle transitions and blocks deletion of that recovery point.
See also: AWS API Documentation
Request Syntax
client.create_backup_access_point(
AccessPointMetadata={
'string': 'string'
},
AccessPointPolicy='string',
Name='string',
RecoveryPointArn='string',
Tags={
'string': 'string'
}
)
dict
Metadata for the backup access point. For continuous (point-in-time) recovery points, you must include an AccessPointInTime timestamp (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time. You can specify any time within the continuous backup's retention period, up to the latest restorable time. For snapshot recovery points, do not include AccessPointInTime.
(string) --
(string) --
string
An optional resource-based policy, in JSON format, to apply to the underlying Amazon S3 access point. The policy controls how backup data can be accessed through the access point. If you do not specify a policy, access is governed by the caller's IAM permissions. For more information, see Configuring IAM policies for using access points in the Amazon S3 User Guide.
string
[REQUIRED]
The name of the backup access point. This name is shared with the Amazon S3 access point namespace. It must be unique within your account and Region and cannot conflict with an existing Amazon S3 access point. For more information about access point naming, see Access points naming rules, restrictions, and limitations in the Amazon S3 User Guide.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the recovery point for which to create the backup access point. The recovery point must be an Amazon S3 recovery point in the AVAILABLE, STOPPED, or COMPLETED state.
dict
The tags to assign to the backup access point.
(string) --
(string) --
dict
Response Syntax
{
'AccessPointArn': 'string',
'Status': 'AVAILABLE'|'CREATING'|'DELETING'|'DISASSOCIATED'|'DISASSOCIATING'|'EXPIRED'|'FAILED'
}
Response Structure
(dict) --
AccessPointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the created backup access point.
Status (string) --
The current status of the backup access point. A newly created backup access point begins in the CREATING state and becomes usable when it reaches AVAILABLE.
Returns a list of the backup access points in your account and Region.
See also: AWS API Documentation
Request Syntax
client.list_backup_access_points(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of items to be returned.
string
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
dict
Response Syntax
{
'BackupAccessPoints': [
{
'AccessPointArn': 'string',
'AccessPointMetadata': {
'string': 'string'
},
'BackupVaultArn': 'string',
'BackupVaultName': 'string',
'CreationTime': datetime(2015, 1, 1),
'Name': 'string',
'RecoveryPointArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'Status': 'AVAILABLE'|'CREATING'|'DELETING'|'DISASSOCIATED'|'DISASSOCIATING'|'EXPIRED'|'FAILED',
'StatusMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BackupAccessPoints (list) --
A list of backup access points, each containing metadata such as its name, ARN, status, and associated recovery point.
(dict) --
Contains metadata about a backup access point.
AccessPointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the backup access point.
AccessPointMetadata (dict) --
Metadata for the backup access point. After the backup access point reaches the AVAILABLE status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time.
(string) --
(string) --
BackupVaultArn (string) --
The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.
BackupVaultName (string) --
The name of the backup vault that contains the recovery point.
CreationTime (datetime) --
The date and time that the backup access point was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Name (string) --
The name of the backup access point.
RecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.
ResourceType (string) --
The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.
Status (string) --
The current status of the backup access point.
StatusMessage (string) --
A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.
NextToken (string) --
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Returns metadata about a backup access point, including its status and the details of the underlying Amazon S3 access point.
After a backup access point reaches the AVAILABLE status, use this operation to retrieve the Amazon S3 access point ARN and alias that you need to read the backup data.
See also: AWS API Documentation
Request Syntax
client.describe_backup_access_point(
AccessPointArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the backup access point to describe.
dict
Response Syntax
{
'AccessPointArn': 'string',
'AccessPointMetadata': {
'string': 'string'
},
'BackupVaultArn': 'string',
'BackupVaultName': 'string',
'CreationTime': datetime(2015, 1, 1),
'Name': 'string',
'RecoveryPointArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'Status': 'AVAILABLE'|'CREATING'|'DELETING'|'DISASSOCIATED'|'DISASSOCIATING'|'EXPIRED'|'FAILED',
'StatusMessage': 'string'
}
Response Structure
(dict) --
AccessPointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the backup access point.
AccessPointMetadata (dict) --
Metadata for the backup access point. After the backup access point reaches the AVAILABLE status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time.
(string) --
(string) --
BackupVaultArn (string) --
The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.
BackupVaultName (string) --
The name of the backup vault that contains the recovery point.
CreationTime (datetime) --
The date and time that the backup access point was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Name (string) --
The name of the backup access point.
RecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.
ResourceType (string) --
The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.
Status (string) --
The current status of the backup access point.
StatusMessage (string) --
A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.
Returns the backup access points associated with the specified resource, such as an Amazon S3 bucket.
See also: AWS API Documentation
Request Syntax
client.list_backup_access_points_by_resource(
MaxResults=123,
NextToken='string',
ResourceArn='string'
)
integer
The maximum number of items to be returned.
string
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource whose backup access points you want to list.
dict
Response Syntax
{
'BackupAccessPoints': [
{
'AccessPointArn': 'string',
'AccessPointMetadata': {
'string': 'string'
},
'BackupVaultArn': 'string',
'BackupVaultName': 'string',
'CreationTime': datetime(2015, 1, 1),
'Name': 'string',
'RecoveryPointArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'Status': 'AVAILABLE'|'CREATING'|'DELETING'|'DISASSOCIATED'|'DISASSOCIATING'|'EXPIRED'|'FAILED',
'StatusMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BackupAccessPoints (list) --
A list of backup access points, each containing metadata such as its name, ARN, status, and associated recovery point.
(dict) --
Contains metadata about a backup access point.
AccessPointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the backup access point.
AccessPointMetadata (dict) --
Metadata for the backup access point. After the backup access point reaches the AVAILABLE status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time.
(string) --
(string) --
BackupVaultArn (string) --
The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.
BackupVaultName (string) --
The name of the backup vault that contains the recovery point.
CreationTime (datetime) --
The date and time that the backup access point was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Name (string) --
The name of the backup access point.
RecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.
ResourceType (string) --
The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.
Status (string) --
The current status of the backup access point.
StatusMessage (string) --
A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.
NextToken (string) --
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
{'BackupVaultEvents': {'ACCESS_POINT_AVAILABLE',
'ACCESS_POINT_CREATION_FAILED',
'ACCESS_POINT_DELETED',
'ACCESS_POINT_DELETION_FAILED',
'ACCESS_POINT_DISASSOCIATED',
'ACCESS_POINT_EXPIRED'}}
Returns event notifications for the specified backup vault.
See also: AWS API Documentation
Request Syntax
client.get_backup_vault_notifications(
BackupVaultName='string'
)
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.
dict
Response Syntax
{
'BackupVaultName': 'string',
'BackupVaultArn': 'string',
'SNSTopicArn': 'string',
'BackupVaultEvents': [
'BACKUP_JOB_STARTED'|'BACKUP_JOB_COMPLETED'|'BACKUP_JOB_SUCCESSFUL'|'BACKUP_JOB_FAILED'|'BACKUP_JOB_EXPIRED'|'RESTORE_JOB_STARTED'|'RESTORE_JOB_COMPLETED'|'RESTORE_JOB_SUCCESSFUL'|'RESTORE_JOB_FAILED'|'COPY_JOB_STARTED'|'COPY_JOB_SUCCESSFUL'|'COPY_JOB_FAILED'|'RECOVERY_POINT_MODIFIED'|'BACKUP_PLAN_CREATED'|'BACKUP_PLAN_MODIFIED'|'S3_BACKUP_OBJECT_FAILED'|'S3_RESTORE_OBJECT_FAILED'|'CONTINUOUS_BACKUP_INTERRUPTED'|'RECOVERY_POINT_INDEX_COMPLETED'|'RECOVERY_POINT_INDEX_DELETED'|'RECOVERY_POINT_INDEXING_FAILED'|'EKS_RESTORE_OBJECT_FAILED'|'EKS_RESTORE_OBJECT_SKIPPED'|'EKS_BACKUP_OBJECT_FAILED'|'ACCESS_POINT_AVAILABLE'|'ACCESS_POINT_CREATION_FAILED'|'ACCESS_POINT_DELETED'|'ACCESS_POINT_DELETION_FAILED'|'ACCESS_POINT_EXPIRED'|'ACCESS_POINT_DISASSOCIATED',
]
}
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.
SNSTopicArn (string) --
An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.
BackupVaultEvents (list) --
An array of events that indicate the status of jobs to back up resources to the backup vault.
(string) --
{'BackupVaultEvents': {'ACCESS_POINT_AVAILABLE',
'ACCESS_POINT_CREATION_FAILED',
'ACCESS_POINT_DELETED',
'ACCESS_POINT_DELETION_FAILED',
'ACCESS_POINT_DISASSOCIATED',
'ACCESS_POINT_EXPIRED'}}
Turns on notifications on a backup vault for the specified topic and events.
See also: AWS API Documentation
Request Syntax
client.put_backup_vault_notifications(
BackupVaultName='string',
SNSTopicArn='string',
BackupVaultEvents=[
'BACKUP_JOB_STARTED'|'BACKUP_JOB_COMPLETED'|'BACKUP_JOB_SUCCESSFUL'|'BACKUP_JOB_FAILED'|'BACKUP_JOB_EXPIRED'|'RESTORE_JOB_STARTED'|'RESTORE_JOB_COMPLETED'|'RESTORE_JOB_SUCCESSFUL'|'RESTORE_JOB_FAILED'|'COPY_JOB_STARTED'|'COPY_JOB_SUCCESSFUL'|'COPY_JOB_FAILED'|'RECOVERY_POINT_MODIFIED'|'BACKUP_PLAN_CREATED'|'BACKUP_PLAN_MODIFIED'|'S3_BACKUP_OBJECT_FAILED'|'S3_RESTORE_OBJECT_FAILED'|'CONTINUOUS_BACKUP_INTERRUPTED'|'RECOVERY_POINT_INDEX_COMPLETED'|'RECOVERY_POINT_INDEX_DELETED'|'RECOVERY_POINT_INDEXING_FAILED'|'EKS_RESTORE_OBJECT_FAILED'|'EKS_RESTORE_OBJECT_SKIPPED'|'EKS_BACKUP_OBJECT_FAILED'|'ACCESS_POINT_AVAILABLE'|'ACCESS_POINT_CREATION_FAILED'|'ACCESS_POINT_DELETED'|'ACCESS_POINT_DELETION_FAILED'|'ACCESS_POINT_EXPIRED'|'ACCESS_POINT_DISASSOCIATED',
]
)
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.
string
[REQUIRED]
The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
list
[REQUIRED]
An array of events that indicate the status of jobs to back up resources to the backup vault. For the list of supported events, common use cases, and code samples, see Notification options with Backup.
(string) --
None