OpportunitySummary - AWS Partner Central
ContentsSee Also

OpportunitySummary

An object that contains an Opportunity's subset of fields.

Contents

Note

In the following list, the required parameters are described first.

Catalog

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

Type: String

Pattern: ^[a-zA-Z]+$

Required: Yes

Arn

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

Type: String

Pattern: ^arn:.*$

Required: No

CreatedDate

DateTime when the Opportunity was last created.

Type: Timestamp

Required: No

Customer

An object that contains the Opportunity's customer details.

Type: CustomerSummary object

Required: No

Id

Read-only, system-generated Opportunity unique identifier.

Type: String

Pattern: ^O[0-9]{1,19}$

Required: No

LastModifiedDate

DateTime when the Opportunity was last modified.

Type: Timestamp

Required: No

LifeCycle

An object that contains the Opportunity's lifecycle details.

Type: LifeCycleSummary object

Required: No

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.

Type: String

Valid Values: Net New Business | Flat Renewal | Expansion

Required: No

PartnerOpportunityIdentifier

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.

Type: String

Required: No

Project

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

Type: ProjectSummary object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: