Module Values.GetEngagementInvitationResponseSource

Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.

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

    The Amazon Resource Name (ARN) that identifies the engagement invitation.

    *)
  2. payloadType : EngagementInvitationPayloadType.t option;
    (*

    The type of payload contained in the engagement invitation, indicating what data or context the payload covers.

    *)
  3. id : EngagementInvitationArnOrIdentifier.t option;
    (*

    Unique identifier assigned to the engagement invitation being retrieved.

    *)
  4. engagementId : EngagementIdentifier.t option;
    (*

    The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.

    *)
  5. engagementTitle : EngagementTitle.t option;
    (*

    The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.

    *)
  6. status : InvitationStatus.t option;
    (*

    The current status of the engagement invitation.

    *)
  7. invitationDate : DateTime.t option;
    (*

    The date when the engagement invitation was sent to the partner.

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

    Indicates the date on which the engagement invitation will expire if not accepted by the partner.

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

    Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

    *)
  10. senderCompanyName : GetEngagementInvitationResponseSenderCompanyNameString.t option;
    (*

    The name of the AWS organization or team that sent the engagement invitation.

    *)
  11. receiver : Receiver.t option;
    (*

    Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

    *)
  12. catalog : CatalogIdentifier.t option;
    (*

    Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.

    *)
  13. rejectionReason : RejectionReasonString.t option;
    (*

    If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

    *)
  14. payload : Payload.t option;
    (*

    Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.

    *)
  15. invitationMessage : InvitationMessage.t option;
    (*

    The message sent to the invited partner when the invitation was created.

    *)
  16. engagementDescription : EngagementDescription.t option;
    (*

    The description of the engagement associated with this invitation.

    *)
  17. existingMembers : EngagementMemberSummaries.t option;
    (*

    A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties. CompanyName: The name of the member's company. WebsiteUrl: The website URL of the member's company.

    *)
}
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 : ?arn:??? -> ?payloadType:??? -> ?id:??? -> ?engagementId:??? -> ?engagementTitle:??? -> ?status:??? -> ?invitationDate:??? -> ?expirationDate:??? -> ?senderAwsAccountId:??? -> ?senderCompanyName:??? -> ?receiver:??? -> ?catalog:??? -> ?rejectionReason:??? -> ?payload:??? -> ?invitationMessage:??? -> ?engagementDescription:??? -> ?existingMembers:??? -> 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 * [> `Enum of string | `List of [> `Structure of (string * [> `String of MemberCompanyName.t ]) list ] list | `String of String_.t | `Structure of (string * [> `Structure of (string * [> `List of [> `Enum of string | `Structure of (string * [> `String of SenderContactEmail.t ]) list ] list | `String of Alias.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of Amount.t ]) list ] list | `String of CompanyName.t ]) list ]) list ]) list | `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