create_backup_access_point
async
¶
create_backup_access_point(
name: AccessPointName,
recovery_point_arn: RecoveryPointArn,
*,
config_overrides: Optional[AsyncBackupClientConfig] = None,
access_point_metadata: Optional[AccessPointMetadataMap] = None,
access_point_policy: Optional[AccessPointPolicy] = None,
tags: Optional[TagMap] = None,
) -> CreateBackupAccessPointResponse
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.
Parameters:
-
access_point_metadata(Optional[AccessPointMetadataMap], default:None) –Metadata for the backup access point. For continuous (point-in-time) recovery points, you must include an
AccessPointInTimetimestamp (in format2021-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 includeAccessPointInTime. -
access_point_policy(Optional[AccessPointPolicy], default:None) –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(AccessPointName) –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.
-
recovery_point_arn(RecoveryPointArn) –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, orCOMPLETEDstate. -
tags(Optional[TagMap], default:None) –The tags to assign to the backup access point.
Raises:
-
AlreadyExistsException–The required resource already exists.
-
ConflictException–Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
-
InvalidParameterValueException–Indicates that something is wrong with a parameter's value. For example, the value is out of range.
-
InvalidRequestException–Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
-
LimitExceededException–A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
-
MissingParameterValueException–Indicates that a required parameter is missing.
-
ResourceNotFoundException–A resource that is required for the action doesn't exist.
-
ServiceUnavailableException–The request failed due to a temporary failure of the server.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_backup/_services/async_backup.py
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 | |