Skip to content

OpportunitySummary

Source code in docs_src/capo_partnercentral_selling/types/opportunity_summary.py
class OpportunitySummary(TypedDict, closed=True):
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier"
    """<p>Specifies the catalog associated with the opportunity, either <code>AWS</code> or <code>Sandbox</code>. This indicates the environment in which the opportunity is managed.</p>"""
    id: NotRequired[
        "capo_partnercentral_selling.types.opportunity_identifier.OpportunityIdentifier"
    ]
    """<p>Read-only, system-generated <code>Opportunity</code> unique identifier.</p>"""
    arn: NotRequired["capo_partnercentral_selling.types.opportunity_arn.OpportunityArn"]
    """<p> The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier can be used for IAM policies and cross-service references. </p>"""
    partner_opportunity_identifier: NotRequired["str"]
    """<p>Specifies the <code>Opportunity</code>'s unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM.</p>"""
    opportunity_type: NotRequired[
        "capo_partnercentral_selling.types.opportunity_type.OpportunityType"
    ]
    """<p>Specifies opportunity type as a renewal, new, or expansion.</p> <p>Opportunity types:</p> <ul> <li> <p>New Opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.</p> </li> <li> <p>Renewal Opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.</p> </li> <li> <p>Expansion Opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.</p> </li> </ul>"""
    last_modified_date: NotRequired[
        "capo_partnercentral_selling.types.date_time.DateTime"
    ]
    """<p> <code>DateTime</code> when the <code>Opportunity</code> was last modified.</p>"""
    created_date: NotRequired["capo_partnercentral_selling.types.date_time.DateTime"]
    """<p> <code>DateTime</code> when the <code>Opportunity</code> was last created.</p>"""
    life_cycle: NotRequired[
        "capo_partnercentral_selling.types.life_cycle_summary.LifeCycleSummary"
    ]
    """<p>An object that contains the <code>Opportunity</code>'s lifecycle details.</p>"""
    customer: NotRequired[
        "capo_partnercentral_selling.types.customer_summary.CustomerSummary"
    ]
    """<p>An object that contains the <code>Opportunity</code>'s customer details.</p>"""
    project: NotRequired[
        "capo_partnercentral_selling.types.project_summary.ProjectSummary"
    ]
    """<p>An object that contains the <code>Opportunity</code>'s project details summary.</p>"""

arn instance-attribute

arn: NotRequired[OpportunityArn]

The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier can be used for IAM policies and cross-service references.

catalog instance-attribute

Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.

created_date instance-attribute

created_date: NotRequired[DateTime]

DateTime when the Opportunity was last created.

customer instance-attribute

customer: NotRequired[CustomerSummary]

An object that contains the Opportunity's customer details.

id instance-attribute

id: NotRequired[OpportunityIdentifier]

Read-only, system-generated Opportunity unique identifier.

last_modified_date instance-attribute

last_modified_date: NotRequired[DateTime]

DateTime when the Opportunity was last modified.

life_cycle instance-attribute

life_cycle: NotRequired[LifeCycleSummary]

An object that contains the Opportunity's lifecycle details.

opportunity_type instance-attribute

opportunity_type: NotRequired[OpportunityType]

Specifies opportunity type as a renewal, new, or expansion.

Opportunity types:

  • New Opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

  • Renewal Opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

  • Expansion Opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

partner_opportunity_identifier instance-attribute

partner_opportunity_identifier: NotRequired[str]

Specifies the Opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM.

project instance-attribute

project: NotRequired[ProjectSummary]

An object that contains the Opportunity's project details summary.