describe_portal `async` ¶

describe_portal(
    portal_id: ID, *, config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None
) -> DescribePortalResponse

Retrieves information about a portal.

Parameters:

portal_id (ID) –

The ID of the portal.

Raises:

InternalFailureException –

IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

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.

For more information, see Quotas in the IoT SiteWise User Guide.
UnknownServiceError –

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

Source code in docs_src/capo_iotsitewise/_services/async_io_t_site_wise.py

async def describe_portal(
    self,
    portal_id: "capo_iotsitewise.types.id.ID",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
) -> "capo_iotsitewise.types.describe_portal_response.DescribePortalResponse":
    """<p>Retrieves information about a portal.</p>

    Args:
        portal_id: <p>The ID of the portal.</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.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.describe_portal_request.DescribePortalRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.describe_portal_response.DescribePortalResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.describe_portal

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

    def _redact_output(
        output: "capo_iotsitewise.types.describe_portal_response.DescribePortalResponse",
    ) -> dict[str, Any]:
        import capo_iotsitewise.types.describe_portal_response

        return capo_iotsitewise.types.describe_portal_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribePortal", redact_output=_redact_output),
    )
    input_: capo_iotsitewise.types.describe_portal_request.DescribePortalRequest = {
        "portal_id": portal_id
    }

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

describe_portal async ¶

describe_portal `async` ¶