delete_dashboard `async` ¶

delete_dashboard(
    aws_account_id: AwsAccountId,
    dashboard_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    version_number: Optional[VersionNumber] = None,
) -> DeleteDashboardResponse

Deletes a dashboard.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the dashboard that you're deleting.
dashboard_id (ShortRestrictiveResourceId) –

The ID for the dashboard.
version_number (Optional[VersionNumber], default: None ) –

The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

Raises:

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

async def delete_dashboard(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    dashboard_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    version_number: Optional[
        "capo_quicksight.types.version_number.VersionNumber"
    ] = None,
) -> "capo_quicksight.types.delete_dashboard_response.DeleteDashboardResponse":
    """<p>Deletes a dashboard.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the dashboard that you're deleting.</p>
        dashboard_id: <p>The ID for the dashboard.</p>
        version_number: <p>The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.delete_dashboard_request.DeleteDashboardRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.delete_dashboard_response.DeleteDashboardResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.delete_dashboard

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDashboard")
    )
    input_: capo_quicksight.types.delete_dashboard_request.DeleteDashboardRequest = {
        "aws_account_id": aws_account_id,
        "dashboard_id": dashboard_id,
    }
    if version_number is not None:
        input_["version_number"] = version_number

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

delete_dashboard async ¶

delete_dashboard `async` ¶