Backup / Client / list_backup_access_points

list_backup_access_points¶

Backup.Client.list_backup_access_points(**kwargs)¶

Returns a list of the backup access points in your account and Region.

Request Syntax

response = client.list_backup_access_points(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – The maximum number of items to be returned.
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.

Return type:

dict

Returns:

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.

Exceptions

Backup.Client.exceptions.InvalidParameterValueException
Backup.Client.exceptions.ServiceUnavailableException