Skip to content

GetOpportunityResponse

Source code in docs_src/capo_partnercentral_selling/types/get_opportunity_response.py
class GetOpportunityResponse(TypedDict, closed=True):
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier"
    """<p>Specifies the catalog associated with the request. This field takes a string value from a predefined list: <code>AWS</code> or <code>Sandbox</code>. The catalog determines which environment the opportunity information is retrieved from. Use <code>AWS</code> to retrieve opportunities in the Amazon Web Services catalog, and <code>Sandbox</code> to retrieve opportunities in a secure and isolated testing environment.</p>"""
    primary_needs_from_aws: NotRequired[
        "capo_partnercentral_selling.types.primary_needs_from_aws.PrimaryNeedsFromAws"
    ]
    """<p>Identifies the type of support the partner needs from Amazon Web Services.</p> <p>Valid values:</p> <ul> <li> <p>Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.</p> </li> <li> <p>Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.</p> </li> <li> <p>Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.</p> </li> <li> <p>Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).</p> </li> <li> <p>Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.</p> </li> <li> <p>Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.</p> </li> <li> <p>Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).</p> </li> <li> <p>Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.</p> </li> </ul>"""
    national_security: NotRequired[
        "capo_partnercentral_selling.types.national_security.NationalSecurity"
    ]
    """<p>Indicates whether the <code>Opportunity</code> pertains to a national security project. This field must be set to <code>true</code> only when the customer's industry is <i>Government</i>. Additional privacy and security measures apply during the review and management process for opportunities marked as <code>NationalSecurity</code>.</p>"""
    partner_opportunity_identifier: NotRequired["str"]
    """<p>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.</p>"""
    customer: NotRequired["capo_partnercentral_selling.types.customer.Customer"]
    """<p>Specifies details of the customer associated with the <code>Opportunity</code>.</p>"""
    project: NotRequired["capo_partnercentral_selling.types.project.Project"]
    """<p>An object that contains project details summary for the <code>Opportunity</code>.</p>"""
    opportunity_type: NotRequired[
        "capo_partnercentral_selling.types.opportunity_type.OpportunityType"
    ]
    """<p>Specifies the opportunity type as 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, which helps to ensure service continuity.</p> </li> <li> <p>Expansion opportunity: Represents an opportunity to expand the scope of a customer's contract or subscription, either by adding new services or increasing the volume of existing services.</p> </li> </ul>"""
    marketing: NotRequired["capo_partnercentral_selling.types.marketing.Marketing"]
    """<p>An object that contains marketing details for the <code>Opportunity</code>.</p>"""
    software_revenue: NotRequired[
        "capo_partnercentral_selling.types.software_revenue.SoftwareRevenue"
    ]
    """<p>Specifies details of a customer's procurement terms. Required only for partners in eligible programs.</p>"""
    id: "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) that uniquely identifies the opportunity.</p>"""
    last_modified_date: "capo_partnercentral_selling.types.date_time.DateTime"
    """<p> <code>DateTime</code> when the opportunity was last modified.</p>"""
    created_date: "capo_partnercentral_selling.types.date_time.DateTime"
    """<p> <code>DateTime</code> when the <code>Opportunity</code> was last created.</p>"""
    related_entity_identifiers: "capo_partnercentral_selling.types.related_entity_identifiers.RelatedEntityIdentifiers"
    """<p>Provides information about the associations of other entities with the opportunity. These entities include identifiers for <code>AWSProducts</code>, <code>Partner Solutions</code>, and <code>AWSMarketplaceOffers</code>.</p>"""
    life_cycle: NotRequired["capo_partnercentral_selling.types.life_cycle.LifeCycle"]
    """<p>An object that contains lifecycle details for the <code>Opportunity</code>.</p>"""
    opportunity_team: NotRequired[
        "capo_partnercentral_selling.types.partner_opportunity_team_members_list.PartnerOpportunityTeamMembersList"
    ]
    """<p>Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.</p>"""

arn instance-attribute

arn: NotRequired[OpportunityArn]

The Amazon Resource Name (ARN) that uniquely identifies the opportunity.

catalog instance-attribute

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

created_date instance-attribute

created_date: DateTime

DateTime when the Opportunity was last created.

customer instance-attribute

customer: NotRequired[Customer]

Specifies details of the customer associated with the Opportunity.

id instance-attribute

Read-only, system generated Opportunity unique identifier.

last_modified_date instance-attribute

last_modified_date: DateTime

DateTime when the opportunity was last modified.

life_cycle instance-attribute

life_cycle: NotRequired[LifeCycle]

An object that contains lifecycle details for the Opportunity.

marketing instance-attribute

marketing: NotRequired[Marketing]

An object that contains marketing details for the Opportunity.

national_security instance-attribute

national_security: NotRequired[NationalSecurity]

Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.

opportunity_team instance-attribute

opportunity_team: NotRequired[PartnerOpportunityTeamMembersList]

Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.

opportunity_type instance-attribute

opportunity_type: NotRequired[OpportunityType]

Specifies the opportunity type as 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, which helps to ensure service continuity.

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

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.

primary_needs_from_aws instance-attribute

primary_needs_from_aws: NotRequired[PrimaryNeedsFromAws]

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

  • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

  • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

  • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

  • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

  • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

  • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

  • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

  • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

project instance-attribute

project: NotRequired[Project]

An object that contains project details summary for the Opportunity.

related_entity_identifiers instance-attribute

related_entity_identifiers: RelatedEntityIdentifiers

Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

software_revenue instance-attribute

software_revenue: NotRequired[SoftwareRevenue]

Specifies details of a customer's procurement terms. Required only for partners in eligible programs.