Amazon OpenSearch Service API · JSON Structure

Openapi Describe Packages Request Structure

Container for request parameters to DescribePackage operation.

Type: object Properties: 3
AnalyticsElasticsearchSearch

DescribePackagesRequest is a JSON Structure definition published by Amazon OpenSearch Service API, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Filters MaxResults NextToken

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-opensearch/refs/heads/main/json-structure/openapi-describe-packages-request-structure.json",
  "name": "DescribePackagesRequest",
  "description": " Container for request parameters to <code> <a>DescribePackage</a> </code> operation. ",
  "type": "object",
  "properties": {
    "Filters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DescribePackagesFilterList"
        },
        {
          "description": "Only returns packages that match the <code>DescribePackagesFilterList</code> values."
        }
      ]
    },
    "MaxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxResults"
        },
        {
          "description": "Limits results to a maximum number of packages."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page."
        }
      ]
    }
  }
}