delete_template `async` ¶

delete_template(
    aws_account_id: AwsAccountId,
    template_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    version_number: Optional[VersionNumber] = None,
) -> DeleteTemplateResponse

Deletes a template.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the template that you're deleting.
template_id (ShortRestrictiveResourceId) –

An ID for the template you want to delete.
version_number (Optional[VersionNumber], default: None ) –

Specifies the version of the template that you want to delete. If you don't provide a version number, DeleteTemplate deletes all versions of the template.

Raises:

ConflictException –

Updating or deleting a resource can cause an inconsistent state.
InternalFailureException –

An internal failure occurred.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
LimitExceededException –

A limit is exceeded.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

Access is throttled.
UnsupportedUserEditionException –

This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
UnknownServiceError –

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

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py

async def delete_template(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    template_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    version_number: Optional[
        "capo_quicksight.types.version_number.VersionNumber"
    ] = None,
) -> "capo_quicksight.types.delete_template_response.DeleteTemplateResponse":
    """<p>Deletes a template.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the template that you're deleting.</p>
        template_id: <p>An ID for the template you want to delete.</p>
        version_number: <p>Specifies the version of the template that you want to delete. If you don't provide a version number, <code>DeleteTemplate</code> deletes all versions of the template. </p>

    Raises:
        capo_quicksight.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.limit_exceeded_exception.LimitExceededException: <p>A limit is exceeded.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.unsupported_user_edition_exception.UnsupportedUserEditionException: <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.delete_template_request.DeleteTemplateRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.delete_template_response.DeleteTemplateResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.delete_template

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.delete_template.async_delete_template(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTemplate")
    )
    input_: capo_quicksight.types.delete_template_request.DeleteTemplateRequest = {
        "aws_account_id": aws_account_id,
        "template_id": template_id,
    }
    if version_number is not None:
        input_["version_number"] = version_number

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

delete_template async ¶

delete_template `async` ¶