Skip to content

GetEngagementInvitationResponse

Source code in docs_src/capo_partnercentral_selling/types/get_engagement_invitation_response.py
class GetEngagementInvitationResponse(TypedDict, closed=True):
    arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) that identifies the engagement invitation.</p>"""
    payload_type: NotRequired[
        "capo_partnercentral_selling.types.engagement_invitation_payload_type.EngagementInvitationPayloadType"
    ]
    """<p>The type of payload contained in the engagement invitation, indicating what data or context the payload covers.</p>"""
    id: "capo_partnercentral_selling.types.engagement_invitation_arn_or_identifier.EngagementInvitationArnOrIdentifier"
    """<p>Unique identifier assigned to the engagement invitation being retrieved.</p>"""
    engagement_id: NotRequired[
        "capo_partnercentral_selling.types.engagement_identifier.EngagementIdentifier"
    ]
    """<p>The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.</p>"""
    engagement_title: NotRequired[
        "capo_partnercentral_selling.types.engagement_title.EngagementTitle"
    ]
    """<p>The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.</p>"""
    status: NotRequired[
        "capo_partnercentral_selling.types.invitation_status.InvitationStatus"
    ]
    """<p>The current status of the engagement invitation.</p>"""
    invitation_date: NotRequired["capo_partnercentral_selling.types.date_time.DateTime"]
    """<p>The date when the engagement invitation was sent to the partner.</p>"""
    expiration_date: NotRequired["capo_partnercentral_selling.types.date_time.DateTime"]
    """<p>Indicates the date on which the engagement invitation will expire if not accepted by the partner.</p>"""
    sender_aws_account_id: NotRequired[
        "capo_partnercentral_selling.types.aws_account.AwsAccount"
    ]
    """<p>Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.</p>"""
    sender_company_name: NotRequired["str"]
    """<p>The name of the AWS organization or team that sent the engagement invitation.</p>"""
    receiver: NotRequired["capo_partnercentral_selling.types.receiver.Receiver"]
    """<p>Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.</p>"""
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier"
    """<p>Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., <code>AWS</code> or <code>Sandbox</code>) used in the request.</p>"""
    rejection_reason: NotRequired[
        "capo_partnercentral_selling.types.rejection_reason_string.RejectionReasonString"
    ]
    """<p>If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.</p>"""
    payload: NotRequired["capo_partnercentral_selling.types.payload.Payload"]
    """<p>Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.</p>"""
    invitation_message: NotRequired[
        "capo_partnercentral_selling.types.invitation_message.InvitationMessage"
    ]
    """<p>The message sent to the invited partner when the invitation was created.</p>"""
    engagement_description: NotRequired[
        "capo_partnercentral_selling.types.engagement_description.EngagementDescription"
    ]
    """<p>The description of the engagement associated with this invitation.</p>"""
    existing_members: NotRequired[
        "capo_partnercentral_selling.types.engagement_member_summaries.EngagementMemberSummaries"
    ]
    """<p>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.</p> <ul> <li> <p>CompanyName: The name of the member's company.</p> </li> <li> <p>WebsiteUrl: The website URL of the member's company.</p> </li> </ul>"""
    enrichment_context: NotRequired[
        "capo_partnercentral_selling.types.enrichment_context.EnrichmentContext"
    ]
    """<p>The enrichment data for the engagement associated with this invitation. You can view propensity scores, program eligibility, and lead readiness assessments before taking action on the invitation.</p>"""

arn instance-attribute

arn: NotRequired[str]

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

catalog instance-attribute

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.

engagement_description instance-attribute

engagement_description: NotRequired[EngagementDescription]

The description of the engagement associated with this invitation.

engagement_id instance-attribute

engagement_id: NotRequired[EngagementIdentifier]

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

engagement_title instance-attribute

engagement_title: NotRequired[EngagementTitle]

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

enrichment_context instance-attribute

enrichment_context: NotRequired[EnrichmentContext]

The enrichment data for the engagement associated with this invitation. You can view propensity scores, program eligibility, and lead readiness assessments before taking action on the invitation.

existing_members instance-attribute

existing_members: NotRequired[EngagementMemberSummaries]

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.

expiration_date instance-attribute

expiration_date: NotRequired[DateTime]

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

id instance-attribute

Unique identifier assigned to the engagement invitation being retrieved.

invitation_date instance-attribute

invitation_date: NotRequired[DateTime]

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

invitation_message instance-attribute

invitation_message: NotRequired[InvitationMessage]

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

payload instance-attribute

payload: NotRequired[Payload]

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

payload_type instance-attribute

payload_type: NotRequired[EngagementInvitationPayloadType]

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

receiver instance-attribute

receiver: NotRequired[Receiver]

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

rejection_reason instance-attribute

rejection_reason: NotRequired[RejectionReasonString]

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

sender_aws_account_id instance-attribute

sender_aws_account_id: NotRequired[AwsAccount]

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

sender_company_name instance-attribute

sender_company_name: NotRequired[str]

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

status instance-attribute

status: NotRequired[InvitationStatus]

The current status of the engagement invitation.