AWS Partner Central API for Selling Reference Guide
--Amazon Web Services (AWS) Partner Central API reference guide is designed to help -AWS Partners programmatically integrate their Customer Relationship Management (CRM) systems with AWS Partner Central. Through the Partner Central APIs, partners can automate and streamline their interactions with AWS Partner Central, ensuring a more efficient and effective engagement in joint business activities. -
--The AWS Partner Central API service provides standard AWS API functionality. You can directly use the API Actions, or you can use an AWS SDK to access an API that's tailored to the programming language or platform that you're using. For more information about AWS application development, see Getting Started with AWS. For more information about using AWS SDKs, see AWS SDKs. -
+This Amazon Web Services (AWS) Partner Central API reference is +designed to help AWS +Partners integrate Customer Relationship Management (CRM) +systems with AWS Partner Central. Partners can automate interactions with +AWS Partner Central, which helps to ensure effective engagements in joint +business activities.
+The API provides standard AWS API functionality. Access it by +either using API Actions or by using an AWS SDK that's tailored to your +programming language or platform. For more information, see Getting Started with +AWS and Tools to Build on AWS.
Features offered by AWS Partner Central API
-Opportunity management: Facilitates the management of co-selling opportunities with AWS using API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.
CreateOpportunity, UpdateOpportunity,
+ListOpportunities, GetOpportunity, and
+AssignOpportunity.
-AWS referral management: Facilitates receiving referrals shared by AWS using actions like ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.
ListEngagementInvitations,
+GetEngagementInvitation,
+StartEngagementByAcceptingInvitation, and
+RejectEngagementInvitation.
-Entity association: Associate related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity and DisassociateOpportunity.
AssociateOpportunity, and
+DisassociateOpportunity.
-View AWS opportunity details: Use the GetAWSOpportunitySummary action to retrieve real-time summaries of AWS opportunities that are linked to your opportunities.
GetAWSOpportunitySummary
+action.
-List solutions: Provides list APIs for listing solutions partners offer using ListSolutions.
ListSolutions.
-Event subscription: Partners can subscribe to real-time updates on opportunities by listening to events such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected and Engagement Invitation Created using AWS EventBridge.
+Event subscription: +Subscribe to real-time opportunity updates through AWS EventBridge by +using actions such as Opportunity Created, +Opportunity Updated, Engagement +Invitation Accepted, Engagement Invitation +Rejected, and Engagement Invitation +Created.* AWS Partner Central API for Selling Reference Guide *
- *- * Amazon Web Services (AWS) Partner Central API reference guide is designed to help - * AWS Partners programmatically integrate their Customer Relationship Management (CRM) systems with AWS Partner Central. Through the Partner Central APIs, partners can automate and streamline their interactions with AWS Partner Central, ensuring a more efficient and effective engagement in joint business activities. - *
- *- * The AWS Partner Central API service provides standard AWS API functionality. You can directly use the API Actions, or you can use an AWS SDK to access an API that's tailored to the programming language or platform that you're using. For more information about AWS application development, see Getting Started with AWS. For more information about using AWS SDKs, see AWS SDKs. - *
+ *This Amazon Web Services (AWS) Partner Central API reference is + * designed to help AWS + * Partners integrate Customer Relationship Management (CRM) + * systems with AWS Partner Central. Partners can automate interactions with + * AWS Partner Central, which helps to ensure effective engagements in joint + * business activities.
+ *The API provides standard AWS API functionality. Access it by + * either using API Actions or by using an AWS SDK that's tailored to your + * programming language or platform. For more information, see Getting Started with + * AWS and Tools to Build on AWS.
** Features offered by AWS Partner Central API *
*
- * Opportunity management: Facilitates the management of co-selling opportunities with AWS using API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.
CreateOpportunity, UpdateOpportunity,
+ * ListOpportunities, GetOpportunity, and
+ * AssignOpportunity.
*
- * AWS referral management: Facilitates receiving referrals shared by AWS using actions like ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.
ListEngagementInvitations,
+ * GetEngagementInvitation,
+ * StartEngagementByAcceptingInvitation, and
+ * RejectEngagementInvitation.
*
- * Entity association: Associate related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity and DisassociateOpportunity.
AssociateOpportunity, and
+ * DisassociateOpportunity.
*
- * View AWS opportunity details: Use the GetAWSOpportunitySummary action to retrieve real-time summaries of AWS opportunities that are linked to your opportunities.
GetAWSOpportunitySummary
+ * action.
*
- * List solutions: Provides list APIs for listing solutions partners offer using ListSolutions.
ListSolutions.
* - * Event subscription: Partners can subscribe to real-time updates on opportunities by listening to events such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected and Engagement Invitation Created using AWS EventBridge.
+ * Event subscription: + * Subscribe to real-time opportunity updates through AWS EventBridge by + * using actions such as Opportunity Created, + * Opportunity Updated, Engagement + * Invitation Accepted, Engagement Invitation + * Rejected, and Engagement Invitation + * Created. ** AWS Partner Central API for Selling Reference Guide *
- *- * Amazon Web Services (AWS) Partner Central API reference guide is designed to help - * AWS Partners programmatically integrate their Customer Relationship Management (CRM) systems with AWS Partner Central. Through the Partner Central APIs, partners can automate and streamline their interactions with AWS Partner Central, ensuring a more efficient and effective engagement in joint business activities. - *
- *- * The AWS Partner Central API service provides standard AWS API functionality. You can directly use the API Actions, or you can use an AWS SDK to access an API that's tailored to the programming language or platform that you're using. For more information about AWS application development, see Getting Started with AWS. For more information about using AWS SDKs, see AWS SDKs. - *
+ *This Amazon Web Services (AWS) Partner Central API reference is + * designed to help AWS + * Partners integrate Customer Relationship Management (CRM) + * systems with AWS Partner Central. Partners can automate interactions with + * AWS Partner Central, which helps to ensure effective engagements in joint + * business activities.
+ *The API provides standard AWS API functionality. Access it by + * either using API Actions or by using an AWS SDK that's tailored to your + * programming language or platform. For more information, see Getting Started with + * AWS and Tools to Build on AWS.
** Features offered by AWS Partner Central API *
*
- * Opportunity management: Facilitates the management of co-selling opportunities with AWS using API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.
CreateOpportunity, UpdateOpportunity,
+ * ListOpportunities, GetOpportunity, and
+ * AssignOpportunity.
*
- * AWS referral management: Facilitates receiving referrals shared by AWS using actions like ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.
ListEngagementInvitations,
+ * GetEngagementInvitation,
+ * StartEngagementByAcceptingInvitation, and
+ * RejectEngagementInvitation.
*
- * Entity association: Associate related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity and DisassociateOpportunity.
AssociateOpportunity, and
+ * DisassociateOpportunity.
*
- * View AWS opportunity details: Use the GetAWSOpportunitySummary action to retrieve real-time summaries of AWS opportunities that are linked to your opportunities.
GetAWSOpportunitySummary
+ * action.
*
- * List solutions: Provides list APIs for listing solutions partners offer using ListSolutions.
ListSolutions.
* - * Event subscription: Partners can subscribe to real-time updates on opportunities by listening to events such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected and Engagement Invitation Created using AWS EventBridge.
+ * Event subscription: + * Subscribe to real-time opportunity updates through AWS EventBridge by + * using actions such as Opportunity Created, + * Opportunity Updated, Engagement + * Invitation Accepted, Engagement Invitation + * Rejected, and Engagement Invitation + * Created. *This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/AssociateOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/AssociateOpportunityCommand.ts index b3c9ef81cdf9..684b7030542c 100644 --- a/clients/client-partnercentral-selling/src/commands/AssociateOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/AssociateOpportunityCommand.ts @@ -35,25 +35,25 @@ export interface AssociateOpportunityCommandOutput extends __MetadataBearer {} *
* 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 types of entities:
+ * 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 specific business challenges or achieve particular goals using Amazon Web Services services. + * 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 Product: - * Amazon Web Services offers a wide range of products and services designed to provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, refer to Amazon Web Services products. + * 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, refer to Private offers in Amazon Web Services Marketplace. + * 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. *
*- * AWS products: For the latest list of Amazon Web Services products, refer to - * the Amazon Web Services products list.
+ * AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products. + * *
- * Amazon Web Services Marketplace private offer: Use the AWS Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request to the ListEntities API returns the details of the private offers available to you. For more information, refer to ListEntities.
+ * 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.
*
This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/CreateOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/CreateOpportunityCommand.ts index 04453f5ac9b1..3997adeeca06 100644 --- a/clients/client-partnercentral-selling/src/commands/CreateOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/CreateOpportunityCommand.ts @@ -38,11 +38,11 @@ export interface CreateOpportunityCommandOutput extends CreateOpportunityRespons /** *
* Creates an Opportunity record in Partner Central. Use this operation to create
- * a potential business opportunity intended to be submitted to Amazon Web Services. Creating an opportunity sets its Lifecycle.ReviewStatus to
+ * a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to
* Pending Submission.
*
- * To fully submit an opportunity, follow these steps: + * To submit an opportunity, follow these steps: *
*To associate a solution with the opportunity, use AssociateOpportunity.
To submit the opportunity, use SubmitOpportunity.
To submit the opportunity, use StartEngagementFromOpportunityTask.
- * After submission, you can't edit the opportunity until the review is complete. However, opportunities in the
- * Pending Submission state still need all details completed. You can update
+ * 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 required to create opportunities, but consider providing optional fields to + * There's a set of mandatory fields to create opportunities, but consider providing optional fields to * enrich the opportunity record. *
* @example @@ -224,7 +224,7 @@ export interface CreateOpportunityCommandOutput extends CreateOpportunityRespons * usage to avoid throttling. * *This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/DisassociateOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/DisassociateOpportunityCommand.ts index a7bcc2c1dabc..dce348fc6616 100644 --- a/clients/client-partnercentral-selling/src/commands/DisassociateOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/DisassociateOpportunityCommand.ts @@ -33,7 +33,7 @@ export interface DisassociateOpportunityCommandOutput extends __MetadataBearer { /** *
- * 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.
+ * 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.
*
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 related entity that's required.
+ * one to be removed, especially if it's the last remaining entity that's required.
*
* @example
* Use a bare-bones client and the command you need to make an API call.
@@ -91,7 +91,7 @@ export interface DisassociateOpportunityCommandOutput extends __MetadataBearer {
* usage to avoid throttling.
*
* This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/GetAwsOpportunitySummaryCommand.ts b/clients/client-partnercentral-selling/src/commands/GetAwsOpportunitySummaryCommand.ts index f1ce90c23399..6f08b4e6eaff 100644 --- a/clients/client-partnercentral-selling/src/commands/GetAwsOpportunitySummaryCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetAwsOpportunitySummaryCommand.ts @@ -147,7 +147,7 @@ export interface GetAwsOpportunitySummaryCommandOutput extends GetAwsOpportunity * usage to avoid throttling. * *This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/GetEngagementInvitationCommand.ts b/clients/client-partnercentral-selling/src/commands/GetEngagementInvitationCommand.ts index 997712fdf954..727357877465 100644 --- a/clients/client-partnercentral-selling/src/commands/GetEngagementInvitationCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetEngagementInvitationCommand.ts @@ -36,7 +36,7 @@ export interface GetEngagementInvitationCommandInput extends GetEngagementInvita export interface GetEngagementInvitationCommandOutput extends GetEngagementInvitationResponse, __MetadataBearer {} /** - *Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes key aspects such as the customer, project details, and lifecycle information related to the engagement.
+ *Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.
This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/GetOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/GetOpportunityCommand.ts index d4c4ca4c999e..6af86f63be89 100644 --- a/clients/client-partnercentral-selling/src/commands/GetOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetOpportunityCommand.ts @@ -207,7 +207,7 @@ export interface GetOpportunityCommandOutput extends GetOpportunityResponse, __M * usage to avoid throttling. * *This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/ListEngagementInvitationsCommand.ts b/clients/client-partnercentral-selling/src/commands/ListEngagementInvitationsCommand.ts index 7d39e934039a..6f53f0ff65cd 100644 --- a/clients/client-partnercentral-selling/src/commands/ListEngagementInvitationsCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListEngagementInvitationsCommand.ts @@ -114,7 +114,7 @@ export interface ListEngagementInvitationsCommandOutput extends ListEngagementIn * usage to avoid throttling. * *This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/ListOpportunitiesCommand.ts b/clients/client-partnercentral-selling/src/commands/ListOpportunitiesCommand.ts index 5edc109595e4..7f64b2252355 100644 --- a/clients/client-partnercentral-selling/src/commands/ListOpportunitiesCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListOpportunitiesCommand.ts @@ -36,8 +36,7 @@ export interface ListOpportunitiesCommandInput extends ListOpportunitiesRequest export interface ListOpportunitiesCommandOutput extends ListOpportunitiesResponse, __MetadataBearer {} /** - *This request accepts a list of filters to use to - * retrieve a specific subset of opportunities, as well as sort options. This feature is available to partners from + *
This 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.
*
This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/RejectEngagementInvitationCommand.ts b/clients/client-partnercentral-selling/src/commands/RejectEngagementInvitationCommand.ts index 7df4d2be1b84..efda804f96c5 100644 --- a/clients/client-partnercentral-selling/src/commands/RejectEngagementInvitationCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/RejectEngagementInvitationCommand.ts @@ -32,7 +32,10 @@ export interface RejectEngagementInvitationCommandInput extends RejectEngagement export interface RejectEngagementInvitationCommandOutput extends __MetadataBearer {} /** - *Use this action to reject an EngagementInvitation that has been shared by AWS. Rejecting the engagement invitation indicates that the partner does not wish to pursue the opportunity, and all related data will be inaccessible after the rejection.
This action rejects an EngagementInvitation that AWS
+ * shared. Rejecting an invitation indicates that the partner doesn't want to
+ * pursue the opportunity, and all related data will become inaccessible
+ * thereafter.
This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/StartEngagementByAcceptingInvitationTaskCommand.ts b/clients/client-partnercentral-selling/src/commands/StartEngagementByAcceptingInvitationTaskCommand.ts index 87c11e7fb344..7a647c8e23f6 100644 --- a/clients/client-partnercentral-selling/src/commands/StartEngagementByAcceptingInvitationTaskCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/StartEngagementByAcceptingInvitationTaskCommand.ts @@ -41,7 +41,7 @@ export interface StartEngagementByAcceptingInvitationTaskCommandOutput __MetadataBearer {} /** - *This action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves several steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS Opportunity, and copying over key details for tracking. Once completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.
This action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves the following steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS opportunity, and copying details for tracking. When completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.
Suggested action: Review the - * service quotas for the specific resource, and reduce the usage or request a quota increase through support if necessary. + * Quotas for the resource, and either reduce usage or request a quota increase. *
* * @throws {@link ThrottlingException} (client fault) @@ -112,7 +112,7 @@ export interface StartEngagementByAcceptingInvitationTaskCommandOutput * usage to avoid throttling. * *This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/StartEngagementFromOpportunityTaskCommand.ts b/clients/client-partnercentral-selling/src/commands/StartEngagementFromOpportunityTaskCommand.ts index 8f5e8d4e1d6c..1c0760ff230f 100644 --- a/clients/client-partnercentral-selling/src/commands/StartEngagementFromOpportunityTaskCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/StartEngagementFromOpportunityTaskCommand.ts @@ -64,7 +64,7 @@ export interface StartEngagementFromOpportunityTaskCommandOutput * // StartTime: new Date("TIMESTAMP"), * // TaskStatus: "IN_PROGRESS" || "COMPLETE" || "FAILED", * // Message: "STRING_VALUE", - * // ReasonCode: "InvitationAccessDenied" || "EngagementAccessDenied" || "OpportunityAccessDenied" || "ResourceSnapshotJobAccessDenied" || "EngagementValidationFailed" || "OpportunitySubmissionFailed" || "EngagementInvitationConflict" || "InternalError" || "OpportunityValidationFailed" || "OpportunityConflict", + * // ReasonCode: "InvitationAccessDenied" || "EngagementAccessDenied" || "OpportunityAccessDenied" || "ResourceSnapshotJobAccessDenied" || "EngagementValidationFailed" || "OpportunitySubmissionFailed" || "EngagementInvitationConflict" || "InternalError" || "OpportunityValidationFailed" || "OpportunityConflict" || "ResourceSnapshotAccessDenied", * // OpportunityId: "STRING_VALUE", * // }; * @@ -106,7 +106,7 @@ export interface StartEngagementFromOpportunityTaskCommandOutput * Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit. * *Suggested action: Review the - * service quotas for the specific resource, and reduce the usage or request a quota increase through support if necessary. + * Quotas for the resource, and either reduce usage or request a quota increase. *
* * @throws {@link ThrottlingException} (client fault) @@ -114,7 +114,7 @@ export interface StartEngagementFromOpportunityTaskCommandOutput * usage to avoid throttling. * *This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/commands/UpdateOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/UpdateOpportunityCommand.ts index 74917a51ffaa..954110a6d123 100644 --- a/clients/client-partnercentral-selling/src/commands/UpdateOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/UpdateOpportunityCommand.ts @@ -194,7 +194,7 @@ export interface UpdateOpportunityCommandOutput extends UpdateOpportunityRespons * usage to avoid throttling. * *This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* * @throws {@link ValidationException} (client fault) diff --git a/clients/client-partnercentral-selling/src/endpoint/EndpointParameters.ts b/clients/client-partnercentral-selling/src/endpoint/EndpointParameters.ts index 574b25c2860a..44d7ceac56e5 100644 --- a/clients/client-partnercentral-selling/src/endpoint/EndpointParameters.ts +++ b/clients/client-partnercentral-selling/src/endpoint/EndpointParameters.ts @@ -5,10 +5,9 @@ import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provi * @public */ export interface ClientInputEndpointParameters { - region?: string | Provider* AWS Partner Central API for Selling Reference Guide *
- *- * Amazon Web Services (AWS) Partner Central API reference guide is designed to help - * AWS Partners programmatically integrate their Customer Relationship Management (CRM) systems with AWS Partner Central. Through the Partner Central APIs, partners can automate and streamline their interactions with AWS Partner Central, ensuring a more efficient and effective engagement in joint business activities. - *
- *- * The AWS Partner Central API service provides standard AWS API functionality. You can directly use the API Actions, or you can use an AWS SDK to access an API that's tailored to the programming language or platform that you're using. For more information about AWS application development, see Getting Started with AWS. For more information about using AWS SDKs, see AWS SDKs. - *
+ *This Amazon Web Services (AWS) Partner Central API reference is + * designed to help AWS + * Partners integrate Customer Relationship Management (CRM) + * systems with AWS Partner Central. Partners can automate interactions with + * AWS Partner Central, which helps to ensure effective engagements in joint + * business activities.
+ *The API provides standard AWS API functionality. Access it by + * either using API Actions or by using an AWS SDK that's tailored to your + * programming language or platform. For more information, see Getting Started with + * AWS and Tools to Build on AWS.
** Features offered by AWS Partner Central API *
*
- * Opportunity management: Facilitates the management of co-selling opportunities with AWS using API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.
CreateOpportunity, UpdateOpportunity,
+ * ListOpportunities, GetOpportunity, and
+ * AssignOpportunity.
*
- * AWS referral management: Facilitates receiving referrals shared by AWS using actions like ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.
ListEngagementInvitations,
+ * GetEngagementInvitation,
+ * StartEngagementByAcceptingInvitation, and
+ * RejectEngagementInvitation.
*
- * Entity association: Associate related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity and DisassociateOpportunity.
AssociateOpportunity, and
+ * DisassociateOpportunity.
*
- * View AWS opportunity details: Use the GetAWSOpportunitySummary action to retrieve real-time summaries of AWS opportunities that are linked to your opportunities.
GetAWSOpportunitySummary
+ * action.
*
- * List solutions: Provides list APIs for listing solutions partners offer using ListSolutions.
ListSolutions.
* - * Event subscription: Partners can subscribe to real-time updates on opportunities by listening to events such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected and Engagement Invitation Created using AWS EventBridge.
+ * Event subscription: + * Subscribe to real-time opportunity updates through AWS EventBridge by + * using actions such as Opportunity Created, + * Opportunity Updated, Engagement + * Invitation Accepted, Engagement Invitation + * Rejected, and Engagement Invitation + * Created. *Specifies the industry the end Customer belongs to that's associated with the Opportunity . It refers to the category or sector where the customer's business operates. This is a required field.
+ *
Specifies the industry the end Customer belongs to that's associated with the Opportunity. It refers to the category or sector where the customer's business operates. This is a required field.
*
Specifies which industry the end Customer belongs to associated with the Opportunity .
+ *
Specifies which industry the end Customer belongs to associated with the Opportunity.
* It refers to the category or sector that the customer's business operates in.
*
To submit a value outside the picklist, use @@ -539,7 +539,7 @@ export interface AccountSummary { } /** - *
Represents the contact details of the individual assigned to manage the opportunity within the partner organization. This ensures that there is a clear point of contact for the opportunity's progress and updates.
+ *Represents the contact details of the individual assigned to manage the opportunity within the partner organization. This helps to ensure that there is a point of contact for the opportunity's progress.
* @public */ export interface AssigneeContact { @@ -550,19 +550,19 @@ export interface AssigneeContact { Email: string | undefined; /** - *Specifies the first name of the assignee managing the opportunity.
+ *Specifies the first name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
* @public */ FirstName: string | undefined; /** - *Specifies the last name of the assignee managing the opportunity.
+ *Specifies the last name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
* @public */ LastName: string | undefined; /** - *Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization.
+ *Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization. Use the value PartnerAccountManager to update details of the opportunity owner.
AWS or Sandbox. The catalog determines which environment the opportunity
* is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog,
- * and Sandbox to test in a secure and isolated environment.
+ * and Sandbox for testing in secure, isolated environments.
*
* @public
*/
@@ -655,7 +655,7 @@ export class ResourceNotFoundException extends __BaseException {
* usage to avoid throttling.
*
* This error occurs when there are too many requests sent. Review the provided - * quotas and retry after the provided delay. + * Quotas and retry after the provided delay. *
* @public */ @@ -860,9 +860,9 @@ export interface AssociateOpportunityRequest { /** *
* Specifies the catalog associated with the request. This field takes a string value from a predefined list:
- * AWS or Sandbox. The catalog determines whichenvironment the opportunity
+ * AWS or Sandbox. The catalog determines which environment the opportunity
* association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog,
- * and Sandbox to test in a secure and isolated environment.
+ * and Sandbox for testing in secure, isolated environments.
*
Specifies the type of the related entity you're associating with the Specifies the entity type that you're associating with the The partner contact's title (job title or role) associated with the The partner contact's title (job title or role) associated with the Provides a list of customer contacts involved in the opportunity. These contacts may include decision-makers, influencers, and other key stakeholders within the customer's organization. Provides a list of customer contacts involved in the opportunity. These contacts may include decision makers, influencers, and other stakeholders within the customer's organization. Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS's guidance and the current stage of the opportunity. Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.
+ *
* Opportunity. This helps to categorize and properly process the association.
* Opportunity.
+ * Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
*
Suggested action: Review the - * service quotas for the specific resource, and reduce the usage or request a quota increase through support if necessary. + * Quotas for the resource, and either reduce usage or request a quota increase. *
* @public */ @@ -1520,13 +1520,13 @@ export interface StartEngagementByAcceptingInvitationTaskRequest { Catalog: string | undefined; /** - *A unique, case-sensitive identifier provided by the client to ensure the idempotency of the request. Can be a random or meaningful string, but must be unique for each request.
+ *A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.
* @public */ ClientToken?: string | undefined; /** - *Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier ensures the right engagement invitation is processed.
Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.
The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]\{13\}$.
The unique identifier of the task, used to track the task’s progress.
* @public */ TaskId?: string | undefined; @@ -1592,7 +1593,7 @@ export interface StartEngagementByAcceptingInvitationTaskResponse { StartTime?: Date | undefined; /** - *Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.
Indicates the current status of the task.
* @public */ TaskStatus?: TaskStatus | undefined; @@ -1604,7 +1605,7 @@ export interface StartEngagementByAcceptingInvitationTaskResponse { Message?: string | undefined; /** - *Indicates the reason for task failure using an enumerated code. Possible values are: ACCEPT_ENGAGEMENT_INVITATION_FAILED, GET_ENGAGEMENT_INVITATION_FAILED, CREATE_OPPORTUNITY_FAILED, CREATE_RESOURCE_VIEW_AUTOMATION_FAILED, SUBMIT_OPPORTUNITY_FAILED.
Indicates the reason for task failure using an enumerated code.
* @public */ ReasonCode?: ReasonCode | undefined; @@ -1651,18 +1652,18 @@ export const Visibility = { export type Visibility = (typeof Visibility)[keyof typeof Visibility]; /** - *Indicates the level of AWS involvement in the opportunity. This field helps track AWS's role and participation throughout the engagement, such as providing technical support, deal assistance, or sales support.
+ *Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.
* @public */ export interface AwsSubmission { /** - *Specifies the type of AWS involvement in the opportunity, such as co-selling, deal support, or technical consultation. This helps categorize the nature of AWS's participation.
+ *Specifies the type of AWS involvement in the opportunity, such as coselling, deal support, or technical consultation. This helps categorize the nature of AWS participation.
* @public */ InvolvementType: SalesInvolvementType | undefined; /** - *Determines who can view AWS's involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.
Determines who can view AWS involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.
A unique token provided by the client to ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
+ *A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
* @public */ ClientToken?: string | undefined; /** - *The unique identifier of the opportunity from which the engagement task is to be initiated. This ensures the task is applied to the correct opportunity.
+ *The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.
* @public */ Identifier: string | undefined; /** - *Indicates the level of AWS involvement in the opportunity. This field helps track AWS's role and participation throughout the engagement, such as providing technical support, deal assistance, or sales support.
+ *Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.
* @public */ AwsSubmission: AwsSubmission | undefined; @@ -1732,7 +1733,7 @@ export interface StartEngagementFromOpportunityTaskResponse { Message?: string | undefined; /** - *Indicates the reason for task failure using an enumerated code. Possible values are: ACCEPT_ENGAGEMENT_INVITATION_FAILED, GET_ENGAGEMENT_INVITATION_FAILED, CREATE_OPPORTUNITY_FAILED, CREATE_RESOURCE_VIEW_AUTOMATION_FAILED, SUBMIT_OPPORTUNITY_FAILED.
Indicates the reason for task failure using an enumerated code.
* @public */ ReasonCode?: ReasonCode | undefined; @@ -1755,14 +1756,15 @@ export interface GetEngagementInvitationRequest { Catalog: string | undefined; /** - *Specifies the unique identifier for the engagement invitation being retrieved.
+ *Specifies the unique identifier for the retrieved engagement + * invitation.
* @public */ Identifier: string | undefined; } /** - *Contains details about the customer associated with the Engagement Invitation, including key company information and industry.
+ *Contains details about the customer associated with the Engagement Invitation, including company information and industry.
* @public */ export interface EngagementCustomer { @@ -1890,7 +1892,7 @@ export interface SenderContact { */ export interface OpportunityInvitationPayload { /** - *Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are key stakeholders for the opportunity.
+ *Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.
* @public */ SenderContacts?: SenderContact[] | undefined; @@ -2025,7 +2027,8 @@ export type InvitationStatus = (typeof InvitationStatus)[keyof typeof Invitation */ export interface GetEngagementInvitationResponse { /** - *The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.
+ *The Amazon Resource Name (ARN) that identifies the engagement + * invitation.
* @public */ Arn?: string | undefined; @@ -2043,13 +2046,13 @@ export interface GetEngagementInvitationResponse { Id: string | undefined; /** - *The title of the engagement invitation, summarizing the purpose or key objectives of the opportunity shared by AWS.
+ *The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.
* @public */ EngagementTitle?: string | undefined; /** - *The current status of the engagement invitation (e.g., Accepted, Pending, or Rejected).
The current status of the engagement invitation.
* @public */ Status?: InvitationStatus | undefined; @@ -2204,7 +2207,7 @@ export interface ListEngagementInvitationsRequest { } /** - *Provides a summarized view of the Engagement Invitation, including key details like the identifier, status, and sender information. This summary helps partners track and manage AWS-originated opportunities.
+ *Provides a summarized view of the Engagement Invitation, including details like the identifier, status, and sender. This summary helps partners track and manage AWS originated opportunities.
* @public */ export interface EngagementInvitationSummary { @@ -2245,7 +2248,7 @@ export interface EngagementInvitationSummary { InvitationDate?: Date | undefined; /** - *Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will no longer be available for the partner to engage.
+ *Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner.
* @public */ ExpirationDate?: Date | undefined; @@ -2280,7 +2283,7 @@ export interface EngagementInvitationSummary { */ export interface ListEngagementInvitationsResponse { /** - *An array containing summaries of engagement invitations. Each summary includes key information such as the invitation title, invitation date, and the current status of the invitation.
+ *An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.
* @public */ EngagementInvitationSummaries?: EngagementInvitationSummary[] | undefined; @@ -2297,27 +2300,36 @@ export interface ListEngagementInvitationsResponse { */ export interface RejectEngagementInvitationRequest { /** - *Specifies the catalog related to the engagement invitation. Accepted values are AWS and Sandbox, which determine the environment in which the opportunity is managed.
This is the catalog that's associated with the engagement
+ * invitation. Acceptable values are AWS or
+ * Sandbox, and these values determine the environment in which
+ * the opportunity is managed.
Specifies the unique identifier of the EngagementInvitation to be rejected. Providing the correct identifier ensures that the intended invitation is rejected.
This is the unique identifier of the rejected
+ * EngagementInvitation. Providing the correct identifier
+ * helps to ensure that the intended invitation is rejected.
Specifies the reason for rejecting the engagement invitation. Providing a reason helps document the rationale behind the rejection and assists AWS in tracking patterns or issues. Possible values include:
+ *This describes the reason for rejecting the engagement invitation, + * which helps AWS track usage patterns. Acceptable values include the + * following:
*- * Customer problem unclear: The customer's problem is not clearly defined.
+ * Customer problem unclear: The + * customer's problem isn't understood. *- * Next steps unclear: The next steps required to proceed are not clear.
+ * Next steps unclear: The next steps + * required to proceed aren't understood. *@@ -2325,11 +2337,13 @@ export interface RejectEngagementInvitationRequest { *
- * Duplicate of Partner Referral: The opportunity is a duplicate of an existing referral.
+ * Duplicate of partner referral: The + * opportunity is a duplicate of an existing referral. *- * Other: Any other reason not covered by the specified values.
+ * Other: Any reason not covered by + * other values. *- * Qualified: Your account team engaged with the prospect/end customer to discuss viability and understand requirements. The prospect/end customer agreed that the opportunity is real, of interest, and may solve key business/technical needs. + * Qualified: Your account team engaged with the customer to discuss viability and requirements. The customer agreed that the opportunity is real, of interest, and may solve business/technical needs. *
*Legal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress.
*Lost to Competitor - Google: The opportunity was lost to Google.
+ *Lost to Competitor—Google: The opportunity was lost to Google.
*Lost to Competitor - Microsoft: The opportunity was lost to Microsoft.
+ *Lost to Competitor—Microsoft: The opportunity was lost to Microsoft.
*Lost to Competitor - SoftLayer: The opportunity was lost to SoftLayer.
+ *Lost to Competitor—SoftLayer: The opportunity was lost to SoftLayer.
*Lost to Competitor - VMWare: The opportunity was lost to VMWare.
+ *Lost to Competitor—VMWare: The opportunity was lost to VMWare.
*Lost to Competitor - Other: The opportunity was lost to a competitor not listed above.
+ *Lost to Competitor—Other: The opportunity was lost to a competitor not listed above.
*No Opportunity: There was no opportunity to pursue.
@@ -2569,8 +2583,8 @@ export interface LifeCycle { ClosedLostReason?: ClosedLostReason | undefined; /** - *Specifies the upcoming actions or tasks for the Opportunity. This field
- * is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.
+ *
Specifies the upcoming actions or tasks for the Opportunity. Use this field
+ * to communicate with Amazon Web Services about the next actions required for the Opportunity.
*
* Action Required: Issues that Amazon Web Services highlights need to be addressed.
- * Partners should use the UpdateOpportunity API action to update the opportunity, and ensure all required changes are made.
- * Only these fields are editable when the Lifecycle.ReviewStatus is Action Required:
+ * Partners should use the UpdateOpportunity API action to update the opportunity and helps to ensure that all required changes are made.
+ * Only the following fields are editable when the Lifecycle.ReviewStatus is Action Required:
*
Indicates why an opportuntiy was sent back for further details. Partners must take corrective action based on the ReviewComments.
Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.
Specifies the Opportunity's unique marketing campaign name. The Amazon Web Services
- * campaign name serves as a reference to specific marketing initiatives, promotions, or
- * activities related to the Opportunity. This field captures the identifier used to track and
- * categorize the Opportunity within Amazon Web Services's marketing campaigns. If you don't have a campaign
- * name, reach out to your Amazon Web Services point of contact to obtain one.
+ *
Specifies the Opportunity marketing campaign code. The Amazon Web Services
+ * campaign code is a reference to specific marketing initiatives, promotions, or
+ * activities. This field captures the identifier used to track and
+ * categorize the Opportunity within marketing campaigns. If you don't have a campaign
+ * code, contact your Amazon Web Services point of contact to obtain one.
*
Describes the problem the end customer has, and how the partner is helping. - * Utilize this field to provide a clear and concise narrative that outlines the specific business challenge or - * issue the customer has. + * Utilize this field to provide a concise narrative that outlines the customer's business challenge or + * issue. * Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. * Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. * Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise @@ -2990,7 +3004,7 @@ export interface Project { * Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload. *
*
- * Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse / Data Integration / ETL / Data Lake / BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing / End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration / Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps
+ * Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing/End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration/Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps
*
- * Conducted POC / Demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer. + * Conducted POC/demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer. *
*- * In evaluation / planning stage: The customer is evaluating the solution and planning potential implementation. + * In evaluation/planning stage: The customer is evaluating the solution and planning potential implementation. *
*AWS or Sandbox. The catalog determines which environment the opportunity
* is created in. Use AWS to create opportunities in the Amazon Web Services catalog,
- * and Sandbox to test in a secure and isolated environment.
+ * and Sandbox for testing in secure, isolated environments.
*
* @public
*/
@@ -3181,47 +3195,47 @@ export interface CreateOpportunityRequest {
* - * Co-Sell - 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—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. *
*- * Co-Sell - Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. + * Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. *
*- * Co-Sell - Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. + * Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. *
*- * Co-Sell - 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—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). *
*- * Co-Sell - Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. + * Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. *
*- * Co-Sell - 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—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. *
*- * Co-Sell - Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). + * Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). *
*- * Co-Sell - Support for Public Tender / RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support. + * Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support. *
*- * Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services 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. + * Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycles. This is also known as a for-visibility-only (FVO) opportunity. *
** 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. + * to track and reconcile because it's included in the outbound payload to the partner. *
*- * This field allows partners to link an opportunity to their CRM, to ensure seamless integration and accurate - * synchronization between the Partner Central API and the partner's internal systems. + * This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems. *
* @public */ @@ -3301,7 +3314,7 @@ export interface CreateOpportunityRequest { Marketing?: Marketing | undefined; /** - *Specifies details of a customer's procurement terms. Required only for partners in eligible programs.
+ *Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.
* @public */ SoftwareRevenue?: SoftwareRevenue | undefined; @@ -3314,7 +3327,7 @@ export interface CreateOpportunityRequest { * Default: None * *
- * Best practice: To ensure uniqueness and avoid collisions, we recommend you use a UUID (Universally Unique Identifier) as the ClientToken. You can use standard libraries available in most programming languages to generated this. If you use the same client token, the API throws this error: "Conflicting client token submitted for a new request body".
+ * Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: "Conflicting client token submitted for a new request body."
*
Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.
+ *Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.
* @public */ OpportunityTeam?: Contact[] | undefined; @@ -3351,9 +3364,7 @@ export interface CreateOpportunityRequest { export interface CreateOpportunityResponse { /** *
- * Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's
- * used for all subsequent actions on the opportunity, such as updates, associations, and submissions. It ensures
- * that each opportunity can be accurately tracked and managed within the system.
+ * Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity actions, such as updates, associations, and submissions. It helps to ensure that each opportunity is accurately tracked and managed.
*
* DateTime
- * when the opportunity was last modified. When the Opportunity is created, its value is equal to
- * CreatedDate.
+ * when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.
*
AWS or Sandbox. The catalog determines which environment the opportunity
* disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog,
- * and Sandbox to test in a secure and isolated environment.
+ * and Sandbox for testing in secure, isolated environments.
*
* @public
*/
@@ -3395,10 +3405,9 @@ export interface DisassociateOpportunityRequest {
/**
* The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier - * is crucial to ensure the correct opportunity is updated, especially in environments with numerous - * opportunities. + * helps to ensure that the correct opportunity is updated. *
- *Validation: Ensure that the identifier provided corresponds to an existing opportunity in the Amazon Web Services system because + *
Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because * incorrect identifiers result in an error and no changes are made. *
* @public @@ -3407,13 +3416,11 @@ export interface DisassociateOpportunityRequest { /** *The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps - * the system correctly process the disassociation request and ensures that the right connections are removed. + * the system correctly process the disassociation request to ensure that the right connections are removed. *
- *Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplace offer. Ensure that the value - * matches one of the expected entity types. + *
Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types. *
- *Validation: Provide a valid entity type to ensure successful disassociation. Invalid or incorrect entity - * types result in an error. + *
Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error. *
* @public */ @@ -3425,10 +3432,10 @@ export interface DisassociateOpportunityRequest { * through Amazon Web Services Marketplace. * *For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. - * For guidance on retrieving these ARNs, refer to - * Amazon Web Services Marketplace Catalog API . + * For guidance on retrieving these ARNs, see + * Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API. *
- *Validation: Ensure the identifier or ARN is valid and corresponds to an existing related entity. + *
Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. * An incorrect or invalid identifier results in an error. *
* @public @@ -3453,7 +3460,7 @@ export interface GetAwsOpportunitySummaryRequest { /** ** The unique identifier for the related partner opportunity. Use this field to correlate an AWS - * opportunity with its corresponding partner opportunity in your CRM system. + * opportunity with its corresponding partner opportunity. *
* @public */ @@ -3511,8 +3518,8 @@ export interface GetAwsOpportunitySummaryResponse { /** *- * 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. + * Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support. + * This field helps partners understand the role AWS plays in advancing the opportunity. *
* @public */ @@ -3538,8 +3545,8 @@ export interface GetAwsOpportunitySummaryResponse { /** *- * 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. + * Details the AWS opportunity team, including members involved. This information + * helps partners know who from AWS is engaged and what their role is. *
* @public */ @@ -3576,7 +3583,7 @@ export interface GetAwsOpportunitySummaryResponse { /** ** 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 + * industry, and other customer data. These details help partners understand the business context of the * opportunity. *
* @public @@ -3603,7 +3610,7 @@ export interface GetOpportunityRequest { * 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 Amazon Web Services catalog,
- * and Sandbox to retrieve opportunities in a secure and isolated testing environment.
+ * and Sandbox to retrieve opportunities in a secure, isolated testing environment.
*
* @public
*/
@@ -3641,10 +3648,10 @@ export interface RelatedEntityIdentifiers {
* Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.
*
*
- * If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. However, once the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.
+ * If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. But when the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.
*
- * By associating the relevant solutions with the opportunity, you can clearly communicate the offerings that are being considered or implemented to address the customer's business problem. + * By associating the relevant solutions with the opportunity, you can communicate the offerings that are being considered or implemented to address the customer's business problem. *
* @public */ @@ -3691,47 +3698,47 @@ export interface GetOpportunityResponse { *- * Co-Sell - 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—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. *
*- * Co-Sell - Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. + * Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. *
*- * Co-Sell - Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. + * Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. *
*- * Co-Sell - 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—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). *
*- * Co-Sell - Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. + * Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. *
*- * Co-Sell - 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—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. *
*- * Co-Sell - Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). + * Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). *
*- * Co-Sell - Support for Public Tender / RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support. + * Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support. *
*- * Do Not Need Support from Amazon Web Services Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services 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. + * Do Not Need Support from Amazon Web Services Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity. *
** Renewal opportunity: - * Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service. + * 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 an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer. + * 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. *
*AWS or Sandbox. The catalog determines which environment the opportunities are listed in.
* Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox
- * for to test in a secure and isolated environment.
+ * for testing in secure, isolated environments.
*
* @public
*/
@@ -3929,7 +3936,7 @@ export interface ListOpportunitiesRequest {
/**
* - * Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid overloading with too many results at once. + * Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once. *
** Default: 20 @@ -4022,7 +4029,7 @@ export interface LifeCycleSummary { *
- * Qualified: Your account team engaged with the prospect/end customer to discuss viability and understand requirements. The prospect/end customer agreed that the opportunity is real, of interest, and may solve key business/technical needs. + * Qualified: Your account team engaged with the customer to discuss viability and understand requirements. The customer agreed that the opportunity is real, of interest, and may solve business/technical needs. *
*- * Business Validation: Pricing has been proposed, Pricing was proposed, and all parties agree to the steps to close. + * Business Validation: Pricing was proposed, and all parties agree to the steps to close. *
*Indicates why an opportuntiy was sent back for further details. Partners must take corrective action based on the ReviewComments.
Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.
AWS or Sandbox. The catalog determines which environment the opportunity is updated in.
* Use AWS to update real opportunities in the production
- * environment, and Sandbox to test in a secure and isolated environment.
+ * environment, and Sandbox for testing in secure, isolated environments.
* When you use the Sandbox catalog, it allows you to simulate and validate your interactions
* with Amazon Web Services services without affecting live data or operations.
*
@@ -4371,47 +4378,47 @@ export interface UpdateOpportunityRequest {
* - * Co-Sell - 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—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. *
*- * Co-Sell - Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. + * Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. *
*- * Co-Sell - Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. + * Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. *
*- * Co-Sell - 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—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). *
*- * Co-Sell - Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. + * Cosell—Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. *
*- * Co-Sell - 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—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. *
*- * Co-Sell - Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). + * Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). *
*- * Co-Sell - Support for Public Tender / RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services. + * Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services. *
*- * Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. 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. + * Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity. *
*Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national security-related opportunities, specific validation and compliance rules may apply, impacting the opportunity's visibility and processing.
Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national-security-related opportunities, validation and compliance rules may apply, impacting the opportunity's visibility and processing.
Specifies details of the customer associated with the Opportunity .
+ *
Specifies details of the customer associated with the Opportunity.
*
Filters the solutions based on their status. This filter helps retrieve solutions with statuses such as Active, Inactive, or Pending Approval, allowing partners to manage their solution portfolios effectively.
Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.
* @public */ Status?: SolutionStatus[] | undefined; @@ -4821,6 +4828,24 @@ export const AwsOpportunityLifeCycleFilterSensitiveLog = (obj: AwsOpportunityLif ...(obj.NextSteps && { NextSteps: SENSITIVE_STRING }), }); +/** + * @internal + */ +export const ExpectedCustomerSpendFilterSensitiveLog = (obj: ExpectedCustomerSpend): any => ({ + ...obj, + ...(obj.CurrencyCode && { CurrencyCode: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const AwsOpportunityProjectFilterSensitiveLog = (obj: AwsOpportunityProject): any => ({ + ...obj, + ...(obj.ExpectedCustomerSpend && { + ExpectedCustomerSpend: obj.ExpectedCustomerSpend.map((item) => ExpectedCustomerSpendFilterSensitiveLog(item)), + }), +}); + /** * @internal */ @@ -4846,6 +4871,9 @@ export const EngagementCustomerFilterSensitiveLog = (obj: EngagementCustomer): a export const ProjectDetailsFilterSensitiveLog = (obj: ProjectDetails): any => ({ ...obj, ...(obj.BusinessProblem && { BusinessProblem: SENSITIVE_STRING }), + ...(obj.ExpectedCustomerSpend && { + ExpectedCustomerSpend: obj.ExpectedCustomerSpend.map((item) => ExpectedCustomerSpendFilterSensitiveLog(item)), + }), }); /** @@ -4942,11 +4970,30 @@ export const LifeCycleFilterSensitiveLog = (obj: LifeCycle): any => ({ */ export const ProjectFilterSensitiveLog = (obj: Project): any => ({ ...obj, + ...(obj.ExpectedCustomerSpend && { + ExpectedCustomerSpend: obj.ExpectedCustomerSpend.map((item) => ExpectedCustomerSpendFilterSensitiveLog(item)), + }), ...(obj.Title && { Title: SENSITIVE_STRING }), ...(obj.CustomerBusinessProblem && { CustomerBusinessProblem: SENSITIVE_STRING }), ...(obj.OtherSolutionDescription && { OtherSolutionDescription: SENSITIVE_STRING }), }); +/** + * @internal + */ +export const MonetaryValueFilterSensitiveLog = (obj: MonetaryValue): any => ({ + ...obj, + ...(obj.CurrencyCode && { CurrencyCode: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const SoftwareRevenueFilterSensitiveLog = (obj: SoftwareRevenue): any => ({ + ...obj, + ...(obj.Value && { Value: MonetaryValueFilterSensitiveLog(obj.Value) }), +}); + /** * @internal */ @@ -4954,6 +5001,7 @@ export const CreateOpportunityRequestFilterSensitiveLog = (obj: CreateOpportunit ...obj, ...(obj.Customer && { Customer: CustomerFilterSensitiveLog(obj.Customer) }), ...(obj.Project && { Project: ProjectFilterSensitiveLog(obj.Project) }), + ...(obj.SoftwareRevenue && { SoftwareRevenue: SoftwareRevenueFilterSensitiveLog(obj.SoftwareRevenue) }), ...(obj.LifeCycle && { LifeCycle: LifeCycleFilterSensitiveLog(obj.LifeCycle) }), ...(obj.OpportunityTeam && { OpportunityTeam: obj.OpportunityTeam.map((item) => ContactFilterSensitiveLog(item)) }), }); @@ -4968,6 +5016,7 @@ export const GetAwsOpportunitySummaryResponseFilterSensitiveLog = (obj: GetAwsOp OpportunityTeam: obj.OpportunityTeam.map((item) => AwsTeamMemberFilterSensitiveLog(item)), }), ...(obj.Customer && { Customer: AwsOpportunityCustomerFilterSensitiveLog(obj.Customer) }), + ...(obj.Project && { Project: AwsOpportunityProjectFilterSensitiveLog(obj.Project) }), }); /** @@ -4977,6 +5026,7 @@ export const GetOpportunityResponseFilterSensitiveLog = (obj: GetOpportunityResp ...obj, ...(obj.Customer && { Customer: CustomerFilterSensitiveLog(obj.Customer) }), ...(obj.Project && { Project: ProjectFilterSensitiveLog(obj.Project) }), + ...(obj.SoftwareRevenue && { SoftwareRevenue: SoftwareRevenueFilterSensitiveLog(obj.SoftwareRevenue) }), ...(obj.LifeCycle && { LifeCycle: LifeCycleFilterSensitiveLog(obj.LifeCycle) }), ...(obj.OpportunityTeam && { OpportunityTeam: obj.OpportunityTeam.map((item) => ContactFilterSensitiveLog(item)) }), }); @@ -4997,6 +5047,16 @@ export const LifeCycleSummaryFilterSensitiveLog = (obj: LifeCycleSummary): any = ...(obj.NextSteps && { NextSteps: SENSITIVE_STRING }), }); +/** + * @internal + */ +export const ProjectSummaryFilterSensitiveLog = (obj: ProjectSummary): any => ({ + ...obj, + ...(obj.ExpectedCustomerSpend && { + ExpectedCustomerSpend: obj.ExpectedCustomerSpend.map((item) => ExpectedCustomerSpendFilterSensitiveLog(item)), + }), +}); + /** * @internal */ @@ -5004,6 +5064,7 @@ export const OpportunitySummaryFilterSensitiveLog = (obj: OpportunitySummary): a ...obj, ...(obj.LifeCycle && { LifeCycle: LifeCycleSummaryFilterSensitiveLog(obj.LifeCycle) }), ...(obj.Customer && { Customer: CustomerSummaryFilterSensitiveLog(obj.Customer) }), + ...(obj.Project && { Project: ProjectSummaryFilterSensitiveLog(obj.Project) }), }); /** @@ -5023,5 +5084,6 @@ export const UpdateOpportunityRequestFilterSensitiveLog = (obj: UpdateOpportunit ...obj, ...(obj.Customer && { Customer: CustomerFilterSensitiveLog(obj.Customer) }), ...(obj.Project && { Project: ProjectFilterSensitiveLog(obj.Project) }), + ...(obj.SoftwareRevenue && { SoftwareRevenue: SoftwareRevenueFilterSensitiveLog(obj.SoftwareRevenue) }), ...(obj.LifeCycle && { LifeCycle: LifeCycleFilterSensitiveLog(obj.LifeCycle) }), }); diff --git a/codegen/sdk-codegen/aws-models/partnercentral-selling.json b/codegen/sdk-codegen/aws-models/partnercentral-selling.json index 88cccab214ef..653f8409369f 100644 --- a/codegen/sdk-codegen/aws-models/partnercentral-selling.json +++ b/codegen/sdk-codegen/aws-models/partnercentral-selling.json @@ -31,6 +31,8 @@ "aws.auth#sigv4": { "name": "partnercentral-selling" }, + "aws.endpoints#dualStackOnlyEndpoints": {}, + "aws.endpoints#standardRegionalEndpoints": {}, "aws.iam#defineConditionKeys": { "partnercentral:RelatedEntityType": { "type": "String", @@ -45,24 +47,11 @@ }, "aws.iam#supportedPrincipalTypes": ["Root", "IAMUser", "IAMRole", "FederatedUser"], "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "\n AWS Partner Central API for Selling Reference Guide\n
\n\n Amazon Web Services (AWS) Partner Central API reference guide is designed to help\n AWS Partners programmatically integrate their Customer Relationship Management (CRM) systems with AWS Partner Central. Through the Partner Central APIs, partners can automate and streamline their interactions with AWS Partner Central, ensuring a more efficient and effective engagement in joint business activities.\n
\n\n The AWS Partner Central API service provides standard AWS API functionality. You can directly use the API Actions, or you can use an AWS SDK to access an API that's tailored to the programming language or platform that you're using. For more information about AWS application development, see Getting Started with AWS. For more information about using AWS SDKs, see AWS SDKs.\n
\n\n Features offered by AWS Partner Central API\n
\n\n Opportunity management: Facilitates the management of co-selling opportunities with AWS using API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.
\n AWS referral management: Facilitates receiving referrals shared by AWS using actions like ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.
\n Entity association: Associate related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity and DisassociateOpportunity.
\n View AWS opportunity details: Use the GetAWSOpportunitySummary action to retrieve real-time summaries of AWS opportunities that are linked to your opportunities.
\n List solutions: Provides list APIs for listing solutions partners offer using ListSolutions.
\n Event subscription: Partners can subscribe to real-time updates on opportunities by listening to events such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected and Engagement Invitation Created using AWS EventBridge.
\n\n AWS Partner Central API for Selling Reference Guide\n
\nThis Amazon Web Services (AWS) Partner Central API reference is\n designed to help AWS\n Partners integrate Customer Relationship Management (CRM)\n systems with AWS Partner Central. Partners can automate interactions with\n AWS Partner Central, which helps to ensure effective engagements in joint\n business activities.
\nThe API provides standard AWS API functionality. Access it by\n either using API Actions or by using an AWS SDK that's tailored to your\n programming language or platform. For more information, see Getting Started with\n AWS and Tools to Build on AWS.
\n\n Features offered by AWS Partner Central API\n
\n\n Opportunity management:\n Manages coselling opportunities through API actions such as\n CreateOpportunity, UpdateOpportunity,\n ListOpportunities, GetOpportunity, and\n AssignOpportunity.
\n AWS referral management:\n Manages referrals shared by AWS using actions such as\n ListEngagementInvitations,\n GetEngagementInvitation,\n StartEngagementByAcceptingInvitation, and\n RejectEngagementInvitation.
\n Entity association:\n Associates related entities such as AWS Products,\n Partner Solutions, and AWS\n Marketplace Private Offers with opportunities using the\n actions AssociateOpportunity, and\n DisassociateOpportunity.
\n View AWS opportunity\n details: Retrieves real-time summaries of AWS\n opportunities using the GetAWSOpportunitySummary\n action.
\n List solutions: Provides\n list APIs for listing partner offers using\n ListSolutions.
\n Event subscription:\n Subscribe to real-time opportunity updates through AWS EventBridge by\n using actions such as Opportunity Created,\n Opportunity Updated, Engagement\n Invitation Accepted, Engagement Invitation\n Rejected, and Engagement Invitation\n Created.
\nSpecifies the industry the end Customer belongs to that's associated with the Opportunity . It refers to the category or sector where the customer's business operates. This is a required field.\n
Specifies the industry the end Customer belongs to that's associated with the Opportunity. It refers to the category or sector where the customer's business operates. This is a required field.\n
Specifies which industry the end Customer belongs to associated with the Opportunity .\n It refers to the category or sector that the customer's business operates in.\n
To submit a value outside the picklist, use\n Other.\n
Conditionally mandatory if Other is selected for Industry Vertical in LOVs.\n
Specifies which industry the end Customer belongs to associated with the Opportunity.\n It refers to the category or sector that the customer's business operates in.\n
To submit a value outside the picklist, use\n Other.\n
Conditionally mandatory if Other is selected for Industry Vertical in LOVs.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog,\n and Sandbox to test in a secure and isolated environment.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog,\n and Sandbox for testing in secure, isolated environments.\n
Specifies the first name of the assignee managing the opportunity.
", + "smithy.api#documentation": "Specifies the first name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
", "smithy.api#length": { "max": 80 }, @@ -1047,7 +723,7 @@ "LastName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { - "smithy.api#documentation": "Specifies the last name of the assignee managing the opportunity.
", + "smithy.api#documentation": "Specifies the last name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
", "smithy.api#length": { "max": 80 }, @@ -1057,13 +733,13 @@ "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#JobTitle", "traits": { - "smithy.api#documentation": "Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization.
", + "smithy.api#documentation": "Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization. Use the value PartnerAccountManager to update details of the opportunity owner.
Represents the contact details of the individual assigned to manage the opportunity within the partner organization. This ensures that there is a clear point of contact for the opportunity's progress and updates.
" + "smithy.api#documentation": "Represents the contact details of the individual assigned to manage the opportunity within the partner organization. This helps to ensure that there is a point of contact for the opportunity's progress.
" } }, "com.amazonaws.partnercentralselling#AssociateOpportunity": { @@ -1096,7 +772,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to associate Opportunities on AWS Partner Central with other entities" }, - "smithy.api#documentation": "\n Enables you to create a formal association between an Opportunity and various\n related entities, enriching the context and details of the opportunity for better collaboration and\n decision-making. You can associate an opportunity with the following types of entities:\n
\n Partner Solution:\n A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address specific business challenges or achieve particular goals using Amazon Web Services services.\n
\n\n Amazon Web Services Product:\n Amazon Web Services offers a wide range of products and services designed to provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, refer to Amazon Web Services products.\n
\n\n Amazon Web Services Marketplace private offer:\n 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, refer to Private offers in Amazon Web Services Marketplace.\n
\nTo obtain identifiers for these entities, use the following methods:
\nSolution: Use the ListSolutions operation.
\n AWS products: For the latest list of Amazon Web Services products, refer to\n the Amazon Web Services products list.
\n\n Amazon Web Services Marketplace private offer: Use the AWS Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request to the ListEntities API returns the details of the private offers available to you. For more information, refer to ListEntities.\n
\n Enables you to create a formal association between an Opportunity and various\n related entities, enriching the context and details of the opportunity for better collaboration and\n decision making. You can associate an opportunity with the following entity types:\n
\n Partner Solution:\n A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services.\n
\n\n Amazon Web Services Products:\n 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.\n
\n\n Amazon Web Services Marketplace private offer:\n 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.\n
\nTo obtain identifiers for these entities, use the following methods:
\nSolution: Use the ListSolutions operation.
\n AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products.\n
\n\n 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.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines whichenvironment the opportunity\n association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog,\n and Sandbox to test in a secure and isolated environment.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog,\n and Sandbox for testing in secure, isolated environments.\n
Specifies the type of the related entity you're associating with the \n Opportunity. This helps to categorize and properly process the association.\n
Specifies the entity type that you're associating with the \n Opportunity. This helps to categorize and properly process the association.\n
Provides a list of customer contacts involved in the opportunity. These contacts may include decision-makers, influencers, and other key stakeholders within the customer's organization.
" + "smithy.api#documentation": "Provides a list of customer contacts involved in the opportunity. These contacts may include decision makers, influencers, and other stakeholders within the customer's organization.
" } } }, @@ -1580,7 +1256,7 @@ "NextSteps": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { - "smithy.api#documentation": "Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS's guidance and the current stage of the opportunity.
", + "smithy.api#documentation": "Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.
", "smithy.api#length": { "max": 255 } @@ -1804,19 +1480,19 @@ "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { - "smithy.api#documentation": "Specifies the type of AWS involvement in the opportunity, such as co-selling, deal support, or technical consultation. This helps categorize the nature of AWS's participation.
", + "smithy.api#documentation": "Specifies the type of AWS involvement in the opportunity, such as coselling, deal support, or technical consultation. This helps categorize the nature of AWS participation.
", "smithy.api#required": {} } }, "Visibility": { "target": "com.amazonaws.partnercentralselling#Visibility", "traits": { - "smithy.api#documentation": "Determines who can view AWS's involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.
Determines who can view AWS involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.
Indicates the level of AWS involvement in the opportunity. This field helps track AWS's role and participation throughout the engagement, such as providing technical support, deal assistance, or sales support.
" + "smithy.api#documentation": "Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.
" } }, "com.amazonaws.partnercentralselling#AwsTeamMember": { @@ -1952,6 +1628,12 @@ "target": "com.amazonaws.partnercentralselling#Channel" } }, + "com.amazonaws.partnercentralselling#ClientToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[!-~]{1,64}$" + } + }, "com.amazonaws.partnercentralselling#ClosedLostReason": { "type": "enum", "members": { @@ -2206,7 +1888,7 @@ "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#JobTitle", "traits": { - "smithy.api#documentation": "The partner contact's title (job title or role) associated with the Opportunity.\n
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.\n
\n Creates an Opportunity record in Partner Central. Use this operation to create\n a potential business opportunity intended to be submitted to Amazon Web Services. Creating an opportunity sets its Lifecycle.ReviewStatus to\n Pending Submission.\n
\n To fully submit an opportunity, follow these steps:\n
\nTo create the opportunity, use CreateOpportunity.
To associate a solution with the opportunity, use AssociateOpportunity.
To submit the opportunity, use SubmitOpportunity.
\n After submission, you can't edit the opportunity until the review is complete. However, opportunities in the\n Pending Submission state still need all details completed. You can update\n the opportunity while it's in the Pending Submission state.\n
\n There's a set of mandatory fields required to create opportunities, but consider providing optional fields to\n enrich the opportunity record.\n
", + "smithy.api#documentation": "\n Creates an Opportunity record in Partner Central. Use this operation to create\n a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to\n Pending Submission.\n
\n To submit an opportunity, follow these steps:\n
\nTo create the opportunity, use CreateOpportunity.
To associate a solution with the opportunity, use AssociateOpportunity.
To submit the opportunity, use StartEngagementFromOpportunityTask.
\n After submission, you can't edit the opportunity until the review is complete. But opportunities in the\n Pending Submission state must have complete details. You can update\n the opportunity while it's in the Pending Submission state.\n
\n There's a set of mandatory fields to create opportunities, but consider providing optional fields to\n enrich the opportunity record.\n
", "smithy.api#http": { "method": "POST", "uri": "/CreateOpportunity", @@ -3770,14 +3452,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n is created in. Use AWS to create opportunities in the Amazon Web Services catalog,\n and Sandbox to test in a secure and isolated environment.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n is created in. Use AWS to create opportunities in the Amazon Web Services catalog,\n and Sandbox for testing in secure, isolated environments.\n
\n Identifies the type of support the partner needs from Amazon Web Services.\n
\n\n Valid values:\n
\n\n Co-Sell - 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.\n
\n\n Co-Sell - Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.\n
\n\n Co-Sell - Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.\n
\n\n Co-Sell - 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).\n
\n\n Co-Sell - Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.\n
\n\n Co-Sell - 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.\n
\n\n Co-Sell - Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).\n
\n\n Co-Sell - Support for Public Tender / RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.\n
\n\n Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services 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.\n
\n\n Identifies the type of support the partner needs from Amazon Web Services.\n
\n\n Valid values:\n
\n\n 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.\n
\n\n Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.\n
\n\n Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.\n
\n\n 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).\n
\n\n Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.\n
\n\n 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.\n
\n\n Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).\n
\n\n Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.\n
\n\n Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycles. This is also known as a for-visibility-only (FVO) opportunity.\n
\n\n Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential\n to track and reconcile because it's included in the outbound payload sent back to the partner.\n
\n\n This field allows partners to link an opportunity to their CRM, to ensure seamless integration and accurate\n synchronization between the Partner Central API and the partner's internal systems.\n
", + "smithy.api#documentation": "\n Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential\n to track and reconcile because it's included in the outbound payload to the partner.\n
\n\n This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.\n
", "smithy.api#length": { "max": 64 } @@ -3822,13 +3504,13 @@ "SoftwareRevenue": { "target": "com.amazonaws.partnercentralselling#SoftwareRevenue", "traits": { - "smithy.api#documentation": "Specifies details of a customer's procurement terms. Required only for partners in eligible programs.
" + "smithy.api#documentation": "Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.
" } }, "ClientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.\n
\n\n Default: None\n
\n\n Best practice: To ensure uniqueness and avoid collisions, we recommend you use a UUID (Universally Unique Identifier) as the ClientToken. You can use standard libraries available in most programming languages to generated this. If you use the same client token, the API throws this error: \"Conflicting client token submitted for a new request body\".\n
\n Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.\n
\n\n Default: None\n
\n\n Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: \"Conflicting client token submitted for a new request body.\"\n
Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.
" + "smithy.api#documentation": "Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.
" } } }, @@ -3865,7 +3547,7 @@ "Id": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "\n Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's\n used for all subsequent actions on the opportunity, such as updates, associations, and submissions. It ensures\n that each opportunity can be accurately tracked and managed within the system.\n
\n Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity actions, such as updates, associations, and submissions. It helps to ensure that each opportunity is accurately tracked and managed.\n
\n DateTime\n when the opportunity was last modified. When the Opportunity is created, its value is equal to\n CreatedDate.\n
\n DateTime\n when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.\n
\n 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.\n This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage\n associations as business needs change.\n
\n Use this operation to update the associations of an Opportunity due to changes in the related entities,\n or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track\n and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the\n one to be removed, especially if it's the last remaining related entity that's required.\n
\n 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.\n This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage\n associations as business needs change.\n
\n Use this operation to update the associations of an Opportunity due to changes in the related entities,\n or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track\n and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the\n one to be removed, especially if it's the last remaining entity that's required.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog,\n and Sandbox to test in a secure and isolated environment.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog,\n and Sandbox for testing in secure, isolated environments.\n
The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier\n is crucial to ensure the correct opportunity is updated, especially in environments with numerous\n opportunities.\n
\nValidation: Ensure that the identifier provided corresponds to an existing opportunity in the Amazon Web Services system because\n incorrect identifiers result in an error and no changes are made.\n
", + "smithy.api#documentation": "The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier\n helps to ensure that the correct opportunity is updated.\n
\nValidation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because\n incorrect identifiers result in an error and no changes are made.\n
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -5057,14 +4742,14 @@ "RelatedEntityType": { "target": "com.amazonaws.partnercentralselling#RelatedEntityType", "traits": { - "smithy.api#documentation": "The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps\n the system correctly process the disassociation request and ensures that the right connections are removed.\n
\nExamples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplace offer. Ensure that the value\n matches one of the expected entity types.\n
\nValidation: Provide a valid entity type to ensure successful disassociation. Invalid or incorrect entity\n types result in an error.\n
", + "smithy.api#documentation": "The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps\n the system correctly process the disassociation request to ensure that the right connections are removed.\n
\nExamples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.\n
\nValidation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.\n
", "smithy.api#required": {} } }, "RelatedEntityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The related entity's identifier that you want to disassociate from the opportunity. Depending on the\n type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed\n through Amazon Web Services Marketplace.\n
\nFor Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs.\n For guidance on retrieving these ARNs, refer to \n Amazon Web Services Marketplace Catalog API .\n
\nValidation: Ensure the identifier or ARN is valid and corresponds to an existing related entity.\n An incorrect or invalid identifier results in an error.\n
", + "smithy.api#documentation": "The related entity's identifier that you want to disassociate from the opportunity. Depending on the\n type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed\n through Amazon Web Services Marketplace.\n
\nFor Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs.\n For guidance on retrieving these ARNs, see \n Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.\n
\nValidation: Ensure the identifier or ARN is valid and corresponds to an existing entity.\n An incorrect or invalid identifier results in an error.\n
", "smithy.api#length": { "min": 1, "max": 255 @@ -5153,7 +4838,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains details about the customer associated with the Engagement Invitation, including key company information and industry.
" + "smithy.api#documentation": "Contains details about the customer associated with the Engagement Invitation, including company information and industry.
" } }, "com.amazonaws.partnercentralselling#EngagementCustomerBusinessProblem": { @@ -5305,7 +4990,7 @@ "ExpirationDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will no longer be available for the partner to engage.
" + "smithy.api#documentation": "Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner.
" } }, "SenderAwsAccountId": { @@ -5338,7 +5023,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides a summarized view of the Engagement Invitation, including key details like the identifier, status, and sender information. This summary helps partners track and manage AWS-originated opportunities.
" + "smithy.api#documentation": "Provides a summarized view of the Engagement Invitation, including details like the identifier, status, and sender. This summary helps partners track and manage AWS originated opportunities.
" } }, "com.amazonaws.partnercentralselling#EngagementInvitationsPayloadType": { @@ -5386,7 +5071,6 @@ "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
", - "smithy.api#pattern": "^(0|([1-9][0-9]{0,30}))(\\.[0-9]{0,2})?$", "smithy.api#required": {} } }, @@ -5508,7 +5192,7 @@ "RelatedOpportunityIdentifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "\n The unique identifier for the related partner opportunity. Use this field to correlate an AWS\n opportunity with its corresponding partner opportunity in your CRM system.\n
", + "smithy.api#documentation": "\n The unique identifier for the related partner opportunity. Use this field to correlate an AWS\n opportunity with its corresponding partner opportunity.\n
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -5543,7 +5227,7 @@ "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { - "smithy.api#documentation": "\n Specifies the type of involvement AWS has in the opportunity, such as direct co-sell or advisory support.\n This field helps partners understand the role AWS will play in advancing the opportunity.\n
" + "smithy.api#documentation": "\n Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support.\n This field helps partners understand the role AWS plays in advancing the opportunity.\n
" } }, "Visibility": { @@ -5561,7 +5245,7 @@ "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityTeamMembersList", "traits": { - "smithy.api#documentation": "\n Details the AWS Opportunity team, including key members involved in the opportunity. This information\n helps partners know who from AWS is engaged and their roles in the opportunity.\n
" + "smithy.api#documentation": "\n Details the AWS opportunity team, including members involved. This information\n helps partners know who from AWS is engaged and what their role is.\n
" } }, "Insights": { @@ -5585,7 +5269,7 @@ "Customer": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityCustomer", "traits": { - "smithy.api#documentation": "\n Provides details about the customer associated with the AWS Opportunity, including account information,\n industry, and other key customer data. These details help partners understand the business context of the\n opportunity.\n
" + "smithy.api#documentation": "\n Provides details about the customer associated with the AWS Opportunity, including account information,\n industry, and other customer data. These details help partners understand the business context of the\n opportunity.\n
" } }, "Project": { @@ -5629,7 +5313,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to retrieve details of Engagement Invitations on AWS Partner Central" }, - "smithy.api#documentation": "Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes key aspects such as the customer, project details, and lifecycle information related to the engagement.
", + "smithy.api#documentation": "Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.
Specifies the unique identifier for the engagement invitation being retrieved.
", + "smithy.api#documentation": "Specifies the unique identifier for the retrieved engagement\n invitation.
", "smithy.api#required": {} } } @@ -5666,7 +5350,7 @@ "Arn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the engagement\n invitation.
" } }, "PayloadType": { @@ -5685,13 +5369,13 @@ "EngagementTitle": { "target": "com.amazonaws.partnercentralselling#EngagementTitle", "traits": { - "smithy.api#documentation": "The title of the engagement invitation, summarizing the purpose or key objectives of the opportunity shared by AWS.
" + "smithy.api#documentation": "The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.
" } }, "Status": { "target": "com.amazonaws.partnercentralselling#InvitationStatus", "traits": { - "smithy.api#documentation": "The current status of the engagement invitation (e.g., Accepted, Pending, or Rejected).
The current status of the engagement invitation.
" } }, "InvitationDate": { @@ -5796,7 +5480,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog,\n and Sandbox to retrieve opportunities in a secure and isolated testing environment.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog,\n and Sandbox to retrieve opportunities in a secure, isolated testing environment.\n
\n Identifies the type of support the partner needs from Amazon Web Services.\n
\n\n Valid values:\n
\n\n Co-Sell - 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.\n
\n\n Co-Sell - Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.\n
\n\n Co-Sell - Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.\n
\n\n Co-Sell - 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).\n
\n\n Co-Sell - Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.\n
\n\n Co-Sell - 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.\n
\n\n Co-Sell - Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).\n
\n\n Co-Sell - Support for Public Tender / RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.\n
\n\n Do Not Need Support from Amazon Web Services Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services 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.\n
\n\n Identifies the type of support the partner needs from Amazon Web Services.\n
\n\n Valid values:\n
\n\n 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.\n
\n\n Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.\n
\n\n Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.\n
\n\n 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).\n
\n\n Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.\n
\n\n 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.\n
\n\n Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).\n
\n\n Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.\n
\n\n Do Not Need Support from Amazon Web Services Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.\n
\n\n Specifies the opportunity type as renewal, new, or expansion.\n
\n\n Opportunity types:\n
\n\n New opportunity:\n Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.\n
\n\n Renewal opportunity:\n Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.\n
\n\n Expansion opportunity:\n 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.\n
\n\n Specifies the opportunity type as renewal, new, or expansion.\n
\n\n Opportunity types:\n
\n\n New opportunity:\n Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.\n
\n\n Renewal opportunity:\n Represents an opportunity to renew an existing contract or subscription with a current customer, which helps to ensure service continuity.\n
\n\n Expansion opportunity:\n 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.\n
\n\n Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.\n
A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.
\n The descriptions of each sales stage are:\n
\n\n Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).\n
\n\n Qualified: Your account team engaged with the prospect/end customer to discuss viability and understand requirements. The prospect/end customer agreed that the opportunity is real, of interest, and may solve key business/technical needs.\n
\n\n Technical Validation: All parties understand the implementation plan.\n
\n\n Business Validation: Pricing was proposed, and all parties agree to the steps to close.\n
\n\n Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.\n
\n\n Launched: The workload is complete, and Amazon Web Services has started billing.\n
\n\n Closed Lost: The opportunity is lost, and there are no steps to move forward.\n
\n\n Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.\n
A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.
\n The descriptions of each sales stage are:\n
\n\n Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).\n
\n\n Qualified: Your account team engaged with the customer to discuss viability and requirements. The customer agreed that the opportunity is real, of interest, and may solve business/technical needs.\n
\n\n Technical Validation: All parties understand the implementation plan.\n
\n\n Business Validation: Pricing was proposed, and all parties agree to the steps to close.\n
\n\n Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.\n
\n\n Launched: The workload is complete, and Amazon Web Services has started billing.\n
\n\n Closed Lost: The opportunity is lost, and there are no steps to move forward.\n
\n\n Specifies the reason code when an opportunity is marked as Closed Lost. When you select an\n appropriate reason code, you communicate the context for closing the Opportunity,\n and aid in accurate reports and analysis of opportunity outcomes. The possible values are:\n
Customer Deficiency: The customer lacked necessary resources or capabilities.
\nDelay/Cancellation of Project: The project was delayed or canceled.
\nLegal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress.
\nLost to Competitor - Google: The opportunity was lost to Google.
\nLost to Competitor - Microsoft: The opportunity was lost to Microsoft.
\nLost to Competitor - SoftLayer: The opportunity was lost to SoftLayer.
\nLost to Competitor - VMWare: The opportunity was lost to VMWare.
\nLost to Competitor - Other: The opportunity was lost to a competitor not listed above.
\nNo Opportunity: There was no opportunity to pursue.
\nOn Premises Deployment: The customer chose an on-premises solution.
\nPartner Gap: The partner lacked necessary resources or capabilities.
\nPrice: The price was not competitive or acceptable to the customer.
\nSecurity/Compliance: Security or compliance issues prevented progress.
\nTechnical Limitations: Technical limitations prevented progress.
\nCustomer Experience: Issues related to the customer's experience impacted the decision.
\nOther: Any reason not covered by the other values.
\nPeople/Relationship/Governance: Issues related to people, relationships, or governance.
\nProduct/Technology: Issues related to the product or technology.
\nFinancial/Commercial: Financial or commercial issues impacted the decision.
\n\n Specifies the reason code when an opportunity is marked as Closed Lost. When you select an\n appropriate reason code, you communicate the context for closing the Opportunity,\n and aid in accurate reports and analysis of opportunity outcomes. The possible values are:\n
Customer Deficiency: The customer lacked necessary resources or capabilities.
\nDelay/Cancellation of Project: The project was delayed or canceled.
\nLegal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress.
\nLost to Competitor—Google: The opportunity was lost to Google.
\nLost to Competitor—Microsoft: The opportunity was lost to Microsoft.
\nLost to Competitor—SoftLayer: The opportunity was lost to SoftLayer.
\nLost to Competitor—VMWare: The opportunity was lost to VMWare.
\nLost to Competitor—Other: The opportunity was lost to a competitor not listed above.
\nNo Opportunity: There was no opportunity to pursue.
\nOn Premises Deployment: The customer chose an on-premises solution.
\nPartner Gap: The partner lacked necessary resources or capabilities.
\nPrice: The price was not competitive or acceptable to the customer.
\nSecurity/Compliance: Security or compliance issues prevented progress.
\nTechnical Limitations: Technical limitations prevented progress.
\nCustomer Experience: Issues related to the customer's experience impacted the decision.
\nOther: Any reason not covered by the other values.
\nPeople/Relationship/Governance: Issues related to people, relationships, or governance.
\nProduct/Technology: Issues related to the product or technology.
\nFinancial/Commercial: Financial or commercial issues impacted the decision.
\nSpecifies the upcoming actions or tasks for the Opportunity. This field\n is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.\n
Specifies the upcoming actions or tasks for the Opportunity. Use this field\n to communicate with Amazon Web Services about the next actions required for the Opportunity.\n
\n Indicates the review status of an opportunity referred by a partner. This field is read-only\n and only applicable for partner referrals. The possible values are:\n
\n\n Pending Submission: Not submitted for validation (editable).\n
\n\n Submitted: Submitted for validation, and Amazon Web Services hasn't reviewed it (read-only).\n
\n\n In Review: Amazon Web Services is validating (read-only).\n
\n\n Action Required: Issues that Amazon Web Services highlights need to be addressed.\n Partners should use the UpdateOpportunity API action to update the opportunity, and ensure all required changes are made.\n Only these fields are editable when the Lifecycle.ReviewStatus is Action Required:\n
Customer.Account.Address.City
\nCustomer.Account.Address.CountryCode
\nCustomer.Account.Address.PostalCode
\nCustomer.Account.Address.StateOrRegion
\nCustomer.Account.Address.StreetAddress
\nCustomer.Account.WebsiteUrl
\nLifeCycle.TargetCloseDate
\nProject.ExpectedMonthlyAWSRevenue.Amount
\nProject.ExpectedMonthlyAWSRevenue.CurrencyCode
\nProject.CustomerBusinessProblem
\nPartnerOpportunityIdentifier
\n\n After updates, the opportunity re-enters the validation phase. This process repeats until all issues are resolved, and the opportunity's Lifecycle.ReviewStatus is set to Approved or Rejected.\n
\n Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).\n
\n\n Rejected: Disqualified (read-only).\n
\n\n Indicates the review status of an opportunity referred by a partner. This field is read-only\n and only applicable for partner referrals. The possible values are:\n
\n\n Pending Submission: Not submitted for validation (editable).\n
\n\n Submitted: Submitted for validation, and Amazon Web Services hasn't reviewed it (read-only).\n
\n\n In Review: Amazon Web Services is validating (read-only).\n
\n\n Action Required: Issues that Amazon Web Services highlights need to be addressed.\n Partners should use the UpdateOpportunity API action to update the opportunity and helps to ensure that all required changes are made.\n Only the following fields are editable when the Lifecycle.ReviewStatus is Action Required:\n
Customer.Account.Address.City
\nCustomer.Account.Address.CountryCode
\nCustomer.Account.Address.PostalCode
\nCustomer.Account.Address.StateOrRegion
\nCustomer.Account.Address.StreetAddress
\nCustomer.Account.WebsiteUrl
\nLifeCycle.TargetCloseDate
\nProject.ExpectedMonthlyAWSRevenue.Amount
\nProject.ExpectedMonthlyAWSRevenue.CurrencyCode
\nProject.CustomerBusinessProblem
\nPartnerOpportunityIdentifier
\n\n After updates, the opportunity re-enters the validation phase. This process repeats until all issues are resolved, and the opportunity's Lifecycle.ReviewStatus is set to Approved or Rejected.\n
\n Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).\n
\n\n Rejected: Disqualified (read-only).\n
\nIndicates why an opportuntiy was sent back for further details. Partners must take corrective action based on the ReviewComments.
Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.
\n Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.\n
A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.
\n The descriptions of each sales stage are:\n
\n\n Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).\n
\n\n Qualified: Your account team engaged with the prospect/end customer to discuss viability and understand requirements. The prospect/end customer agreed that the opportunity is real, of interest, and may solve key business/technical needs.\n
\n\n Technical Validation: All parties understand the implementation plan.\n
\n\n Business Validation: Pricing has been proposed, Pricing was proposed, and all parties agree to the steps to close.\n
\n\n Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.\n
\n\n Launched: The workload is complete, and Amazon Web Services has started billing.\n
\n\n Closed Lost: The opportunity is lost, and there are no steps to move forward.\n
\n\n Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.\n
A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.
\n The descriptions of each sales stage are:\n
\n\n Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).\n
\n\n Qualified: Your account team engaged with the customer to discuss viability and understand requirements. The customer agreed that the opportunity is real, of interest, and may solve business/technical needs.\n
\n\n Technical Validation: All parties understand the implementation plan.\n
\n\n Business Validation: Pricing was proposed, and all parties agree to the steps to close.\n
\n\n Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.\n
\n\n Launched: The workload is complete, and Amazon Web Services has started billing.\n
\n\n Closed Lost: The opportunity is lost, and there are no steps to move forward.\n
\nIndicates why an opportuntiy was sent back for further details. Partners must take corrective action based on the ReviewComments.
Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.
An array containing summaries of engagement invitations. Each summary includes key information such as the invitation title, invitation date, and the current status of the invitation.
" + "smithy.api#documentation": "An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.
" } }, "NextToken": { @@ -6453,7 +6137,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to list Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "This request accepts a list of filters to use to\n retrieve a specific subset of opportunities, as well as sort options. This feature is available to partners from\n Partner Central\n using the ListOpportunities API action.\n
To synchronize your system with Amazon Web Services, only list the opportunities that were\n newly created or updated.\n We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default\n event bus, you can also use the ListOpportunities action.\n
We recommend the following approach:
\nFind the latest LastModifiedDate that you stored, and only use the values that came\n from Amazon Web Services. Don’t use values generated by your system.\n
When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.\n
Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.\n
This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from\n Partner Central\n using the ListOpportunities API action.\n
To synchronize your system with Amazon Web Services, only list the opportunities that were\n newly created or updated.\n We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default\n event bus, you can also use the ListOpportunities action.\n
We recommend the following approach:
\nFind the latest LastModifiedDate that you stored, and only use the values that came\n from Amazon Web Services. Don’t use values generated by your system.\n
When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.\n
Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunities are listed in.\n Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox\n for to test in a secure and isolated environment.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunities are listed in.\n Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox\n for testing in secure, isolated environments.\n
\n Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid overloading with too many results at once.\n
\n\n Default: 20\n
" + "smithy.api#documentation": "\n Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.\n
\n\n Default: 20\n
" } }, "NextToken": { @@ -6650,7 +6334,7 @@ "Status": { "target": "com.amazonaws.partnercentralselling#FilterStatus", "traits": { - "smithy.api#documentation": "Filters the solutions based on their status. This filter helps retrieve solutions with statuses such as Active, Inactive, or Pending Approval, allowing partners to manage their solution portfolios effectively.
Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.
", "smithy.api#length": { "max": 10 } @@ -6706,7 +6390,7 @@ "CampaignName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Specifies the Opportunity's unique marketing campaign name. The Amazon Web Services\n campaign name serves as a reference to specific marketing initiatives, promotions, or\n activities related to the Opportunity. This field captures the identifier used to track and\n categorize the Opportunity within Amazon Web Services's marketing campaigns. If you don't have a campaign\n name, reach out to your Amazon Web Services point of contact to obtain one.\n
Specifies the Opportunity marketing campaign code. The Amazon Web Services\n campaign code is a reference to specific marketing initiatives, promotions, or\n activities. This field captures the identifier used to track and\n categorize the Opportunity within marketing campaigns. If you don't have a campaign\n code, contact your Amazon Web Services point of contact to obtain one.\n
Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are key stakeholders for the opportunity.
" + "smithy.api#documentation": "Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.
" } }, "ReceiverResponsibilities": { @@ -7299,7 +6983,7 @@ "CustomerBusinessProblem": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { - "smithy.api#documentation": "Describes the problem the end customer has, and how the partner is helping.\n Utilize this field to provide a clear and concise narrative that outlines the specific business challenge or\n issue the customer has.\n Elaborate on how the partner's solution or offerings align to resolve the customer's business problem.\n Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue.\n Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise\n language and precise descriptions to convey the context and significance of the Opportunity.\n The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic\n fit of the partner's solution.\n
Describes the problem the end customer has, and how the partner is helping.\n Utilize this field to provide a concise narrative that outlines the customer's business challenge or\n issue.\n Elaborate on how the partner's solution or offerings align to resolve the customer's business problem.\n Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue.\n Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise\n language and precise descriptions to convey the context and significance of the Opportunity.\n The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic\n fit of the partner's solution.\n
\n Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.\n
\n\n Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse / Data Integration / ETL / Data Lake / BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing / End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration / Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps\n
\n Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.\n
\n\n Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing/End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration/Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps\n
\n Specifies the Opportunity's sales activities conducted with the end customer.\n These activities help drive Amazon Web Services assignment priority.\n
\n Valid values:\n
\n\n Initialized discussions with customer: Initial conversations with the customer to understand their needs and introduce your solution.\n
\n\n Customer has shown interest in solution: After initial discussions, the customer is interested in your solution.\n
\n\n Conducted POC / Demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer.\n
\n\n In evaluation / planning stage: The customer is evaluating the solution and planning potential implementation.\n
\n\n Agreed on solution to Business Problem: Both parties agree on how the solution addresses the customer's business problem.\n
\n\n Completed Action Plan: A detailed action plan is complete and outlines the steps for implementation.\n
\n\n Finalized Deployment Need: Both parties agree with and finalized the deployment needs.\n
\n\n SOW Signed: Both parties signed a statement of work (SOW), and formalize the agreement and detail the project scope and deliverables.\n
\n\n Specifies the Opportunity's sales activities conducted with the end customer.\n These activities help drive Amazon Web Services assignment priority.\n
\n Valid values:\n
\n\n Initialized discussions with customer: Initial conversations with the customer to understand their needs and introduce your solution.\n
\n\n Customer has shown interest in solution: After initial discussions, the customer is interested in your solution.\n
\n\n Conducted POC/demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer.\n
\n\n In evaluation/planning stage: The customer is evaluating the solution and planning potential implementation.\n
\n\n Agreed on solution to Business Problem: Both parties agree on how the solution addresses the customer's business problem.\n
\n\n Completed Action Plan: A detailed action plan is complete and outlines the steps for implementation.\n
\n\n Finalized Deployment Need: Both parties agree with and finalized the deployment needs.\n
\n\n SOW Signed: Both parties signed a statement of work (SOW), and formalize the agreement and detail the project scope and deliverables.\n
\nUse this action to reject an EngagementInvitation that has been shared by AWS. Rejecting the engagement invitation indicates that the partner does not wish to pursue the opportunity, and all related data will be inaccessible after the rejection.
This action rejects an EngagementInvitation that AWS\n shared. Rejecting an invitation indicates that the partner doesn't want to\n pursue the opportunity, and all related data will become inaccessible\n thereafter.
Specifies the catalog related to the engagement invitation. Accepted values are AWS and Sandbox, which determine the environment in which the opportunity is managed.
This is the catalog that's associated with the engagement\n invitation. Acceptable values are AWS or\n Sandbox, and these values determine the environment in which\n the opportunity is managed.
Specifies the unique identifier of the EngagementInvitation to be rejected. Providing the correct identifier ensures that the intended invitation is rejected.
This is the unique identifier of the rejected\n EngagementInvitation. Providing the correct identifier\n helps to ensure that the intended invitation is rejected.
Specifies the reason for rejecting the engagement invitation. Providing a reason helps document the rationale behind the rejection and assists AWS in tracking patterns or issues. Possible values include:
\n\n Customer problem unclear: The customer's problem is not clearly defined.
\n\n Next steps unclear: The next steps required to proceed are not clear.
\n\n Unable to support: The partner is unable to provide support due to resource or capability constraints.
\n\n Duplicate of Partner Referral: The opportunity is a duplicate of an existing referral.
\n\n Other: Any other reason not covered by the specified values.
\nThis describes the reason for rejecting the engagement invitation,\n which helps AWS track usage patterns. Acceptable values include the\n following:
\n\n Customer problem unclear: The\n customer's problem isn't understood.
\n\n Next steps unclear: The next steps\n required to proceed aren't understood.
\n\n Unable to support: The partner is unable to provide support due to resource or capability constraints.
\n\n Duplicate of partner referral: The\n opportunity is a duplicate of an existing referral.
\n\n Other: Any reason not covered by\n other values.
\n\n Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.\n
\n If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. However, once the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.\n
\n By associating the relevant solutions with the opportunity, you can clearly communicate the offerings that are being considered or implemented to address the customer's business problem.\n
" + "smithy.api#documentation": "\n Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.\n
\n If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. But when the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.\n
\n By associating the relevant solutions with the opportunity, you can communicate the offerings that are being considered or implemented to address the customer's business problem.\n
" } }, "AwsProducts": { @@ -7910,7 +7600,7 @@ } }, "traits": { - "smithy.api#documentation": "This error occurs when the request would cause a service quota to be exceeded.\n Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.\n
\nSuggested action: Review the\n service quotas for the specific resource, and reduce the usage or request a quota increase through support if necessary.\n
", + "smithy.api#documentation": "This error occurs when the request would cause a service quota to be exceeded.\n Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.\n
\nSuggested action: Review the\n Quotas for the resource, and either reduce usage or request a quota increase.\n
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -8227,7 +7917,7 @@ ], "documentation": "Grants permission to initiate tasks that start Engagements on AWS Partner Central by accepting an Engagement Invitation" }, - "smithy.api#documentation": "This action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves several steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS Opportunity, and copying over key details for tracking. Once completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.
This action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves the following steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS opportunity, and copying details for tracking. When completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.
A unique, case-sensitive identifier provided by the client to ensure the idempotency of the request. Can be a random or meaningful string, but must be unique for each request.
", + "smithy.api#documentation": "A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.
", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1 @@ -8259,7 +7949,7 @@ "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier", "traits": { - "smithy.api#documentation": "Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier ensures the right engagement invitation is processed.
Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.
The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.
The unique identifier of the task, used to track the task’s progress.
" } }, "TaskArn": { @@ -8292,7 +7982,7 @@ "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatus", "traits": { - "smithy.api#documentation": "Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.
Indicates the current status of the task.
" } }, "Message": { @@ -8304,7 +7994,7 @@ "ReasonCode": { "target": "com.amazonaws.partnercentralselling#ReasonCode", "traits": { - "smithy.api#documentation": "Indicates the reason for task failure using an enumerated code. Possible values are: ACCEPT_ENGAGEMENT_INVITATION_FAILED, GET_ENGAGEMENT_INVITATION_FAILED, CREATE_OPPORTUNITY_FAILED, CREATE_RESOURCE_VIEW_AUTOMATION_FAILED, SUBMIT_OPPORTUNITY_FAILED.
Indicates the reason for task failure using an enumerated code.
" } }, "OpportunityId": { @@ -8387,9 +8077,9 @@ } }, "ClientToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.partnercentralselling#ClientToken", "traits": { - "smithy.api#documentation": "A unique token provided by the client to ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
", + "smithy.api#documentation": "A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1 @@ -8400,7 +8090,7 @@ "Identifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "The unique identifier of the opportunity from which the engagement task is to be initiated. This ensures the task is applied to the correct opportunity.
", + "smithy.api#documentation": "The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.
", "smithy.api#required": {} } }, @@ -8451,7 +8141,7 @@ "ReasonCode": { "target": "com.amazonaws.partnercentralselling#ReasonCode", "traits": { - "smithy.api#documentation": "Indicates the reason for task failure using an enumerated code. Possible values are: ACCEPT_ENGAGEMENT_INVITATION_FAILED, GET_ENGAGEMENT_INVITATION_FAILED, CREATE_OPPORTUNITY_FAILED, CREATE_RESOURCE_VIEW_AUTOMATION_FAILED, SUBMIT_OPPORTUNITY_FAILED.
Indicates the reason for task failure using an enumerated code.
" } }, "OpportunityId": { @@ -8514,7 +8204,7 @@ } }, "traits": { - "smithy.api#documentation": "This error occurs when there are too many requests sent. Review the provided quotas and adapt your\n usage to avoid throttling.\n
\nThis error occurs when there are too many requests sent. Review the provided\n quotas and retry after the provided delay.\n
", + "smithy.api#documentation": "This error occurs when there are too many requests sent. Review the provided quotas and adapt your\n usage to avoid throttling.\n
\nThis error occurs when there are too many requests sent. Review the provided\n Quotas and retry after the provided delay.\n
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -8566,20 +8256,20 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity is updated in.\n Use AWS to update real opportunities in the production\n environment, and Sandbox to test in a secure and isolated environment.\n When you use the Sandbox catalog, it allows you to simulate and validate your interactions\n with Amazon Web Services services without affecting live data or operations.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity is updated in.\n Use AWS to update real opportunities in the production\n environment, and Sandbox for testing in secure, isolated environments.\n When you use the Sandbox catalog, it allows you to simulate and validate your interactions\n with Amazon Web Services services without affecting live data or operations.\n
\n Identifies the type of support the partner needs from Amazon Web Services.\n
\n\n Valid values:\n
\n\n Co-Sell - 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.\n
\n\n Co-Sell - Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.\n
\n\n Co-Sell - Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.\n
\n\n Co-Sell - 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).\n
\n\n Co-Sell - Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.\n
\n\n Co-Sell - 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.\n
\n\n Co-Sell - Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).\n
\n\n Co-Sell - Support for Public Tender / RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services.\n
\n\n Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. 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.\n
\n\n Identifies the type of support the partner needs from Amazon Web Services.\n
\n\n Valid values:\n
\n\n 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.\n
\n\n Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.\n
\n\n Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.\n
\n\n 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).\n
\n\n Cosell—Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.\n
\n\n 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.\n
\n\n Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).\n
\n\n Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services.\n
\n\n Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.\n
\nSpecifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national security-related opportunities, specific validation and compliance rules may apply, impacting the opportunity's visibility and processing.
Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national-security-related opportunities, validation and compliance rules may apply, impacting the opportunity's visibility and processing.
Specifies details of the customer associated with the Opportunity .\n
Specifies details of the customer associated with the Opportunity.\n