Skip to content

list_sync_resources async

list_sync_resources(
    workspace_id: Id,
    sync_source: SyncSource,
    *,
    config_overrides: Optional[AsyncIoTTwinMakerClientConfig] = None,
    filters: Optional[SyncResourceFilters] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListSyncResourcesResponse

Lists the sync resources.

Parameters:

  • workspace_id (Id) –

    The ID of the workspace that contains the sync job.

  • sync_source (SyncSource) –

    The sync source.

    Currently the only supported syncSource is SITEWISE .

  • filters (Optional[SyncResourceFilters], default: None ) –

    A list of objects that filter the request.

    The following filter combinations are supported:

    • Filter with state

    • Filter with ResourceType and ResourceId

    • Filter with ResourceType and ExternalId

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return at one time. The default is 50.

    Valid Range: Minimum value of 0. Maximum value of 200.

  • next_token (Optional[NextToken], default: None ) –

    The string that specifies the next page of results.

Raises:

Source code in docs_src/capo_iottwinmaker/_services/async_io_t_twin_maker.py
async def list_sync_resources(
    self,
    workspace_id: "capo_iottwinmaker.types.id.Id",
    sync_source: "capo_iottwinmaker.types.sync_source.SyncSource",
    *,
    config_overrides: Optional[AsyncIoTTwinMakerClientConfig] = None,
    filters: Optional[
        "capo_iottwinmaker.types.sync_resource_filters.SyncResourceFilters"
    ] = None,
    max_results: Optional["capo_iottwinmaker.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_iottwinmaker.types.next_token.NextToken"] = None,
) -> (
    "capo_iottwinmaker.types.list_sync_resources_response.ListSyncResourcesResponse"
):
    """<p>Lists the sync resources.</p>

    Args:
        workspace_id: <p>The ID of the workspace that contains the sync job.</p>
        sync_source: <p>The sync source.</p> <note> <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p> </note>
        filters: <p>A list of objects that filter the request.</p> <p>The following filter combinations are supported:</p> <ul> <li> <p>Filter with state</p> </li> <li> <p>Filter with ResourceType and ResourceId</p> </li> <li> <p>Filter with ResourceType and ExternalId</p> </li> </ul>
        max_results: <p>The maximum number of results to return at one time. The default is 50.</p> <p>Valid Range: Minimum value of 0. Maximum value of 200.</p>
        next_token: <p>The string that specifies the next page of results.</p>

    Raises:
        capo_iottwinmaker.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iottwinmaker.errors.internal_server_exception.InternalServerException: <p>An unexpected error has occurred.</p>
        capo_iottwinmaker.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The service quota was exceeded.</p>
        capo_iottwinmaker.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iottwinmaker.errors.validation_exception.ValidationException: <p>Failed</p>
        capo_iottwinmaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iottwinmaker.types.list_sync_resources_request.ListSyncResourcesRequest]",
    ) -> AsyncOperationResponse[
        "capo_iottwinmaker.types.list_sync_resources_response.ListSyncResourcesResponse"
    ]:
        import capo_iottwinmaker._operations.aws_io_t_twin_maker.list_sync_resources

        (
            output,
            http_response,
        ) = await capo_iottwinmaker._operations.aws_io_t_twin_maker.list_sync_resources.async_list_sync_resources(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSyncResources")
    )
    input_: capo_iottwinmaker.types.list_sync_resources_request.ListSyncResourcesRequest = {
        "workspace_id": workspace_id,
        "sync_source": sync_source,
    }
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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