create_template_alias ¶

create_template_alias(
    aws_account_id: AwsAccountId,
    template_id: ShortRestrictiveResourceId,
    alias_name: AliasName,
    template_version_number: VersionNumber,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> CreateTemplateAliasResponse

Creates a template alias for a template.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the template that you creating an alias for.
template_id (ShortRestrictiveResourceId) –

An ID for the template.
alias_name (AliasName) –

The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by Quick Sight.
template_version_number (VersionNumber) –

The version number of the template.

Raises:

ConflictException –

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

An internal failure occurred.
LimitExceededException –

A limit is exceeded.
ResourceExistsException –

The resource specified already exists.
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 create_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",
    template_version_number: "capo_quicksight.types.version_number.VersionNumber",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.create_template_alias_response.CreateTemplateAliasResponse":
    """<p>Creates a template alias for a template.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the template that you creating an alias for.</p>
        template_id: <p>An ID for the template.</p>
        alias_name: <p>The name that you want to give to the template alias that you're creating. Don't start the alias name with the <code>$</code> character. Alias names that start with <code>$</code> are reserved by Quick Sight. </p>
        template_version_number: <p>The version number 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.limit_exceeded_exception.LimitExceededException: <p>A limit is exceeded.</p>
        capo_quicksight.errors.resource_exists_exception.ResourceExistsException: <p>The resource specified already exists. </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.create_template_alias_request.CreateTemplateAliasRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.create_template_alias_response.CreateTemplateAliasResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.create_template_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateTemplateAlias")
    )
    input_: capo_quicksight.types.create_template_alias_request.CreateTemplateAliasRequest = {
        "aws_account_id": aws_account_id,
        "template_id": template_id,
        "alias_name": alias_name,
        "template_version_number": template_version_number,
    }

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