Skip to content

delete_configuration_template async

delete_configuration_template(
    application_name: ApplicationName,
    template_name: ConfigurationTemplateName,
    *,
    config_overrides: Optional[AsyncElasticBeanstalkClientConfig] = None,
) -> None

Deletes the specified configuration template.

When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

Parameters:

  • application_name (ApplicationName) –

    The name of the application to delete the configuration template from.

  • template_name (ConfigurationTemplateName) –

    The name of the configuration template to delete.

Raises:

  • OperationInProgressException –

    Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

  • UnknownServiceError –

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

Examples:

To delete a configuration template The following operation deletes a configuration template named my-template for an application named my-app:

>>> await client.delete_configuration_template(application_name='my-app', template_name='my-template')
Source code in docs_src/capo_elastic_beanstalk/_services/async_elastic_beanstalk.py
async def delete_configuration_template(
    self,
    application_name: "capo_elastic_beanstalk.types.application_name.ApplicationName",
    template_name: "capo_elastic_beanstalk.types.configuration_template_name.ConfigurationTemplateName",
    *,
    config_overrides: Optional[AsyncElasticBeanstalkClientConfig] = None,
) -> None:
    """<p>Deletes the specified configuration template.</p> <note> <p>When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.</p> </note>

    Args:
        application_name: <p>The name of the application to delete the configuration template from.</p>
        template_name: <p>The name of the configuration template to delete.</p>

    Raises:
        capo_elastic_beanstalk.errors.operation_in_progress_exception.OperationInProgressException: <p>Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.</p>
        capo_elastic_beanstalk.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To delete a configuration template
        The following operation deletes a configuration template named my-template for an application named my-app:

        >>> await client.delete_configuration_template(application_name='my-app', template_name='my-template')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_elastic_beanstalk.types.delete_configuration_template_message.DeleteConfigurationTemplateMessage]",
    ) -> AsyncOperationResponse[None]:
        import capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.delete_configuration_template

        (
            output,
            http_response,
        ) = await capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.delete_configuration_template.async_delete_configuration_template(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteConfigurationTemplate")
    )
    input_: capo_elastic_beanstalk.types.delete_configuration_template_message.DeleteConfigurationTemplateMessage = {
        "application_name": application_name,
        "template_name": template_name,
    }

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