Skip to content

list_template_aliases

list_template_aliases(
    aws_account_id: AwsAccountId,
    template_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[MaxResults] = None,
) -> ListTemplateAliasesResponse

Lists all the aliases of a template.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the template aliases that you're listing.

  • template_id (ShortRestrictiveResourceId) –

    The ID for the template.

  • next_token (Optional[String], default: None ) –

    The token for the next set of results, or null if there are no more results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to be returned per request.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def list_template_aliases(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    template_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional["capo_quicksight.types.string.String"] = None,
    max_results: Optional["capo_quicksight.types.max_results.MaxResults"] = None,
) -> "capo_quicksight.types.list_template_aliases_response.ListTemplateAliasesResponse":
    """<p>Lists all the aliases of a template.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the template aliases that you're listing.</p>
        template_id: <p>The ID for the template.</p>
        next_token: <p>The token for the next set of results, or null if there are no more results.</p>
        max_results: <p>The maximum number of results to be returned per request.</p>

    Raises:
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> value isn't valid.</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.list_template_aliases_request.ListTemplateAliasesRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.list_template_aliases_response.ListTemplateAliasesResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_template_aliases

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTemplateAliases")
    )
    input_: capo_quicksight.types.list_template_aliases_request.ListTemplateAliasesRequest = {
        "aws_account_id": aws_account_id,
        "template_id": template_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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