Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetAwsOpportunitySummary

Retrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity sourced from AWS, such as lifecycle information, customer details, and involvement type. It is useful for tracking updates on the AWS opportunity corresponding to an opportunity in the partner's account.

Request Syntax


{
   "Catalog": "string",
   "RelatedOpportunityIdentifier": "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 in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.

Type: String

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

Required: Yes

RelatedOpportunityIdentifier

The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.

Type: String

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

Required: Yes

Response Syntax


{
   "Catalog": "string",
   "Customer": { 
      "Contacts": [ 
         { 
            "BusinessTitle": "string",
            "Email": "string",
            "FirstName": "string",
            "LastName": "string",
            "Phone": "string"
         }
      ]
   },
   "Insights": { 
      "EngagementScore": "string",
      "NextBestActions": "string"
   },
   "InvolvementType": "string",
   "InvolvementTypeChangeReason": "string",
   "LifeCycle": { 
      "ClosedLostReason": "string",
      "NextSteps": "string",
      "NextStepsHistory": [ 
         { 
            "Time": "string",
            "Value": "string"
         }
      ],
      "Stage": "string",
      "TargetCloseDate": "string"
   },
   "OpportunityTeam": [ 
      { 
         "BusinessTitle": "string",
         "Email": "string",
         "FirstName": "string",
         "LastName": "string"
      }
   ],
   "Origin": "string",
   "Project": { 
      "ExpectedCustomerSpend": [ 
         { 
            "Amount": "string",
            "CurrencyCode": "string",
            "Frequency": "string",
            "TargetCompany": "string"
         }
      ]
   },
   "RelatedEntityIds": { 
      "AwsProducts": [ "string" ],
      "Solutions": [ "string" ]
   },
   "RelatedOpportunityId": "string",
   "Visibility": "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 in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.

Type: String

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

Customer

Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other key customer data. These details help partners understand the business context of the opportunity.

Type: AwsOpportunityCustomer object

Insights

Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.

Type: AwsOpportunityInsights object

InvolvementType

Specifies the type of involvement AWS has in the opportunity, such as direct co-sell or advisory support. This field helps partners understand the role AWS will play in advancing the opportunity.

Type: String

Valid Values: For Visibility Only | Co-Sell

InvolvementTypeChangeReason

Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.

Type: String

Valid Values: Expansion Opportunity | Change in Deal Information | Customer Requested | Technical Complexity | Risk Mitigation

LifeCycle

Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.

Type: AwsOpportunityLifeCycle object

OpportunityTeam

Details the AWS Opportunity team, including key members involved in the opportunity. This information helps partners know who from AWS is engaged and their roles in the opportunity.

Type: Array of AwsTeamMember objects

Origin

Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.

Type: String

Valid Values: AWS Referral | Partner Referral

Project

Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.

Type: AwsOpportunityProject object

RelatedEntityIds

Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.

Type: AwsOpportunityRelatedEntities object

RelatedOpportunityId

Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.

Type: String

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

Visibility

Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.

Type: String

Valid Values: Full | Limited

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