Skip to main content

opportunities

Creates, updates, deletes, gets or lists an opportunities resource.

Overview

Nameopportunities
TypeResource
Idaws.partnercentral_selling.opportunities

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) that uniquely identifies the opportunity. (pattern: <code>arn:.*</code>)
catalogstringSpecifies 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. (pattern: <code>[a-zA-Z]+</code>)
created_datestring (date-time)DateTime when the Opportunity was last created.
customerobjectSpecifies details of the customer associated with the Opportunity.
idstringRead-only, system generated Opportunity unique identifier. (pattern: <code>O[0-9]{1,19}</code>)
last_modified_datestring (date-time)DateTime when the opportunity was last modified.
life_cycleobjectAn object that contains lifecycle details for the Opportunity.
marketingobjectAn object that contains marketing details for the Opportunity.
national_securitystringIndicates 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. (Yes, No)
opportunity_teamarrayRepresents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.
opportunity_typestringSpecifies 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. (Net New Business, Flat Renewal, Expansion)
partner_opportunity_identifierstringSpecifies 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. (pattern: <code>(?s).{0,64}</code>)
primary_needs_from_awsarrayIdentifies 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.
projectobjectAn object that contains project details summary for the Opportunity.
related_entity_identifiersobjectProvides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.
software_revenueobjectSpecifies details of a customer's procurement terms. Required only for partners in eligible programs.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_opportunityselectregionFetches 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.
list_opportunitiesselectregionThis request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action. To synchronize your system with Amazon Web Services, list only the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus. You can also use the ListOpportunities action. We recommend the following approach: Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.
create_opportunityinsertregion, ClientTokenCreates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to Pending Submission. To submit an opportunity, follow these steps: To create the opportunity, use CreateOpportunity. To associate a solution with the opportunity, use AssociateOpportunity. To start the engagement with AWS, use StartEngagementFromOpportunity. After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state. There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.
associate_opportunityupdateregion, OpportunityIdentifier, RelatedEntityType, RelatedEntityIdentifierEnables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types: Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services. Amazon Web Services Products: Amazon Web Services offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, see Private offers in Amazon Web Services Marketplace. To obtain identifiers for these entities, use the following methods: Solution: Use the ListSolutions operation. AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Use the Using the Amazon Web Services Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request returns the details of available private offers. For more information, see ListEntities.
assign_opportunityupdateregion, Identifier, AssigneeEnables you to reassign an existing Opportunity to another user within your Partner Central account. The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity. This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one who creates it. Currently, there's no API to enumerate the list of available users.
update_opportunityupdateregion, LastModifiedDate, IdentifierUpdates the Opportunity record identified by a given Identifier. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate. When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to null. The best practice is to always perform a GetOpportunity to retrieve the latest values, then send the complete payload with the updated values to be changed.
disassociate_opportunityexecregion, OpportunityIdentifier, RelatedEntityType, RelatedEntityIdentifierAllows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change. Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.
start_opportunity_from_engagement_taskexecregion, ClientToken, Identifier, ContextIdentifierThis action creates an opportunity from an existing engagement context. The task is asynchronous and orchestrates the process of converting engagement contextual information into a structured opportunity record within the partner's account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

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.

SELECT
arn,
catalog,
created_date,
customer,
id,
last_modified_date,
life_cycle,
marketing,
national_security,
opportunity_team,
opportunity_type,
partner_opportunity_identifier,
primary_needs_from_aws,
project,
related_entity_identifiers,
software_revenue
FROM aws.partnercentral_selling.opportunities
WHERE region = '{{ region }}' -- required
;

INSERT examples

Creates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to Pending Submission. To submit an opportunity, follow these steps: To create the opportunity, use CreateOpportunity. To associate a solution with the opportunity, use AssociateOpportunity. To start the engagement with AWS, use StartEngagementFromOpportunity. After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state. There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

INSERT INTO aws.partnercentral_selling.opportunities (
Catalog,
PrimaryNeedsFromAws,
NationalSecurity,
PartnerOpportunityIdentifier,
Customer,
Project,
OpportunityType,
Marketing,
SoftwareRevenue,
ClientToken,
LifeCycle,
Origin,
OpportunityTeam,
Tags,
region
)
SELECT
'{{ Catalog }}',
'{{ PrimaryNeedsFromAws }}',
'{{ NationalSecurity }}',
'{{ PartnerOpportunityIdentifier }}',
'{{ Customer }}',
'{{ Project }}',
'{{ OpportunityType }}',
'{{ Marketing }}',
'{{ SoftwareRevenue }}',
'{{ ClientToken }}' /* required */,
'{{ LifeCycle }}',
'{{ Origin }}',
'{{ OpportunityTeam }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
id,
last_modified_date,
partner_opportunity_identifier
;

UPDATE examples

Enables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types: Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services. Amazon Web Services Products: Amazon Web Services offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, see Private offers in Amazon Web Services Marketplace. To obtain identifiers for these entities, use the following methods: Solution: Use the ListSolutions operation. AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Use the Using the Amazon Web Services Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request returns the details of available private offers. For more information, see ListEntities.

UPDATE aws.partnercentral_selling.opportunities
SET
Catalog = '{{ Catalog }}',
OpportunityIdentifier = '{{ OpportunityIdentifier }}',
RelatedEntityType = '{{ RelatedEntityType }}',
RelatedEntityIdentifier = '{{ RelatedEntityIdentifier }}'
WHERE
region = '{{ region }}' --required
AND OpportunityIdentifier = '{{ OpportunityIdentifier }}' --required
AND RelatedEntityType = '{{ RelatedEntityType }}' --required
AND RelatedEntityIdentifier = '{{ RelatedEntityIdentifier }}' --required;

Lifecycle Methods

Allows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change. Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.

EXEC aws.partnercentral_selling.opportunities.disassociate_opportunity
@region='{{ region }}' --required
@@json=
'{
"Catalog": "{{ Catalog }}",
"OpportunityIdentifier": "{{ OpportunityIdentifier }}",
"RelatedEntityType": "{{ RelatedEntityType }}",
"RelatedEntityIdentifier": "{{ RelatedEntityIdentifier }}"
}'
;