create_dashboard async ¶

async def create_dashboard(
    self,
    project_id: "capo_iotsitewise.types.id.ID",
    dashboard_name: "capo_iotsitewise.types.name.Name",
    dashboard_definition: "capo_iotsitewise.types.dashboard_definition.DashboardDefinition",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    dashboard_description: Optional[
        "capo_iotsitewise.types.description.Description"
    ] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
    tags: Optional["capo_iotsitewise.types.tag_map.TagMap"] = None,
) -> "capo_iotsitewise.types.create_dashboard_response.CreateDashboardResponse":
    """<important> <p>The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html">IoT SiteWise Monitor availability change</a>.</p> </important> <p>Creates a dashboard in an IoT SiteWise Monitor project.</p>

    Args:
        project_id: <p>The ID of the project in which to create the dashboard.</p>
        dashboard_name: <p>A friendly name for the dashboard.</p>
        dashboard_description: <p>A description for the dashboard.</p>
        dashboard_definition: <p>The dashboard definition specified in a JSON literal.</p> <ul> <li> <p>IoT SiteWise Monitor (Classic) see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Create dashboards (CLI)</a> </p> </li> <li> <p>IoT SiteWise Monitor (AI-aware) see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html">Create dashboards (CLI)</a> </p> </li> </ul> <p>in the <i>IoT SiteWise User Guide</i> </p>
        client_token: <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
        tags: <p>A list of key-value pairs that contain metadata for the dashboard. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</p>

    Raises:
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.limit_exceeded_exception.LimitExceededException: <p>You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.create_dashboard_request.CreateDashboardRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.create_dashboard_response.CreateDashboardResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.create_dashboard

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.create_dashboard.async_create_dashboard(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDashboard")
    )
    input_: capo_iotsitewise.types.create_dashboard_request.CreateDashboardRequest = {
        "project_id": project_id,
        "dashboard_name": dashboard_name,
        "dashboard_definition": dashboard_definition,
    }
    if dashboard_description is not None:
        input_["dashboard_description"] = dashboard_description
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

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