Amazon MediaLive · JSON Structure

Medialive Api Reservation Structure

Reserved resources available to use

Type: object Properties: 19
BroadcastingMedia ProcessingMedia

Reservation is a JSON Structure definition published by Amazon MediaLive, describing 19 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Arn Count CurrencyCode Duration DurationUnits End FixedPrice Name OfferingDescription OfferingId OfferingType Region RenewalSettings ReservationId ResourceSpecification Start State Tags UsagePrice

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-medialive/refs/heads/main/json-structure/medialive-api-reservation-structure.json",
  "name": "Reservation",
  "type": "object",
  "description": "Reserved resources available to use",
  "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'"
        }
      ]
    }
  }
}