Module Values.DescribePipeResponseSource

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcetype nonrec t = {
  1. arn : PipeArn.t option;
    (*

    The ARN of the pipe.

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

    The name of the pipe.

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

    A description of the pipe.

    *)
  4. desiredState : RequestedPipeStateDescribeResponse.t option;
    (*

    The state the pipe should be in.

    *)
  5. currentState : PipeState.t option;
    (*

    The state the pipe is in.

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

    The reason the pipe is in its current state.

    *)
  7. source : ArnOrUrl.t option;
    (*

    The ARN of the source resource.

    *)
  8. sourceParameters : PipeSourceParameters.t option;
    (*

    The parameters required to set up a source for your pipe.

    *)
  9. enrichment : OptionalArn.t option;
    (*

    The ARN of the enrichment resource.

    *)
  10. enrichmentParameters : PipeEnrichmentParameters.t option;
    (*

    The parameters required to set up enrichment on your pipe.

    *)
  11. target : Arn.t option;
    (*

    The ARN of the target resource.

    *)
  12. targetParameters : PipeTargetParameters.t option;
    (*

    The parameters required to set up a target for your pipe. For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

    *)
  13. roleArn : RoleArn.t option;
    (*

    The ARN of the role that allows the pipe to send data to the target.

    *)
  14. tags : TagMap.t option;
    (*

    The list of key-value pairs to associate with the pipe.

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

    The time the pipe was created.

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

    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    *)
  17. logConfiguration : PipeLogConfiguration.t option;
    (*

    The logging configuration settings for the pipe.

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

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

    *)
}
Sourcetype nonrec error = [
  1. | `InternalException of InternalException.t
  2. | `NotFoundException of NotFoundException.t
  3. | `ThrottlingException of ThrottlingException.t
  4. | `ValidationException of ValidationException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?arn:??? -> ?name:??? -> ?description:??? -> ?desiredState:??? -> ?currentState:??? -> ?stateReason:??? -> ?source:??? -> ?sourceParameters:??? -> ?enrichment:??? -> ?enrichmentParameters:??? -> ?target:??? -> ?targetParameters:??? -> ?roleArn:??? -> ?tags:??? -> ?creationTime:??? -> ?lastModifiedTime:??? -> ?logConfiguration:??? -> ?kmsKeyIdentifier:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalException of InternalException.t | `NotFoundException of NotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalException of InternalException.t | `NotFoundException of NotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of PipeArn.t | `Structure of (string * [> `Enum of string | `List of [> `Enum of string ] list | `String of InputTemplate.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of LimitMax10000.t | `List of [> `String of EndpointString.t | `Structure of (string * [> `Enum of string | `Integer of CapacityProviderStrategyItemWeight.t | `List of [> `Structure of (string * [> `Enum of string | `String of MeasureValue.t ]) list ] list | `String of EventPattern.t ]) list ] list | `Map of ([> `String of HeaderKey.t ] * [> `String of HeaderValue.t ]) list | `String of MQBrokerQueueName.t | `Structure of (string * [> `Integer of BatchArraySize.t | `List of [> `String of SubnetId.t | `Structure of (string * [> `Enum of string | `Integer of Integer.t | `List of [> `String of String_.t | `Structure of (string * [> `Enum of string | `String of String_.t ]) list ] list | `String of String_.t ]) list ] list | `String of Arn.t | `Structure of (string * [> `Enum of string | `Integer of EphemeralStorageSize.t | `List of [> `String of Subnet.t ] list ]) list ]) list | `Timestamp of Timestamp.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