create_sync_job ¶

create_sync_job(
    workspace_id: Id,
    sync_source: SyncSource,
    sync_role: RoleArn,
    *,
    config_overrides: Optional[IoTTwinMakerClientConfig] = None,
    tags: Optional[TagMap] = None,
) -> CreateSyncJobResponse

This action creates a SyncJob.

Parameters:

workspace_id (Id) –

The workspace ID.
sync_source (SyncSource) –

The sync source.

Currently the only supported syncSoource is SITEWISE .
sync_role (RoleArn) –

The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.
tags (Optional[TagMap], default: None ) –

The SyncJob tags.

Raises:

AccessDeniedException –

Access is denied.
ConflictException –

A conflict occurred.
InternalServerException –

An unexpected error has occurred.
ServiceQuotaExceededException –

The service quota was exceeded.
ThrottlingException –

The rate exceeds the limit.
ValidationException –

Failed
UnknownServiceError –

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

Source code in docs_src/capo_iottwinmaker/_services/io_t_twin_maker.py

def create_sync_job(
    self,
    workspace_id: "capo_iottwinmaker.types.id.Id",
    sync_source: "capo_iottwinmaker.types.sync_source.SyncSource",
    sync_role: "capo_iottwinmaker.types.role_arn.RoleArn",
    *,
    config_overrides: Optional[IoTTwinMakerClientConfig] = None,
    tags: Optional["capo_iottwinmaker.types.tag_map.TagMap"] = None,
) -> "capo_iottwinmaker.types.create_sync_job_response.CreateSyncJobResponse":
    """<p>This action creates a SyncJob.</p>

    Args:
        workspace_id: <p>The workspace ID.</p>
        sync_source: <p>The sync source.</p> <note> <p>Currently the only supported syncSoource is <code>SITEWISE </code>.</p> </note>
        sync_role: <p>The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.</p>
        tags: <p>The SyncJob tags.</p>

    Raises:
        capo_iottwinmaker.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iottwinmaker.errors.conflict_exception.ConflictException: <p>A conflict occurred.</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.
    """

    def _handler(
        req: "OperationRequest[capo_iottwinmaker.types.create_sync_job_request.CreateSyncJobRequest]",
    ) -> OperationResponse[
        "capo_iottwinmaker.types.create_sync_job_response.CreateSyncJobResponse"
    ]:
        import capo_iottwinmaker._operations.aws_io_t_twin_maker.create_sync_job

        output, http_response = (
            capo_iottwinmaker._operations.aws_io_t_twin_maker.create_sync_job.create_sync_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateSyncJob")
    )
    input_: capo_iottwinmaker.types.create_sync_job_request.CreateSyncJobRequest = {
        "workspace_id": workspace_id,
        "sync_source": sync_source,
        "sync_role": sync_role,
    }
    if tags is not None:
        input_["tags"] = tags

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