delete_template_alias `async` ¶

delete_template_alias(
    aws_account_id: AwsAccountId,
    template_id: ShortRestrictiveResourceId,
    alias_name: AliasName,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> DeleteTemplateAliasResponse

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the item to delete.
template_id (ShortRestrictiveResourceId) –

The ID for the template that the specified alias is for.
alias_name (AliasName) –

The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

Raises:

ConflictException –

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

An internal failure occurred.
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_alias(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    template_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    alias_name: "capo_quicksight.types.alias_name.AliasName",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> "capo_quicksight.types.delete_template_alias_response.DeleteTemplateAliasResponse":
    """<p>Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the item to delete.</p>
        template_id: <p>The ID for the template that the specified alias is for.</p>
        alias_name: <p>The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. </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.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_alias_request.DeleteTemplateAliasRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.delete_template_alias_response.DeleteTemplateAliasResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.delete_template_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTemplateAlias")
    )
    input_: capo_quicksight.types.delete_template_alias_request.DeleteTemplateAliasRequest = {
        "aws_account_id": aws_account_id,
        "template_id": template_id,
        "alias_name": alias_name,
    }

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

delete_template_alias async ¶

delete_template_alias `async` ¶