Module Values.GetFlowResponseSource

Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Sourcetype nonrec t = {
  1. name : FlowName.t option;
    (*

    The name of the flow.

    *)
  2. description : FlowDescription.t option;
    (*

    The description of the flow.

    *)
  3. executionRoleArn : FlowExecutionRoleArn.t option;
    (*

    The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

    *)
  4. customerEncryptionKeyArn : KmsKeyArn.t option;
    (*

    The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

    *)
  5. id : FlowId.t option;
    (*

    The unique identifier of the flow.

    *)
  6. arn : FlowArn.t option;
    (*

    The Amazon Resource Name (ARN) of the flow.

    *)
  7. status : FlowStatus.t option;
    (*

    The status of the flow. The following statuses are possible: NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version. Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing. Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing. Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

    *)
  8. createdAt : DateTimestamp.t option;
    (*

    The time at which the flow was created.

    *)
  9. updatedAt : DateTimestamp.t option;
    (*

    The time at which the flow was last updated.

    *)
  10. version : DraftVersion.t option;
    (*

    The version of the flow for which information was retrieved.

    *)
  11. definition : FlowDefinition.t option;
    (*

    The definition of the nodes and connections between the nodes in the flow.

    *)
  12. validations : FlowValidations.t option;
    (*

    A list of validation error messages related to the last failed operation on the flow.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?name:??? -> ?description:??? -> ?executionRoleArn:??? -> ?customerEncryptionKeyArn:??? -> ?id:??? -> ?arn:??? -> ?status:??? -> ?createdAt:??? -> ?updatedAt:??? -> ?version:??? -> ?definition:??? -> ?validations:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.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 * Awso.Botodata.value) 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