DescribeBackupsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudhsm/json-schema/amazon-cloudhsm-describe-backups-response-schema.json",
  "title": "DescribeBackupsResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudhsm-backup-api-openapi.yml#/components/schemas/DescribeBackupsResponse",
  "type": "object",
  "properties": {
    "Backups": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/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."
    }
  },
  "$defs": {
    "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": "#/$defs/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"
      ]
    },
    "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"
      ]
    }
  }
}