Amazon CloudHSM Cloudhsm Backup API

openapi: 3.1.0
info:
  title: Amazon CloudHSM Backup API
  version: '2014-05-30'
  description: Generated from AWS's published Smithy model for Amazon CloudHSM. 3 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://cloudhsmv2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#DeleteBackup:
    post:
      operationId: DeleteBackup
      summary: Delete Backup
      description: 'Deletes a specified CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request
        is made. For more information on restoring a backup, see RestoreBackup. Cross-account use: No. You cannot perform
        this operation on an CloudHSM backup in a different Amazon Web Services account.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteBackupResponse'
        '400':
          description: CloudHsmAccessDeniedException; CloudHsmInvalidRequestException; CloudHsmResourceNotFoundException;
            CloudHsmServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmAccessDeniedException'
        '500':
          description: CloudHsmInternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalFailureException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BaldrApiService.DeleteBackup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteBackupRequest'
      tags:
      - Backup
  /#DescribeBackups:
    post:
      operationId: DescribeBackups
      summary: Describe Backups
      description: 'Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared
        with you when the Shared parameter is true. This is a paginated operation, which means that each response might contain
        only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value.
        Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken
        (or an empty or null value), that means there are no more backups to get. Cross-account use: Yes. Customers can describe
        backups in other Amazon Web Services accounts that are shared with them.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeBackupsResponse'
        '400':
          description: CloudHsmAccessDeniedException; CloudHsmInvalidRequestException; CloudHsmResourceNotFoundException;
            CloudHsmServiceException; CloudHsmTagException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmAccessDeniedException'
        '500':
          description: CloudHsmInternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalFailureException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BaldrApiService.DescribeBackups
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeBackupsRequest'
      tags:
      - Backup
  /#RestoreBackup:
    post:
      operationId: RestoreBackup
      summary: Restore Backup
      description: 'Restores a specified CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting
        a backup, see DeleteBackup. Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different
        Amazon Web Services account.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RestoreBackupResponse'
        '400':
          description: CloudHsmAccessDeniedException; CloudHsmInvalidRequestException; CloudHsmResourceNotFoundException;
            CloudHsmServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmAccessDeniedException'
        '500':
          description: CloudHsmInternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalFailureException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BaldrApiService.RestoreBackup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/RestoreBackupRequest'
      tags:
      - Backup
components:
  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: cloudhsm
  schemas:
    Backup:
      type: object
      properties:
        BackupId:
          type: string
          description: The identifier (ID) of the backup.
        BackupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the backup.
        BackupState:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - READY
          - DELETED
          - PENDING_DELETION
          description: The state of the backup.
        ClusterId:
          type: string
          description: The identifier (ID) of the cluster that was backed up.
        CreateTimestamp:
          type: string
          format: date-time
          description: The date and time when the backup was created.
        CopyTimestamp:
          type: string
          format: date-time
          description: The date and time when the backup was copied from a source backup.
        NeverExpires:
          type: boolean
          description: Specifies whether the service should exempt a backup from the retention policy for the cluster. True
            exempts a backup from the retention policy. False means the service applies the backup retention policy defined
            at the cluster.
        SourceRegion:
          type: string
          description: The AWS Region that contains the source backup from which the new backup was copied.
        SourceBackup:
          type: string
          description: The identifier (ID) of the source backup from which the new backup was copied.
        SourceCluster:
          type: string
          description: The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
        DeleteTimestamp:
          type: string
          format: date-time
          description: The date and time when the backup will be permanently deleted.
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The list of tags for the backup.
        HsmType:
          type: string
          description: The HSM type used to create the backup.
        Mode:
          type: string
          enum:
          - FIPS
          - NON_FIPS
          description: The mode of the cluster that was backed up.
      required:
      - BackupId
    CloudHsmAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    CloudHsmInternalFailureException:
      type: object
      properties:
        Message:
          type: string
    DeleteBackupRequest:
      type: object
      properties:
        BackupId:
          type: string
          description: The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
      required:
      - BackupId
    DeleteBackupResponse:
      type: object
      properties:
        Backup:
          $ref: '#/components/schemas/Backup'
    DescribeBackupsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The NextToken value that you received in the previous response. Use this value to get more backups.
        MaxResults:
          type: integer
          description: The maximum number of backups to return in the response. When there are more backups than the number
            you specify, the response contains a NextToken value.
        Filters:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: One or more filters to limit the items returned in the response. Use the backupIds filter to return
            only the specified backups. Specify backups by their backup identifier (ID). Use the sourceBackupIds filter to
            return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the
            CopyBackupToRegion operation. Use the clusterIds filter to return only the backups for the specified clusters.
            Specify clusters by their cluster identifier (ID). Use the states filter to return only backups that match the
            specified state. Use the neverExpires filter to return b
        Shared:
          type: boolean
          description: Describe backups that are shared with you. By default when using this option, the command returns backups
            that have been shared using a standard Resource Access Manager resource share. In order for a backup that was
            shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share
            using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups,
            see Working with shared backups in the CloudHSM User Guide.
        SortAscending:
          type: boolean
          description: Designates whether or not to sort the return backups by ascending chronological order of generation.
    DescribeBackupsResponse:
      type: object
      properties:
        Backups:
          type: array
          items:
            $ref: '#/components/schemas/Backup'
          description: A list of backups.
        NextToken:
          type: string
          description: An opaque string that indicates that the response contains only a subset of backups. Use this value
            in a subsequent DescribeBackups request to get more backups.
    RestoreBackupRequest:
      type: object
      properties:
        BackupId:
          type: string
          description: The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
      required:
      - BackupId
    RestoreBackupResponse:
      type: object
      properties:
        Backup:
          $ref: '#/components/schemas/Backup'
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the tag.
        Value:
          type: string
          description: The value of the tag.
      required:
      - Key
      - Value
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/cloudhsm-v2/service/2017-04-28/cloudhsm-v2-2017-04-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)