Module Values.DescribeGatewayResponseSource

Retrieves information about a gateway.

Sourcetype nonrec t = {
  1. gatewayId : ID.t option;
    (*

    The ID of the gateway device.

    *)
  2. gatewayName : GatewayName.t option;
    (*

    The name of the gateway.

    *)
  3. gatewayArn : ARN.t option;
    (*

    The ARN of the gateway, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

    *)
  4. gatewayPlatform : GatewayPlatform.t option;
    (*

    The gateway's platform.

    *)
  5. gatewayVersion : GatewayVersion.t option;
    (*

    The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

    *)
  6. gatewayCapabilitySummaries : GatewayCapabilitySummaries.t option;
    (*

    A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

    *)
  7. creationDate : Timestamp.t option;
    (*

    The date the gateway was created, in Unix epoch time.

    *)
  8. lastUpdateDate : Timestamp.t option;
    (*

    The date the gateway was last updated, in Unix epoch time.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalFailureException of InternalFailureException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?gatewayId:??? -> ?gatewayName:??? -> ?gatewayArn:??? -> ?gatewayPlatform:??? -> ?gatewayVersion:??? -> ?gatewayCapabilitySummaries:??? -> ?creationDate:??? -> ?lastUpdateDate:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalFailureException of InternalFailureException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalFailureException of InternalFailureException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `String of CapabilityNamespace.t ]) list ] list | `String of ID.t | `Structure of (string * [> `Structure of (string * [> `Enum of string | `String of ARN.t ]) list ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t