AWS Backup Backup Backup Access Point API

openapi: 3.2.0
info:
  title: AWS Backup Backup Access Point API
  version: '2018-11-15'
  description: Generated from AWS's published Smithy model for AWS Backup. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://backup.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Backup Access Point
paths:
  /backup-access-point/create:
    put:
      operationId: CreateBackupAccessPoint
      summary: Create Backup Access Point
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBackupAccessPointResponse'
        '400':
          description: AlreadyExistsException; InvalidParameterValueException; InvalidRequestException; LimitExceededException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBackupAccessPointRequest'
      tags:
      - Backup Access Point
  /backup-access-point/delete/{AccessPointArn}:
    delete:
      operationId: DeleteBackupAccessPoint
      summary: Delete Backup Access Point
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: InvalidParameterValueException; InvalidRequestException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteBackupAccessPointInput'
      tags:
      - Backup Access Point
  /backup-access-point/{AccessPointArn}:
    get:
      operationId: DescribeBackupAccessPoint
      summary: Describe Backup Access Point
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeBackupAccessPointResponse'
        '400':
          description: InvalidParameterValueException; InvalidRequestException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeBackupAccessPointInput'
      tags:
      - Backup Access Point
  /backup-access-point:
    get:
      operationId: ListBackupAccessPoints
      summary: List Backup Access Points
      description: Returns a list of the backup access points in your account and Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBackupAccessPointsResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBackupAccessPointsRequest'
      tags:
      - Backup Access Point
  /backup-access-point/recovery-point/{RecoveryPointArn}:
    post:
      operationId: ListBackupAccessPointsByRecoveryPoint
      summary: List Backup Access Points By Recovery Point
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBackupAccessPointsByRecoveryPointResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBackupAccessPointsByRecoveryPointRequest'
      tags:
      - Backup Access Point
  /backup-access-point/resource/{ResourceArn}:
    post:
      operationId: ListBackupAccessPointsByResource
      summary: List Backup Access Points By Resource
      description: Returns the backup access points associated with the specified resource, such as an Amazon S3 bucket.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBackupAccessPointsByResourceResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBackupAccessPointsByResourceRequest'
      tags:
      - Backup Access Point
components:
  schemas:
    ListBackupAccessPointsByRecoveryPointResponse:
      type: object
      properties:
        BackupAccessPoints:
          type: array
          items:
            $ref: '#/components/schemas/ListAccessPointsMember'
          description: A list of backup access points, each containing metadata such as its name, ARN, status, and associated recovery point.
        NextToken:
          type: string
          description: 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.
      required:
      - BackupAccessPoints
    AlreadyExistsException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        CreatorRequestId:
          type: string
        Arn:
          type: string
        Type:
          type: string
        Context:
          type: string
    DeleteBackupAccessPointInput:
      type: object
      properties:
        AccessPointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the backup access point to delete.
      required:
      - AccessPointArn
    ServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    CreateBackupAccessPointRequest:
      type: object
      properties:
        AccessPointMetadata:
          type: object
          additionalProperties:
            type: string
          description: 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.
        AccessPointPolicy:
          type: string
          description: 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:
          type: string
          description: 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:
          type: string
          description: 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:
          type: object
          additionalProperties:
            type: string
          description: The tags to assign to the backup access point.
      required:
      - Name
      - RecoveryPointArn
    ListBackupAccessPointsByResourceRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of items to be returned.
        NextToken:
          type: string
          description: 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.
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource whose backup access points you want to list.
      required:
      - ResourceArn
    ListBackupAccessPointsByResourceResponse:
      type: object
      properties:
        BackupAccessPoints:
          type: array
          items:
            $ref: '#/components/schemas/ListAccessPointsMember'
          description: A list of backup access points, each containing metadata such as its name, ARN, status, and associated recovery point.
        NextToken:
          type: string
          description: 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.
      required:
      - BackupAccessPoints
    InvalidParameterValueException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    ListBackupAccessPointsResponse:
      type: object
      properties:
        BackupAccessPoints:
          type: array
          items:
            $ref: '#/components/schemas/ListAccessPointsMember'
          description: A list of backup access points, each containing metadata such as its name, ARN, status, and associated recovery point.
        NextToken:
          type: string
          description: 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.
      required:
      - BackupAccessPoints
    CreateBackupAccessPointResponse:
      type: object
      properties:
        AccessPointArn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the created backup access point.
        Status:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - DELETING
          - DISASSOCIATED
          - DISASSOCIATING
          - EXPIRED
          - FAILED
          description: 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.
      required:
      - AccessPointArn
      - Status
    ListAccessPointsMember:
      type: object
      properties:
        AccessPointArn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the backup access point.
        AccessPointMetadata:
          type: object
          additionalProperties:
            type: string
          description: 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.
        BackupVaultArn:
          type: string
          description: The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.
        BackupVaultName:
          type: string
          description: The name of the backup vault that contains the recovery point.
        CreationTime:
          type: string
          description: 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:
          type: string
          description: The name of the backup access point.
        RecoveryPointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.
        ResourceType:
          type: string
          description: The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.
        Status:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - DELETING
          - DISASSOCIATED
          - DISASSOCIATING
          - EXPIRED
          - FAILED
          description: The current status of the backup access point.
        StatusMessage:
          type: string
          description: A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.
      required:
      - AccessPointArn
      - AccessPointMetadata
      - BackupVaultName
      - CreationTime
      - Name
      - RecoveryPointArn
      - ResourceArn
      - ResourceType
      - Status
    ListBackupAccessPointsByRecoveryPointRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of items to be returned.
        NextToken:
          type: string
          description: 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.
        RecoveryPointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the recovery point whose backup access points you want to list.
      required:
      - RecoveryPointArn
    DescribeBackupAccessPointResponse:
      type: object
      properties:
        AccessPointArn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the backup access point.
        AccessPointMetadata:
          type: object
          additionalProperties:
            type: string
          description: 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.
        BackupVaultArn:
          type: string
          description: The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.
        BackupVaultName:
          type: string
          description: The name of the backup vault that contains the recovery point.
        CreationTime:
          type: string
          description: 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:
          type: string
          description: The name of the backup access point.
        RecoveryPointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.
        ResourceType:
          type: string
          description: The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.
        Status:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - DELETING
          - DISASSOCIATED
          - DISASSOCIATING
          - EXPIRED
          - FAILED
          description: The current status of the backup access point.
        StatusMessage:
          type: string
          description: A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.
      required:
      - AccessPointArn
      - BackupVaultName
      - CreationTime
      - Name
      - RecoveryPointArn
      - ResourceArn
      - ResourceType
      - Status
    ConflictException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    DescribeBackupAccessPointInput:
      type: object
      properties:
        AccessPointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the backup access point to describe.
      required:
      - AccessPointArn
    ListBackupAccessPointsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of items to be returned.
        NextToken:
          type: string
          description: 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.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: backup
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/backup/service/2018-11-15/backup-2018-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)