Skip to main content Link Search Menu Expand Document (external link)

IoTJobsDataPlaneService overview

Added in v1.0.0


Table of contents


constructors

makeIoTJobsDataPlaneService

Signature

export declare const makeIoTJobsDataPlaneService: Effect.Effect<any, unknown, unknown>

Added in v1.0.0

models

IoTJobsDataPlaneService (class)

Signature

export declare class IoTJobsDataPlaneService

Added in v1.0.0

IoTJobsDataPlaneService$ (interface)

Signature

export interface IoTJobsDataPlaneService$ {
  /**
   * @see {@link DescribeJobExecutionCommand}
   */
  describeJobExecution(
    args: DescribeJobExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeJobExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CertificateValidationError
    | InvalidRequestError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | TerminalStateError
    | ThrottlingError
  >

  /**
   * @see {@link GetPendingJobExecutionsCommand}
   */
  getPendingJobExecutions(
    args: GetPendingJobExecutionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetPendingJobExecutionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CertificateValidationError
    | InvalidRequestError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
  >

  /**
   * @see {@link StartCommandExecutionCommand}
   */
  startCommandExecution(
    args: StartCommandExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartCommandExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link StartNextPendingJobExecutionCommand}
   */
  startNextPendingJobExecution(
    args: StartNextPendingJobExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartNextPendingJobExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CertificateValidationError
    | InvalidRequestError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
  >

  /**
   * @see {@link UpdateJobExecutionCommand}
   */
  updateJobExecution(
    args: UpdateJobExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateJobExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CertificateValidationError
    | InvalidRequestError
    | InvalidStateTransitionError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
  >
}

Added in v1.0.0

utils

IoTJobsDataPlaneService (namespace)

Added in v1.0.0

Config (interface)

Signature

export interface Config extends Omit<IoTJobsDataPlaneClientConfig, "logger"> {
  readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}

Added in v1.0.0

Type (type alias)

Signature

export type Type = IoTJobsDataPlaneService$

Added in v1.0.0