Module Values.DescribeConnectionResponseSource

Retrieves details about a connection.

Sourcetype nonrec t = {
  1. connectionArn : ConnectionArn.t option;
    (*

    The ARN of the connection retrieved.

    *)
  2. name : ConnectionName.t option;
    (*

    The name of the connection retrieved.

    *)
  3. description : ConnectionDescription.t option;
    (*

    The description for the connection retrieved.

    *)
  4. invocationConnectivityParameters : DescribeConnectionConnectivityParameters.t option;
    (*

    For connections to private APIs The parameters EventBridge uses to invoke the resource endpoint. For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

    *)
  5. connectionState : ConnectionState.t option;
    (*

    The state of the connection retrieved.

    *)
  6. stateReason : ConnectionStateReason.t option;
    (*

    The reason that the connection is in the current connection state.

    *)
  7. authorizationType : ConnectionAuthorizationType.t option;
    (*

    The type of authorization specified for the connection.

    *)
  8. secretArn : SecretsManagerSecretArn.t option;
    (*

    The ARN of the secret created from the authorization parameters specified for the connection.

    *)
  9. kmsKeyIdentifier : KmsKeyIdentifier.t option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified. For more information, see Encrypting connections in the Amazon EventBridge User Guide.

    *)
  10. authParameters : ConnectionAuthResponseParameters.t option;
    (*

    The parameters to use for authorization for the connection.

    *)
  11. creationTime : Timestamp.t option;
    (*

    A time stamp for the time that the connection was created.

    *)
  12. lastModifiedTime : Timestamp.t option;
    (*

    A time stamp for the time that the connection was last modified.

    *)
  13. lastAuthorizedTime : Timestamp.t option;
    (*

    A time stamp for the time that the connection was last authorized.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalException of InternalException.t
  2. | `ResourceNotFoundException of ResourceNotFoundException.t
  3. | `Unknown_operation_error of string * string option
]
Sourceval make : ?connectionArn:??? -> ?name:??? -> ?description:??? -> ?invocationConnectivityParameters:??? -> ?connectionState:??? -> ?stateReason:??? -> ?authorizationType:??? -> ?secretArn:??? -> ?kmsKeyIdentifier:??? -> ?authParameters:??? -> ?creationTime:??? -> ?lastModifiedTime:??? -> ?lastAuthorizedTime:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalException of unit | `ResourceNotFoundException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalException of unit | `ResourceNotFoundException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of ConnectionArn.t | `Structure of (string * [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Boolean of Boolean.t | `String of HeaderKey.t ]) list ] list | `String of ResourceConfigurationArn.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Boolean of Boolean.t | `String of HeaderKey.t ]) list ] list | `String of AuthHeaderParameters.t ]) list ]) 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