describe_asset_model_interface_relationship `async` ¶

describe_asset_model_interface_relationship(
    asset_model_id: CustomID,
    interface_asset_model_id: CustomID,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
) -> DescribeAssetModelInterfaceRelationshipResponse

Retrieves information about an interface relationship between an asset model and an interface asset model.

Parameters:

asset_model_id (CustomID) –

The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
interface_asset_model_id (CustomID) –

The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

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_asset_model_interface_relationship(
    self,
    asset_model_id: "capo_iotsitewise.types.custom_id.CustomID",
    interface_asset_model_id: "capo_iotsitewise.types.custom_id.CustomID",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
) -> "capo_iotsitewise.types.describe_asset_model_interface_relationship_response.DescribeAssetModelInterfaceRelationshipResponse":
    """<p>Retrieves information about an interface relationship between an asset model and an interface asset model.</p>

    Args:
        asset_model_id: <p>The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.</p>
        interface_asset_model_id: <p>The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.</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_asset_model_interface_relationship_request.DescribeAssetModelInterfaceRelationshipRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.describe_asset_model_interface_relationship_response.DescribeAssetModelInterfaceRelationshipResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.describe_asset_model_interface_relationship

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeAssetModelInterfaceRelationship"),
    )
    input_: capo_iotsitewise.types.describe_asset_model_interface_relationship_request.DescribeAssetModelInterfaceRelationshipRequest = {
        "asset_model_id": asset_model_id,
        "interface_asset_model_id": interface_asset_model_id,
    }

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

describe_asset_model_interface_relationship async ¶

describe_asset_model_interface_relationship `async` ¶