Skip to content

describe_addon_versions async

describe_addon_versions(
    *,
    config_overrides: Optional[AsyncEKSClientConfig] = None,
    kubernetes_version: Optional[String] = None,
    max_results: Optional[DescribeAddonVersionsRequestMaxResults] = None,
    next_token: Optional[String] = None,
    addon_name: Optional[String] = None,
    types: Optional[StringList] = None,
    publishers: Optional[StringList] = None,
    owners: Optional[StringList] = None,
) -> DescribeAddonVersionsResponse

Describes the versions for an add-on.

Information such as the Kubernetes versions that you can use the add-on with, the owner, publisher, and the type of the add-on are returned.

Parameters:

  • kubernetes_version (Optional[String], default: None ) –

    The Kubernetes versions that you can use the add-on with.

  • max_results (Optional[DescribeAddonVersionsRequestMaxResults], default: None ) –

    The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a nextToken value, if applicable, are returned.

  • next_token (Optional[String], default: None ) –

    The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

  • addon_name (Optional[String], default: None ) –

    The name of the add-on. The name must match one of the names returned by ListAddons .

  • types (Optional[StringList], default: None ) –

    The type of the add-on. For valid types, don't specify a value for this property.

  • publishers (Optional[StringList], default: None ) –

    The publisher of the add-on. For valid publishers, don't specify a value for this property.

  • owners (Optional[StringList], default: None ) –

    The owner of the add-on. For valid owners, don't specify a value for this property.

Raises:

  • InvalidParameterException –

    The specified parameter is invalid. Review the available parameters for the API request.

  • ResourceNotFoundException –

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

  • ServerException –

    These errors are usually caused by a server-side issue.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_eks/_services/async_eks.py
async def describe_addon_versions(
    self,
    *,
    config_overrides: Optional[AsyncEKSClientConfig] = None,
    kubernetes_version: Optional["capo_eks.types.string.String"] = None,
    max_results: Optional[
        "capo_eks.types.describe_addon_versions_request_max_results.DescribeAddonVersionsRequestMaxResults"
    ] = None,
    next_token: Optional["capo_eks.types.string.String"] = None,
    addon_name: Optional["capo_eks.types.string.String"] = None,
    types: Optional["capo_eks.types.string_list.StringList"] = None,
    publishers: Optional["capo_eks.types.string_list.StringList"] = None,
    owners: Optional["capo_eks.types.string_list.StringList"] = None,
) -> (
    "capo_eks.types.describe_addon_versions_response.DescribeAddonVersionsResponse"
):
    """<p>Describes the versions for an add-on.</p> <p>Information such as the Kubernetes versions that you can use the add-on with, the <code>owner</code>, <code>publisher</code>, and the <code>type</code> of the add-on are returned.</p>

    Args:
        kubernetes_version: <p>The Kubernetes versions that you can use the add-on with.</p>
        max_results: <p>The maximum number of results, returned in paginated output. You receive <code>maxResults</code> in a single page, along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <code>nextToken</code> value, if applicable, are returned.</p>
        next_token: <p>The <code>nextToken</code> value returned from a previous paginated request, where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is null when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</p> </note>
        addon_name: <p>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html"> <code>ListAddons</code> </a>.</p>
        types: <p>The type of the add-on. For valid <code>types</code>, don't specify a value for this property.</p>
        publishers: <p>The publisher of the add-on. For valid <code>publishers</code>, don't specify a value for this property.</p>
        owners: <p>The owner of the add-on. For valid <code>owners</code>, don't specify a value for this property.</p>

    Raises:
        capo_eks.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
        capo_eks.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found. You can view your available clusters with <code>ListClusters</code>. You can view your available managed node groups with <code>ListNodegroups</code>. Amazon EKS clusters and node groups are Amazon Web Services Region specific.</p>
        capo_eks.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
        capo_eks.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_eks.types.describe_addon_versions_request.DescribeAddonVersionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_eks.types.describe_addon_versions_response.DescribeAddonVersionsResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.describe_addon_versions

        (
            output,
            http_response,
        ) = await capo_eks._operations.aws_wesley_frontend.describe_addon_versions.async_describe_addon_versions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAddonVersions")
    )
    input_: capo_eks.types.describe_addon_versions_request.DescribeAddonVersionsRequest = {}
    if kubernetes_version is not None:
        input_["kubernetes_version"] = kubernetes_version
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if addon_name is not None:
        input_["addon_name"] = addon_name
    if types is not None:
        input_["types"] = types
    if publishers is not None:
        input_["publishers"] = publishers
    if owners is not None:
        input_["owners"] = owners

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output