delete_brand `async` ¶

delete_brand(
    aws_account_id: AwsAccountId,
    brand_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> DeleteBrandResponse

This API permanently deletes the specified Quick Sight brand. When you delete a brand:

The brand and all its associated branding elements are permanently removed
Any applications or dashboards using this brand will revert to default styling
This action cannot be undone through the API

Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.

Deletes an Quick Sight brand.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that owns the brand.
brand_id (ShortRestrictiveResourceId) –

The ID of the Quick brand.

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.
InternalServerException –

An internal service exception.
InvalidRequestException –

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

Access is throttled.
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_brand(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    brand_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> "capo_quicksight.types.delete_brand_response.DeleteBrandResponse":
    """<important> <p>This API permanently deletes the specified Quick Sight brand. When you delete a brand:</p> <ul> <li> <p>The brand and all its associated branding elements are permanently removed</p> </li> <li> <p>Any applications or dashboards using this brand will revert to default styling</p> </li> <li> <p>This action cannot be undone through the API</p> </li> </ul> <p> <b>Before proceeding:</b> Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.</p> </important> <p>Deletes an Quick Sight brand.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that owns the brand.</p>
        brand_id: <p>The ID of the Quick brand.</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_server_exception.InternalServerException: <p>An internal service exception.</p>
        capo_quicksight.errors.invalid_request_exception.InvalidRequestException: <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.delete_brand_request.DeleteBrandRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.delete_brand_response.DeleteBrandResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.delete_brand

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteBrand")
    )
    input_: capo_quicksight.types.delete_brand_request.DeleteBrandRequest = {
        "aws_account_id": aws_account_id,
        "brand_id": brand_id,
    }

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

delete_brand async ¶

delete_brand `async` ¶