Amazon MediaLive · Schema

Reservation

Reserved resources available to use

BroadcastingMedia ProcessingMedia

Properties

Name Type Description
Arn object
Count object
CurrencyCode object
Duration object
DurationUnits object
End object
FixedPrice object
Name object
OfferingDescription object
OfferingId object
OfferingType object
Region object
RenewalSettings object
ReservationId object
ResourceSpecification object
Start object
State object
Tags object
UsagePrice object
View JSON Schema on GitHub

JSON Schema

medialive-api-reservation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-medialive/refs/heads/main/json-schema/medialive-api-reservation-schema.json",
  "title": "Reservation",
  "description": "Reserved resources available to use",
  "type": "object",
  "properties": {
    "Arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "arn"
          },
          "description": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
        }
      ]
    },
    "Count": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "count"
          },
          "description": "Number of reserved resources"
        }
      ]
    },
    "CurrencyCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "currencyCode"
          },
          "description": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
        }
      ]
    },
    "Duration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "duration"
          },
          "description": "Lease duration, e.g. '12'"
        }
      ]
    },
    "DurationUnits": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OfferingDurationUnits"
        },
        {
          "xml": {
            "name": "durationUnits"
          },
          "description": "Units for duration, e.g. 'MONTHS'"
        }
      ]
    },
    "End": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "end"
          },
          "description": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
        }
      ]
    },
    "FixedPrice": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__double"
        },
        {
          "xml": {
            "name": "fixedPrice"
          },
          "description": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "name"
          },
          "description": "User specified reservation name"
        }
      ]
    },
    "OfferingDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "offeringDescription"
          },
          "description": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
        }
      ]
    },
    "OfferingId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "offeringId"
          },
          "description": "Unique offering ID, e.g. '87654321'"
        }
      ]
    },
    "OfferingType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OfferingType"
        },
        {
          "xml": {
            "name": "offeringType"
          },
          "description": "Offering type, e.g. 'NO_UPFRONT'"
        }
      ]
    },
    "Region": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "region"
          },
          "description": "AWS region, e.g. 'us-west-2'"
        }
      ]
    },
    "RenewalSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RenewalSettings"
        },
        {
          "xml": {
            "name": "renewalSettings"
          },
          "description": "Renewal settings for the reservation"
        }
      ]
    },
    "ReservationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "reservationId"
          },
          "description": "Unique reservation ID, e.g. '1234567'"
        }
      ]
    },
    "ResourceSpecification": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ReservationResourceSpecification"
        },
        {
          "xml": {
            "name": "resourceSpecification"
          },
          "description": "Resource configuration details"
        }
      ]
    },
    "Start": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "start"
          },
          "description": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ReservationState"
        },
        {
          "xml": {
            "name": "state"
          },
          "description": "Current state of reservation, e.g. 'ACTIVE'"
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tags"
        },
        {
          "xml": {
            "name": "tags"
          },
          "description": "A collection of key-value pairs"
        }
      ]
    },
    "UsagePrice": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__double"
        },
        {
          "xml": {
            "name": "usagePrice"
          },
          "description": "Recurring usage charge for each reserved resource, e.g. '157.0'"
        }
      ]
    }
  }
}