Skip to content

delete_theme

delete_theme(
    aws_account_id: AwsAccountId,
    theme_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    version_number: Optional[VersionNumber] = None,
) -> DeleteThemeResponse

Deletes a theme.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the theme that you're deleting.

  • theme_id (ShortRestrictiveResourceId) –

    An ID for the theme that you want to delete.

  • version_number (Optional[VersionNumber], default: None ) –

    The version of the theme that you want to delete.

    Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.

Raises:

  • AccessDeniedException –

    You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

  • 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.

  • 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 delete_theme(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    theme_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    version_number: Optional[
        "capo_quicksight.types.version_number.VersionNumber"
    ] = None,
) -> "capo_quicksight.types.delete_theme_response.DeleteThemeResponse":
    """<p>Deletes a theme.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the theme that you're deleting.</p>
        theme_id: <p>An ID for the theme that you want to delete.</p>
        version_number: <p>The version of the theme that you want to delete. </p> <p> <b>Note:</b> If you don't provide a version number, you're using this call to <code>DeleteTheme</code> to delete all versions of the theme.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        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.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.delete_theme_request.DeleteThemeRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.delete_theme_response.DeleteThemeResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.delete_theme

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTheme")
    )
    input_: capo_quicksight.types.delete_theme_request.DeleteThemeRequest = {
        "aws_account_id": aws_account_id,
        "theme_id": theme_id,
    }
    if version_number is not None:
        input_["version_number"] = version_number

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