describe_template_alias ¶

describe_template_alias(
    aws_account_id: AwsAccountId,
    template_id: ShortRestrictiveResourceId,
    alias_name: AliasName,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeTemplateAliasResponse

Describes the template alias for a template.

Parameters:

aws_account_id (AwsAccountId) –

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

The ID for the template.
alias_name (AliasName) –

The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

Raises:

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/quick_sight.py

def describe_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[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_template_alias_response.DescribeTemplateAliasResponse":
    """<p>Describes the template alias for a template.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the template alias that you're describing.</p>
        template_id: <p>The ID for the template.</p>
        alias_name: <p>The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>

    Raises:
        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.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.describe_template_alias_request.DescribeTemplateAliasRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_template_alias_response.DescribeTemplateAliasResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_template_alias

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.describe_template_alias.describe_template_alias(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTemplateAlias")
    )
    input_: capo_quicksight.types.describe_template_alias_request.DescribeTemplateAliasRequest = {
        "aws_account_id": aws_account_id,
        "template_id": template_id,
        "alias_name": alias_name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output