describe_asset ¶

describe_asset(
    asset_id: CustomID,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    exclude_properties: Optional[ExcludeProperties] = None,
) -> DescribeAssetResponse

Retrieves information about an asset.

Parameters:

asset_id (CustomID) –

The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
exclude_properties (Optional[ExcludeProperties], default: None ) –

Whether or not to exclude asset properties from the response.

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

def describe_asset(
    self,
    asset_id: "capo_iotsitewise.types.custom_id.CustomID",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    exclude_properties: Optional[
        "capo_iotsitewise.types.exclude_properties.ExcludeProperties"
    ] = None,
) -> "capo_iotsitewise.types.describe_asset_response.DescribeAssetResponse":
    """<p>Retrieves information about an asset.</p>

    Args:
        asset_id: <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
        exclude_properties: <p> Whether or not to exclude asset properties from the response. </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.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.describe_asset_request.DescribeAssetRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.describe_asset_response.DescribeAssetResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.describe_asset

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.describe_asset.describe_asset(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAsset")
    )
    input_: capo_iotsitewise.types.describe_asset_request.DescribeAssetRequest = {
        "asset_id": asset_id
    }
    if exclude_properties is not None:
        input_["exclude_properties"] = exclude_properties

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output