get_dashboard `async` ¶

get_dashboard(
    arn: DashboardArn,
    *,
    config_overrides: Optional[AsyncBCMDashboardsClientConfig] = None,
) -> GetDashboardResponse

Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.

Parameters:

arn (DashboardArn) –

The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
InternalServerException –

An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
ResourceNotFoundException –

The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
ThrottlingException –

The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
ValidationException –

The input parameters do not satisfy the requirements. Check the error message for specific validation details.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

Getting information about a dashboard

>>> await client.get_dashboard(arn='arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh')

Source code in docs_src/capo_bcm_dashboards/_services/async_bcm_dashboards.py

async def get_dashboard(
    self,
    arn: "capo_bcm_dashboards.types.dashboard_arn.DashboardArn",
    *,
    config_overrides: Optional[AsyncBCMDashboardsClientConfig] = None,
) -> "capo_bcm_dashboards.types.get_dashboard_response.GetDashboardResponse":
    """<p>Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.</p>

    Args:
        arn: <p>The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.</p>

    Raises:
        capo_bcm_dashboards.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
        capo_bcm_dashboards.errors.internal_server_exception.InternalServerException: <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
        capo_bcm_dashboards.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
        capo_bcm_dashboards.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
        capo_bcm_dashboards.errors.validation_exception.ValidationException: <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
        capo_bcm_dashboards.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Getting information about a dashboard

        >>> await client.get_dashboard(arn='arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bcm_dashboards.types.get_dashboard_request.GetDashboardRequest]",
    ) -> AsyncOperationResponse[
        "capo_bcm_dashboards.types.get_dashboard_response.GetDashboardResponse"
    ]:
        import capo_bcm_dashboards._operations.awsbcm_dashboards_service.get_dashboard

        (
            output,
            http_response,
        ) = await capo_bcm_dashboards._operations.awsbcm_dashboards_service.get_dashboard.async_get_dashboard(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDashboard")
    )
    input_: capo_bcm_dashboards.types.get_dashboard_request.GetDashboardRequest = {
        "arn": arn
    }

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

get_dashboard async ¶

get_dashboard `async` ¶