Skip to content

DescribePackagesRequest

Source code in docs_src/capo_opensearch/types/describe_packages_request.py
class DescribePackagesRequest(TypedDict, closed=True):
    filters: NotRequired[
        "capo_opensearch.types.describe_packages_filter_list.DescribePackagesFilterList"
    ]
    """<p>Only returns packages that match the <code>DescribePackagesFilterList</code> values.</p>"""
    max_results: "capo_opensearch.types.max_results.MaxResults"
    """<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.</p>"""
    next_token: NotRequired["capo_opensearch.types.next_token.NextToken"]
    """<p>If your initial <code>DescribePackageFilters</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>DescribePackageFilters</code> operations, which returns results in the next page.</p>"""

filters instance-attribute

filters: NotRequired[DescribePackagesFilterList]

Only returns packages that match the DescribePackagesFilterList values.

max_results instance-attribute

max_results: MaxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

next_token instance-attribute

next_token: NotRequired[NextToken]

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.