Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetOpportunity

Fetches the Opportunity record from Partner Central by a given Identifier.

Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.

Request Syntax


{
   "Catalog": "string",
   "Identifier": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

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

Catalog

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 is fetched from. Use AWS to retrieve opportunities in the AWS catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

Type: String

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

Required: Yes

Identifier

Read-only, system generated Opportunity unique identifier.

Type: String

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

Required: Yes

Response Syntax


{
   "Catalog": "string",
   "CreatedDate": "string",
   "Customer": { 
      "Account": { 
         "Address": { 
            "City": "string",
            "CountryCode": "string",
            "PostalCode": "string",
            "StateOrRegion": "string",
            "StreetAddress": "string"
         },
         "AwsAccountId": "string",
         "CompanyName": "string",
         "Duns": "string",
         "Industry": "string",
         "OtherIndustry": "string",
         "WebsiteUrl": "string"
      },
      "Contacts": [ 
         { 
            "BusinessTitle": "string",
            "Email": "string",
            "FirstName": "string",
            "LastName": "string",
            "Phone": "string"
         }
      ]
   },
   "Id": "string",
   "LastModifiedDate": "string",
   "LifeCycle": { 
      "ClosedLostReason": "string",
      "NextSteps": "string",
      "NextStepsHistory": [ 
         { 
            "Time": "string",
            "Value": "string"
         }
      ],
      "ReviewComments": "string",
      "ReviewStatus": "string",
      "ReviewStatusReason": "string",
      "Stage": "string",
      "TargetCloseDate": "string"
   },
   "Marketing": { 
      "AwsFundingUsed": "string",
      "CampaignName": "string",
      "Channels": [ "string" ],
      "Source": "string",
      "UseCases": [ "string" ]
   },
   "NationalSecurity": "string",
   "OpportunityTeam": [ 
      { 
         "BusinessTitle": "string",
         "Email": "string",
         "FirstName": "string",
         "LastName": "string",
         "Phone": "string"
      }
   ],
   "OpportunityType": "string",
   "PartnerOpportunityIdentifier": "string",
   "PrimaryNeedsFromAws": [ "string" ],
   "Project": { 
      "AdditionalComments": "string",
      "ApnPrograms": [ "string" ],
      "CompetitorName": "string",
      "CustomerBusinessProblem": "string",
      "CustomerUseCase": "string",
      "DeliveryModels": [ "string" ],
      "ExpectedCustomerSpend": [ 
         { 
            "Amount": "string",
            "CurrencyCode": "string",
            "Frequency": "string",
            "TargetCompany": "string"
         }
      ],
      "OtherCompetitorNames": "string",
      "OtherSolutionDescription": "string",
      "RelatedOpportunityIdentifier": "string",
      "SalesActivities": [ "string" ],
      "Title": "string"
   },
   "RelatedEntityIdentifiers": { 
      "AwsMarketplaceOffers": [ "string" ],
      "AwsProducts": [ "string" ],
      "Solutions": [ "string" ]
   },
   "SoftwareRevenue": { 
      "DeliveryModel": "string",
      "EffectiveDate": "string",
      "ExpirationDate": "string",
      "Value": { 
         "Amount": "string",
         "CurrencyCode": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Catalog

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 AWS catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

Type: String

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

CreatedDate

DateTime when the Opportunity was last created.

Type: Timestamp

Id

Read-only, system generated Opportunity unique identifier.

Type: String

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

LastModifiedDate

DateTime when the opportunity was last modified.

Type: Timestamp

RelatedEntityIdentifiers

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

Type: RelatedEntityIdentifiers object

Customer

Specifies details of the customer associated with the Opportunity.

Type: Customer object

LifeCycle

An object that contains lifecycle details for the Opportunity.

Type: LifeCycle object

Marketing

An object that contains marketing details for the Opportunity.

Type: Marketing object

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.

Type: String

Valid Values: Yes | No

OpportunityTeam

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

Type: Array of Contact objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

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, 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

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

PrimaryNeedsFromAws

Identifies the type of support the partner needs from AWS.

Valid values:

Cosell—Architectural Validation: Confirmation from AWS that the partner's proposed solution architecture is aligned with AWS best practices and poses minimal architectural risks.
Cosell—Business Presentation: Request AWS seller's participation in a joint customer presentation.
Cosell—Competitive Information: Access to AWS competitive resources and support for the partner's proposed solution.
Cosell—Pricing Assistance: Connect with an AWS 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 AWS 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 AWS versus on-premises or a traditional hosting environment.
Cosell—Deal Support: Request AWS 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 AWS RFx support.
Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an AWS sales representative, and the partner solely manages the opportunity. It's possible to request co-selling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.

Type: Array of strings

Project

An object that contains project details summary for the Opportunity.

Type: Project object

SoftwareRevenue

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

Type: SoftwareRevenue object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

HTTP Status Code: 400

InternalServerException

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

HTTP Status Code: 500

ResourceNotFoundException

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

HTTP Status Code: 400

ThrottlingException

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

HTTP Status Code: 400