Backup / Client / create_backup_access_point

create_backup_access_point

Backup.Client.create_backup_access_point(**kwargs)

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

response = client.create_backup_access_point(
    AccessPointMetadata={
        'string': 'string'
    },
    AccessPointPolicy='string',
    Name='string',
    RecoveryPointArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • AccessPointMetadata (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) –

  • AccessPointPolicy (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.

  • Name (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.

  • RecoveryPointArn (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.

  • Tags (dict) –

    The tags to assign to the backup access point.

    • (string) –

      • (string) –

Return type:

dict

Returns:

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.

Exceptions

  • Backup.Client.exceptions.AlreadyExistsException

  • Backup.Client.exceptions.ConflictException

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.InvalidRequestException

  • Backup.Client.exceptions.LimitExceededException

  • Backup.Client.exceptions.MissingParameterValueException

  • Backup.Client.exceptions.ResourceNotFoundException

  • Backup.Client.exceptions.ServiceUnavailableException