list_composition_relationships ¶

list_composition_relationships(
    asset_model_id: ID,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListCompositionRelationshipsResponse

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

Parameters:

asset_model_id (ID) –

The ID of the asset model. 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.
next_token (Optional[NextToken], default: None ) –

The token to be used for the next set of paginated results.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return for each paginated request.

Default: 50

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 list_composition_relationships(
    self,
    asset_model_id: "capo_iotsitewise.types.id.ID",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iotsitewise.types.max_results.MaxResults"] = None,
) -> "capo_iotsitewise.types.list_composition_relationships_response.ListCompositionRelationshipsResponse":
    """<p>Retrieves a paginated list of composition relationships for an asset model of type <code>COMPONENT_MODEL</code>.</p>

    Args:
        asset_model_id: <p>The ID of the asset model. 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>
        next_token: <p>The token to be used for the next set of paginated results.</p>
        max_results: <p>The maximum number of results to return for each paginated request.</p> <p>Default: 50</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.list_composition_relationships_request.ListCompositionRelationshipsRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.list_composition_relationships_response.ListCompositionRelationshipsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_composition_relationships

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCompositionRelationships")
    )
    input_: capo_iotsitewise.types.list_composition_relationships_request.ListCompositionRelationshipsRequest = {
        "asset_model_id": asset_model_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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