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

IoTDataPlaneService overview

Added in v1.0.0


Table of contents


constructors

makeIoTDataPlaneService

Signature

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

Added in v1.0.0

models

IoTDataPlaneService (class)

Signature

export declare class IoTDataPlaneService

Added in v1.0.0

IoTDataPlaneService$ (interface)

Signature

export interface IoTDataPlaneService$ {
  /**
   * @see {@link DeleteConnectionCommand}
   */
  deleteConnection(
    args: DeleteConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteConnectionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ForbiddenError
    | InternalFailureError
    | InvalidRequestError
    | ResourceNotFoundError
    | ThrottlingError
  >

  /**
   * @see {@link DeleteThingShadowCommand}
   */
  deleteThingShadow(
    args: DeleteThingShadowCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteThingShadowCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalFailureError
    | InvalidRequestError
    | MethodNotAllowedError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
    | UnauthorizedError
    | UnsupportedDocumentEncodingError
  >

  /**
   * @see {@link GetConnectionCommand}
   */
  getConnection(
    args: GetConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetConnectionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ForbiddenError
    | InternalFailureError
    | InvalidRequestError
    | ResourceNotFoundError
    | ThrottlingError
  >

  /**
   * @see {@link GetRetainedMessageCommand}
   */
  getRetainedMessage(
    args: GetRetainedMessageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetRetainedMessageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalFailureError
    | InvalidRequestError
    | MethodNotAllowedError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
    | UnauthorizedError
  >

  /**
   * @see {@link GetThingShadowCommand}
   */
  getThingShadow(
    args: GetThingShadowCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetThingShadowCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalFailureError
    | InvalidRequestError
    | MethodNotAllowedError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
    | UnauthorizedError
    | UnsupportedDocumentEncodingError
  >

  /**
   * @see {@link ListNamedShadowsForThingCommand}
   */
  listNamedShadowsForThing(
    args: ListNamedShadowsForThingCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListNamedShadowsForThingCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalFailureError
    | InvalidRequestError
    | MethodNotAllowedError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
    | UnauthorizedError
  >

  /**
   * @see {@link ListRetainedMessagesCommand}
   */
  listRetainedMessages(
    args: ListRetainedMessagesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListRetainedMessagesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalFailureError
    | InvalidRequestError
    | MethodNotAllowedError
    | ServiceUnavailableError
    | ThrottlingError
    | UnauthorizedError
  >

  listRetainedMessagesStream(
    args: ListRetainedMessagesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListRetainedMessagesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalFailureError
    | InvalidRequestError
    | MethodNotAllowedError
    | ServiceUnavailableError
    | ThrottlingError
    | UnauthorizedError
  >

  /**
   * @see {@link ListSubscriptionsCommand}
   */
  listSubscriptions(
    args: ListSubscriptionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListSubscriptionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ForbiddenError
    | InternalFailureError
    | InvalidRequestError
    | ResourceNotFoundError
    | ThrottlingError
  >

  listSubscriptionsStream(
    args: ListSubscriptionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListSubscriptionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ForbiddenError
    | InternalFailureError
    | InvalidRequestError
    | ResourceNotFoundError
    | ThrottlingError
  >

  /**
   * @see {@link PublishCommand}
   */
  publish(
    args: PublishCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PublishCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalFailureError
    | InvalidRequestError
    | MethodNotAllowedError
    | ThrottlingError
    | UnauthorizedError
  >

  /**
   * @see {@link SendDirectMessageCommand}
   */
  sendDirectMessage(
    args: SendDirectMessageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    SendDirectMessageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ForbiddenError
    | GatewayTimeoutError
    | InternalFailureError
    | InvalidRequestError
    | RequestEntityTooLargeError
    | ResourceNotFoundError
    | ThrottlingError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateThingShadowCommand}
   */
  updateThingShadow(
    args: UpdateThingShadowCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateThingShadowCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalFailureError
    | InvalidRequestError
    | MethodNotAllowedError
    | RequestEntityTooLargeError
    | ServiceUnavailableError
    | ThrottlingError
    | UnauthorizedError
    | UnsupportedDocumentEncodingError
  >
}

Added in v1.0.0

utils

IoTDataPlaneService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = IoTDataPlaneService$

Added in v1.0.0