Module Values.GetEngagementResponseSource

Use this action to retrieve the engagement record for a given EngagementIdentifier.

Sourcetype nonrec t = {
  1. id : EngagementIdentifier.t option;
    (*

    The unique resource identifier of the engagement retrieved.

    *)
  2. arn : EngagementArn.t option;
    (*

    The Amazon Resource Name (ARN) of the engagement retrieved.

    *)
  3. title : EngagementTitle.t option;
    (*

    The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

    *)
  4. description : EngagementDescription.t option;
    (*

    A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

    *)
  5. createdAt : DateTime.t option;
    (*

    The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.

    *)
  6. createdBy : AwsAccount.t option;
    (*

    The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

    *)
  7. memberCount : Integer.t option;
    (*

    Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

    *)
  8. modifiedAt : DateTime.t option;
    (*

    The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z". This helps track the most recent changes to the engagement.

    *)
  9. modifiedBy : AwsAccount.t option;
    (*

    The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.

    *)
  10. contexts : EngagementContexts.t option;
    (*

    A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

    *)
}
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 : ?id:??? -> ?arn:??? -> ?title:??? -> ?description:??? -> ?createdAt:??? -> ?createdBy:??? -> ?memberCount:??? -> ?modifiedAt:??? -> ?modifiedBy:??? -> ?contexts:??? -> 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 * [> `Integer of Integer.t | `List of [> `Structure of (string * [> `Enum of string | `String of EngagementContextIdentifier.t | `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of LeadSourceType.t | `Structure of (string * [> `String of JobTitle.t ]) list | `Timestamp of DateTime.t ]) list ] list | `String of LeadQualificationStatus.t | `Structure of (string * [> `Enum of string | `String of CompanyName.t | `Structure of (string * [> `Enum of string | `String of AddressSummaryCityString.t ]) list ]) list ]) list ]) list ]) list ] list | `String of EngagementIdentifier.t | `Timestamp of DateTime.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