Skip to content

describe_addon_configuration async

describe_addon_configuration(
    addon_name: String,
    addon_version: String,
    *,
    config_overrides: Optional[AsyncEKSClientConfig] = None,
) -> DescribeAddonConfigurationResponse

Returns configuration options.

Parameters:

  • addon_name (String) –

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

  • addon_version (String) –

    The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

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_configuration(
    self,
    addon_name: "capo_eks.types.string.String",
    addon_version: "capo_eks.types.string.String",
    *,
    config_overrides: Optional[AsyncEKSClientConfig] = None,
) -> "capo_eks.types.describe_addon_configuration_response.DescribeAddonConfigurationResponse":
    """<p>Returns configuration options.</p>

    Args:
        addon_name: <p>The name of the add-on. The name must match one of the names returned by <code>DescribeAddonVersions</code>.</p>
        addon_version: <p>The version of the add-on. The version must match one of the versions returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html"> <code>DescribeAddonVersions</code> </a>.</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_configuration_request.DescribeAddonConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_eks.types.describe_addon_configuration_response.DescribeAddonConfigurationResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.describe_addon_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAddonConfiguration")
    )
    input_: capo_eks.types.describe_addon_configuration_request.DescribeAddonConfigurationRequest = {
        "addon_name": addon_name,
        "addon_version": addon_version,
    }

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