@aws-sdk/client-partnercentral-selling 3.1069.0 → 3.1070.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/dist-cjs/index.js +61 -1
- package/dist-cjs/schemas/schemas_0.js +216 -43
- package/dist-es/PartnerCentralSelling.js +8 -0
- package/dist-es/commands/GetProspectingFromEngagementTaskCommand.js +16 -0
- package/dist-es/commands/ListProspectingFromEngagementTasksCommand.js +16 -0
- package/dist-es/commands/StartProspectingFromEngagementTaskCommand.js +16 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/enums.js +12 -0
- package/dist-es/pagination/ListProspectingFromEngagementTasksPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +200 -43
- package/dist-types/PartnerCentralSelling.d.ts +28 -0
- package/dist-types/PartnerCentralSellingClient.d.ts +5 -2
- package/dist-types/commands/CreateEngagementCommand.d.ts +34 -1
- package/dist-types/commands/CreateEngagementContextCommand.d.ts +34 -1
- package/dist-types/commands/GetAwsOpportunitySummaryCommand.d.ts +14 -0
- package/dist-types/commands/GetEngagementCommand.d.ts +34 -1
- package/dist-types/commands/GetProspectingFromEngagementTaskCommand.d.ts +105 -0
- package/dist-types/commands/GetResourceSnapshotCommand.d.ts +14 -0
- package/dist-types/commands/ListEngagementsCommand.d.ts +3 -3
- package/dist-types/commands/ListProspectingFromEngagementTasksCommand.d.ts +114 -0
- package/dist-types/commands/StartProspectingFromEngagementTaskCommand.d.ts +108 -0
- package/dist-types/commands/UpdateEngagementContextCommand.d.ts +34 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/enums.d.ts +28 -0
- package/dist-types/models/models_0.d.ts +529 -5
- package/dist-types/pagination/ListProspectingFromEngagementTasksPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +19 -0
- package/dist-types/ts3.4/PartnerCentralSelling.d.ts +70 -0
- package/dist-types/ts3.4/PartnerCentralSellingClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/GetProspectingFromEngagementTaskCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListProspectingFromEngagementTasksCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/StartProspectingFromEngagementTaskCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/enums.d.ts +16 -0
- package/dist-types/ts3.4/models/models_0.d.ts +136 -0
- package/dist-types/ts3.4/pagination/ListProspectingFromEngagementTasksPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +19 -0
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AwsClosedLostReason, AwsFundingUsed, AwsMemberBusinessTitle, AwsOpportunityStage, AwsPartition, Channel, ClosedLostReason, CompetitorName, CountryCode, CurrencyCode, DeliveryModel, EngagementContextType, EngagementInvitationPayloadType, EngagementScore, EngagementSortName, ExpectedContractDurationTerm, Industry, InvitationStatus, InvolvementTypeChangeReason, ListTasksSortName, MarketingSource, MarketSegment, NationalSecurity, OpportunityEngagementInvitationSortName, OpportunityOrigin, OpportunitySortName, OpportunityType, ParticipantType, PaymentFrequency, PrimaryNeedFromAws, ReasonCode, ReceiverResponsibility, RelatedEntityType, ResourceSnapshotJobStatus, ResourceType, RevenueModel, ReviewStatus, SalesActivity, SalesInvolvementType, SolutionSortName, SolutionStatus, SortBy, SortOrder, Stage, TaskStatus, ValidationExceptionErrorCode, Visibility } from "./enums";
|
|
1
|
+
import type { AwsClosedLostReason, AwsFundingUsed, AwsMemberBusinessTitle, AwsOpportunityStage, AwsPartition, Channel, ClosedLostReason, CompetitorName, CountryCode, CurrencyCode, DeliveryModel, EngagementContextType, EngagementInvitationPayloadType, EngagementScore, EngagementSortName, ExpectedContractDurationTerm, Industry, InvitationStatus, InvolvementTypeChangeReason, ListTasksSortName, MarketingSource, MarketSegment, NationalSecurity, OpportunityEngagementInvitationSortName, OpportunityOrigin, OpportunitySortName, OpportunityType, ParticipantType, PaymentFrequency, PrimaryNeedFromAws, ProspectingFromEngagementTaskSortName, ProspectingTaskStatus, ReasonCode, ReceiverResponsibility, RelatedEntityType, ResourceSnapshotJobStatus, ResourceType, RevenueModel, ReviewStatus, SalesActivity, SalesInvolvementType, SolutionSortName, SolutionStatus, SortBy, SortOrder, Stage, TaskStatus, ValidationExceptionErrorCode, Visibility } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* @public
|
|
4
4
|
*/
|
|
@@ -412,6 +412,43 @@ export interface AwsProductsSpendInsightsBySource {
|
|
|
412
412
|
*/
|
|
413
413
|
AWS?: AwsProductInsights | undefined;
|
|
414
414
|
}
|
|
415
|
+
/**
|
|
416
|
+
* <p>Opportunity quality score and trend.</p>
|
|
417
|
+
* @public
|
|
418
|
+
*/
|
|
419
|
+
export interface OpportunityQuality {
|
|
420
|
+
/**
|
|
421
|
+
* <p>Deal quality score based on opportunity content completeness and sales methodology criteria. Values range from 0 to 100.</p>
|
|
422
|
+
* @public
|
|
423
|
+
*/
|
|
424
|
+
Score?: number | undefined;
|
|
425
|
+
/**
|
|
426
|
+
* <p>Direction of score change since last scoring iteration. Known values: <code>Improving</code>, <code>Declining</code>, <code>No Change</code>.</p>
|
|
427
|
+
* @public
|
|
428
|
+
*/
|
|
429
|
+
Trend?: string | undefined;
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* <p>A recommendation from an agent-driven source.</p>
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
export interface Recommendation {
|
|
436
|
+
/**
|
|
437
|
+
* <p>The recommendation source type. Known values: <code>OpportunityQuality</code>, <code>SolutionRecommendation</code>, <code>SpecialistRecommendation</code>.</p>
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
Type: string | undefined;
|
|
441
|
+
/**
|
|
442
|
+
* <p>Human-readable recommendation text from this source.</p>
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
Details: string | undefined;
|
|
446
|
+
/**
|
|
447
|
+
* <p>Source-specific metadata as key-value pairs.</p>
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
450
|
+
Attributes?: Record<string, string> | undefined;
|
|
451
|
+
}
|
|
415
452
|
/**
|
|
416
453
|
* <p>Contains insights provided by AWS for the opportunity, offering recommendations and analysis that can help the partner optimize their engagement and strategy.</p>
|
|
417
454
|
* @public
|
|
@@ -432,6 +469,16 @@ export interface AwsOpportunityInsights {
|
|
|
432
469
|
* @public
|
|
433
470
|
*/
|
|
434
471
|
AwsProductsSpendInsightsBySource?: AwsProductsSpendInsightsBySource | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>Opportunity quality assessment. Null if not yet scored.</p>
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
OpportunityQuality?: OpportunityQuality | undefined;
|
|
477
|
+
/**
|
|
478
|
+
* <p>List of recommendations from various agent-driven sources.</p>
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
Recommendations?: Recommendation[] | undefined;
|
|
435
482
|
}
|
|
436
483
|
/**
|
|
437
484
|
* <p>Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.</p>
|
|
@@ -496,12 +543,12 @@ export interface ExpectedCustomerSpend {
|
|
|
496
543
|
*/
|
|
497
544
|
CurrencyCode: CurrencyCode | undefined;
|
|
498
545
|
/**
|
|
499
|
-
* <p>Indicates how frequently the customer is expected to spend the projected amount.
|
|
546
|
+
* <p>Indicates how frequently the customer is expected to spend the projected amount. Use <code>Monthly</code> for recurring monthly spend (required for <code>TargetCompany: "AWS"</code> entries). Use <code>None</code> for one-time deal value entries (required for <code>TargetCompany: "Self"</code> entries when providing Total Contract Value).</p>
|
|
500
547
|
* @public
|
|
501
548
|
*/
|
|
502
549
|
Frequency: PaymentFrequency | undefined;
|
|
503
550
|
/**
|
|
504
|
-
* <p>Specifies the
|
|
551
|
+
* <p>Specifies the entity associated with this spend entry. Use <code>AWS</code> for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use <code>Self</code> for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When <code>ExpectedContractDuration</code> is present on the Project, only <code>AWS</code> and <code>Self</code> are accepted. When <code>ExpectedContractDuration</code> is not present, only <code>AWS</code> is accepted and any other value will be automatically set to <code>AWS</code>.</p>
|
|
505
552
|
* @public
|
|
506
553
|
*/
|
|
507
554
|
TargetCompany: string | undefined;
|
|
@@ -629,6 +676,11 @@ export interface AwsOpportunitySummaryFullView {
|
|
|
629
676
|
* @public
|
|
630
677
|
*/
|
|
631
678
|
Project?: AwsOpportunityProject | undefined;
|
|
679
|
+
/**
|
|
680
|
+
* <p>Engagement classification for this opportunity. Read-only. Null before scoring. Known values: <code>AWS Field-engaged</code>, <code>Agent-engaged</code>, <code>Partner-led</code>.</p>
|
|
681
|
+
* @public
|
|
682
|
+
*/
|
|
683
|
+
CosellMotion?: string | undefined;
|
|
632
684
|
}
|
|
633
685
|
/**
|
|
634
686
|
* <p>Contains details about the customer associated with the Engagement Invitation, including company information and industry.</p>
|
|
@@ -729,6 +781,17 @@ export interface LeadCustomer {
|
|
|
729
781
|
*/
|
|
730
782
|
MarketSegment?: MarketSegment | undefined;
|
|
731
783
|
}
|
|
784
|
+
/**
|
|
785
|
+
* <p>Contains insights that AI generates for a lead. These insights provide automated analysis to help partners evaluate the lead quality and prioritize engagement efforts.</p>
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
788
|
+
export interface LeadInsights {
|
|
789
|
+
/**
|
|
790
|
+
* <p>A score that indicates the lead's readiness for engagement. Valid values are <code>Low</code>, <code>Medium</code>, and <code>High</code>. Use this score to prioritize leads based on their likelihood of conversion.</p>
|
|
791
|
+
* @public
|
|
792
|
+
*/
|
|
793
|
+
LeadReadinessScore?: string | undefined;
|
|
794
|
+
}
|
|
732
795
|
/**
|
|
733
796
|
* <p>An object that contains a lead contact's details associated with the engagement. This provides contact information for individuals involved in lead-related activities.</p>
|
|
734
797
|
* @public
|
|
@@ -811,6 +874,11 @@ export interface LeadInteraction {
|
|
|
811
874
|
* @public
|
|
812
875
|
*/
|
|
813
876
|
export interface LeadContext {
|
|
877
|
+
/**
|
|
878
|
+
* <p>Insights that AI generates and associates with the lead. These insights provide automated analysis such as lead readiness scoring to help partners assess the lead quality.</p>
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
Insights?: LeadInsights | undefined;
|
|
814
882
|
/**
|
|
815
883
|
* <p>Indicates the current qualification status of the lead, such as whether it has been qualified, disqualified, or is still under evaluation. This helps track the lead's progression through the qualification process.</p>
|
|
816
884
|
* @public
|
|
@@ -827,11 +895,150 @@ export interface LeadContext {
|
|
|
827
895
|
*/
|
|
828
896
|
Interactions: LeadInteraction[] | undefined;
|
|
829
897
|
}
|
|
898
|
+
/**
|
|
899
|
+
* <p>Contains detailed information about the prospected customer account, including company identifiers, geographic classification, industry segmentation, and program eligibility.</p>
|
|
900
|
+
* @public
|
|
901
|
+
*/
|
|
902
|
+
export interface ProspectingResultCustomer {
|
|
903
|
+
/**
|
|
904
|
+
* <p>The name of the prospected customer account.</p>
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
907
|
+
AccountName?: string | undefined;
|
|
908
|
+
/**
|
|
909
|
+
* <p>The geographic region classification of the prospected customer account.</p>
|
|
910
|
+
* @public
|
|
911
|
+
*/
|
|
912
|
+
Geo?: string | undefined;
|
|
913
|
+
/**
|
|
914
|
+
* <p>The specific region of the prospected customer account.</p>
|
|
915
|
+
* @public
|
|
916
|
+
*/
|
|
917
|
+
Region?: string | undefined;
|
|
918
|
+
/**
|
|
919
|
+
* <p>The subregion classification of the prospected customer account.</p>
|
|
920
|
+
* @public
|
|
921
|
+
*/
|
|
922
|
+
SubRegion?: string | undefined;
|
|
923
|
+
/**
|
|
924
|
+
* <p>The country code of the prospected customer account.</p>
|
|
925
|
+
* @public
|
|
926
|
+
*/
|
|
927
|
+
Country?: CountryCode | undefined;
|
|
928
|
+
/**
|
|
929
|
+
* <p>The industry classification of the prospected customer account.</p>
|
|
930
|
+
* @public
|
|
931
|
+
*/
|
|
932
|
+
Industry?: Industry | undefined;
|
|
933
|
+
/**
|
|
934
|
+
* <p>The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.</p>
|
|
935
|
+
* @public
|
|
936
|
+
*/
|
|
937
|
+
SubIndustry?: string | undefined;
|
|
938
|
+
/**
|
|
939
|
+
* <p>The market segment classification of the prospected customer account.</p>
|
|
940
|
+
* @public
|
|
941
|
+
*/
|
|
942
|
+
Segment?: string | undefined;
|
|
943
|
+
/**
|
|
944
|
+
* <p>The company size classification of the prospected customer account.</p>
|
|
945
|
+
* @public
|
|
946
|
+
*/
|
|
947
|
+
CompanySize?: string | undefined;
|
|
948
|
+
/**
|
|
949
|
+
* <p>A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.</p>
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
EligiblePrograms?: string[] | undefined;
|
|
953
|
+
/**
|
|
954
|
+
* <p>A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.</p>
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
PublicProfileSummary?: string | undefined;
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* <p>Contains insights that AI generates from the prospecting analysis. These insights include marketplace engagement scoring, solution fit assessments, and solution categorization for the prospected customer.</p>
|
|
961
|
+
* @public
|
|
962
|
+
*/
|
|
963
|
+
export interface ProspectingInsights {
|
|
964
|
+
/**
|
|
965
|
+
* <p>A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are <code>High</code>, <code>Medium</code>, and <code>Low</code>.</p>
|
|
966
|
+
* @public
|
|
967
|
+
*/
|
|
968
|
+
MarketplaceEngagementScore?: string | undefined;
|
|
969
|
+
/**
|
|
970
|
+
* <p>A score that indicates how well the partner's solution fits the prospected customer's needs.</p>
|
|
971
|
+
* @public
|
|
972
|
+
*/
|
|
973
|
+
SolutionScore?: string | undefined;
|
|
974
|
+
/**
|
|
975
|
+
* <p>The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.</p>
|
|
976
|
+
* @public
|
|
977
|
+
*/
|
|
978
|
+
SolutionCategory?: string | undefined;
|
|
979
|
+
/**
|
|
980
|
+
* <p>The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.</p>
|
|
981
|
+
* @public
|
|
982
|
+
*/
|
|
983
|
+
SolutionSubCategory?: string | undefined;
|
|
984
|
+
}
|
|
985
|
+
/**
|
|
986
|
+
* <p>Contains the prospecting data that AWS sources. This includes task execution details, customer account information, and insights that AI generates from the prospecting analysis.</p>
|
|
987
|
+
* @public
|
|
988
|
+
*/
|
|
989
|
+
export interface ProspectingResultAws {
|
|
990
|
+
/**
|
|
991
|
+
* <p>The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).</p>
|
|
992
|
+
* @public
|
|
993
|
+
*/
|
|
994
|
+
StartTime?: Date | undefined;
|
|
995
|
+
/**
|
|
996
|
+
* <p>The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).</p>
|
|
997
|
+
* @public
|
|
998
|
+
*/
|
|
999
|
+
EndTime?: Date | undefined;
|
|
1000
|
+
/**
|
|
1001
|
+
* <p>The unique identifier of the prospecting task that generates this result.</p>
|
|
1002
|
+
* @public
|
|
1003
|
+
*/
|
|
1004
|
+
TaskId?: string | undefined;
|
|
1005
|
+
/**
|
|
1006
|
+
* <p>The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.</p>
|
|
1007
|
+
* @public
|
|
1008
|
+
*/
|
|
1009
|
+
TaskArn?: string | undefined;
|
|
1010
|
+
/**
|
|
1011
|
+
* <p>The name that the user provides for the prospecting task that generates this result.</p>
|
|
1012
|
+
* @public
|
|
1013
|
+
*/
|
|
1014
|
+
TaskName?: string | undefined;
|
|
1015
|
+
/**
|
|
1016
|
+
* <p>Contains details about the prospected customer account, including geographic, industry, and segment classifications.</p>
|
|
1017
|
+
* @public
|
|
1018
|
+
*/
|
|
1019
|
+
Customer?: ProspectingResultCustomer | undefined;
|
|
1020
|
+
/**
|
|
1021
|
+
* <p>Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.</p>
|
|
1022
|
+
* @public
|
|
1023
|
+
*/
|
|
1024
|
+
Insights?: ProspectingInsights | undefined;
|
|
1025
|
+
}
|
|
1026
|
+
/**
|
|
1027
|
+
* <p>Contains the results of an autonomous prospecting job. This includes data and insights that AWS provides about a prospected customer account.</p>
|
|
1028
|
+
* @public
|
|
1029
|
+
*/
|
|
1030
|
+
export interface ProspectingResult {
|
|
1031
|
+
/**
|
|
1032
|
+
* <p>Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.</p>
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
Aws?: ProspectingResultAws | undefined;
|
|
1036
|
+
}
|
|
830
1037
|
/**
|
|
831
1038
|
* <p>Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails. </p>
|
|
832
1039
|
* @public
|
|
833
1040
|
*/
|
|
834
|
-
export type EngagementContextPayload = EngagementContextPayload.CustomerProjectMember | EngagementContextPayload.LeadMember | EngagementContextPayload.$UnknownMember;
|
|
1041
|
+
export type EngagementContextPayload = EngagementContextPayload.CustomerProjectMember | EngagementContextPayload.LeadMember | EngagementContextPayload.ProspectingResultMember | EngagementContextPayload.$UnknownMember;
|
|
835
1042
|
/**
|
|
836
1043
|
* @public
|
|
837
1044
|
*/
|
|
@@ -843,6 +1050,7 @@ export declare namespace EngagementContextPayload {
|
|
|
843
1050
|
interface CustomerProjectMember {
|
|
844
1051
|
CustomerProject: CustomerProjectsContext;
|
|
845
1052
|
Lead?: never;
|
|
1053
|
+
ProspectingResult?: never;
|
|
846
1054
|
$unknown?: never;
|
|
847
1055
|
}
|
|
848
1056
|
/**
|
|
@@ -852,6 +1060,17 @@ export declare namespace EngagementContextPayload {
|
|
|
852
1060
|
interface LeadMember {
|
|
853
1061
|
CustomerProject?: never;
|
|
854
1062
|
Lead: LeadContext;
|
|
1063
|
+
ProspectingResult?: never;
|
|
1064
|
+
$unknown?: never;
|
|
1065
|
+
}
|
|
1066
|
+
/**
|
|
1067
|
+
* <p>Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".</p>
|
|
1068
|
+
* @public
|
|
1069
|
+
*/
|
|
1070
|
+
interface ProspectingResultMember {
|
|
1071
|
+
CustomerProject?: never;
|
|
1072
|
+
Lead?: never;
|
|
1073
|
+
ProspectingResult: ProspectingResult;
|
|
855
1074
|
$unknown?: never;
|
|
856
1075
|
}
|
|
857
1076
|
/**
|
|
@@ -860,6 +1079,7 @@ export declare namespace EngagementContextPayload {
|
|
|
860
1079
|
interface $UnknownMember {
|
|
861
1080
|
CustomerProject?: never;
|
|
862
1081
|
Lead?: never;
|
|
1082
|
+
ProspectingResult?: never;
|
|
863
1083
|
$unknown: [string, any];
|
|
864
1084
|
}
|
|
865
1085
|
/**
|
|
@@ -869,6 +1089,7 @@ export declare namespace EngagementContextPayload {
|
|
|
869
1089
|
interface Visitor<T> {
|
|
870
1090
|
CustomerProject: (value: CustomerProjectsContext) => T;
|
|
871
1091
|
Lead: (value: LeadContext) => T;
|
|
1092
|
+
ProspectingResult: (value: ProspectingResult) => T;
|
|
872
1093
|
_: (name: string, value: any) => T;
|
|
873
1094
|
}
|
|
874
1095
|
}
|
|
@@ -2776,6 +2997,11 @@ export interface GetAwsOpportunitySummaryResponse {
|
|
|
2776
2997
|
* @public
|
|
2777
2998
|
*/
|
|
2778
2999
|
Project?: AwsOpportunityProject | undefined;
|
|
3000
|
+
/**
|
|
3001
|
+
* <p>Engagement classification for this opportunity. Read-only. Null before scoring. Known values: <code>AWS Field-engaged</code>, <code>Agent-engaged</code>, <code>Partner-led</code>.</p>
|
|
3002
|
+
* @public
|
|
3003
|
+
*/
|
|
3004
|
+
CosellMotion?: string | undefined;
|
|
2779
3005
|
/**
|
|
2780
3006
|
* <p>Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., <code>AWS</code> or <code>Sandbox</code>) where the opportunity is being managed.</p>
|
|
2781
3007
|
* @public
|
|
@@ -3487,6 +3713,285 @@ export interface StartOpportunityFromEngagementTaskResponse {
|
|
|
3487
3713
|
*/
|
|
3488
3714
|
ContextId?: string | undefined;
|
|
3489
3715
|
}
|
|
3716
|
+
/**
|
|
3717
|
+
* <p>Represents the request structure for retrieving the status and results of a prospecting task.</p>
|
|
3718
|
+
* @public
|
|
3719
|
+
*/
|
|
3720
|
+
export interface GetProspectingFromEngagementTaskRequest {
|
|
3721
|
+
/**
|
|
3722
|
+
* <p>Specifies the catalog associated with the task. Specify <code>AWS</code> for production environments and <code>Sandbox</code> for testing and development purposes. The value must match the catalog used when the task was created.</p>
|
|
3723
|
+
* @public
|
|
3724
|
+
*/
|
|
3725
|
+
Catalog: string | undefined;
|
|
3726
|
+
/**
|
|
3727
|
+
* <p>The unique identifier of the prospecting task to retrieve. This value is returned in the <code>TaskId</code> field of the <code>StartProspectingFromEngagementTask</code> response.</p>
|
|
3728
|
+
* @public
|
|
3729
|
+
*/
|
|
3730
|
+
TaskIdentifier: string | undefined;
|
|
3731
|
+
}
|
|
3732
|
+
/**
|
|
3733
|
+
* <p>Contains the result of processing a single engagement within a prospecting task. Each engagement is processed independently, so individual engagements can succeed or fail regardless of other engagements in the same task.</p>
|
|
3734
|
+
* @public
|
|
3735
|
+
*/
|
|
3736
|
+
export interface EngagementProspectingResult {
|
|
3737
|
+
/**
|
|
3738
|
+
* <p>The unique identifier of the engagement that was processed.</p>
|
|
3739
|
+
* @public
|
|
3740
|
+
*/
|
|
3741
|
+
EngagementIdentifier: string | undefined;
|
|
3742
|
+
/**
|
|
3743
|
+
* <p>The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is <code>COMPLETED</code>). Use this identifier to reference the prospecting context in subsequent operations.</p>
|
|
3744
|
+
* @public
|
|
3745
|
+
*/
|
|
3746
|
+
EngagementContextId?: string | undefined;
|
|
3747
|
+
/**
|
|
3748
|
+
* <p>The processing status of this specific engagement. Possible values are <code>PENDING</code>, <code>IN_PROGRESS</code>, <code>COMPLETED</code>, and <code>FAILED</code>.</p>
|
|
3749
|
+
* @public
|
|
3750
|
+
*/
|
|
3751
|
+
Status: ProspectingTaskStatus | undefined;
|
|
3752
|
+
/**
|
|
3753
|
+
* <p>An enumerated code indicating the reason this engagement failed to process. This field is only populated when <code>Status</code> is <code>FAILED</code>.</p>
|
|
3754
|
+
* @public
|
|
3755
|
+
*/
|
|
3756
|
+
ReasonCode?: string | undefined;
|
|
3757
|
+
/**
|
|
3758
|
+
* <p>A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when <code>Status</code> is <code>FAILED</code>.</p>
|
|
3759
|
+
* @public
|
|
3760
|
+
*/
|
|
3761
|
+
Message?: string | undefined;
|
|
3762
|
+
}
|
|
3763
|
+
/**
|
|
3764
|
+
* <p>Represents the response structure containing the full details of a prospecting task, including per-engagement processing results. Includes the <code>Status</code> field of each <code>EngagementProspectingResult</code> entry to determine individual outcomes.</p>
|
|
3765
|
+
* @public
|
|
3766
|
+
*/
|
|
3767
|
+
export interface GetProspectingFromEngagementTaskResponse {
|
|
3768
|
+
/**
|
|
3769
|
+
* <p>The unique identifier of the task.</p>
|
|
3770
|
+
* @public
|
|
3771
|
+
*/
|
|
3772
|
+
TaskId: string | undefined;
|
|
3773
|
+
/**
|
|
3774
|
+
* <p>The Amazon Resource Name (ARN) of the task.</p>
|
|
3775
|
+
* @public
|
|
3776
|
+
*/
|
|
3777
|
+
TaskArn: string | undefined;
|
|
3778
|
+
/**
|
|
3779
|
+
* <p>The descriptive name of the task that you provided when you created it.</p>
|
|
3780
|
+
* @public
|
|
3781
|
+
*/
|
|
3782
|
+
TaskName: string | undefined;
|
|
3783
|
+
/**
|
|
3784
|
+
* <p>The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.</p>
|
|
3785
|
+
* @public
|
|
3786
|
+
*/
|
|
3787
|
+
StartTime: Date | undefined;
|
|
3788
|
+
/**
|
|
3789
|
+
* <p>The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.</p>
|
|
3790
|
+
* @public
|
|
3791
|
+
*/
|
|
3792
|
+
EndTime?: Date | undefined;
|
|
3793
|
+
/**
|
|
3794
|
+
* <p>An array of <code>EngagementProspectingResult</code> entries for each engagement in the task. Each entry contains the processing status. For successfully completed engagements, includes the prospecting context identifier. For failed engagements, includes an error code and message.</p>
|
|
3795
|
+
* @public
|
|
3796
|
+
*/
|
|
3797
|
+
Engagements: EngagementProspectingResult[] | undefined;
|
|
3798
|
+
}
|
|
3799
|
+
/**
|
|
3800
|
+
* <p>Specifies the sort configuration for <code>ListProspectingFromEngagementTasks</code>. Contains the field to sort by and the sort direction.</p>
|
|
3801
|
+
* @public
|
|
3802
|
+
*/
|
|
3803
|
+
export interface ProspectingFromEngagementTaskSort {
|
|
3804
|
+
/**
|
|
3805
|
+
* <p>The direction in which to sort the results. Use <code>ASCENDING</code> to return the smallest or earliest values first, or <code>DESCENDING</code> to return the largest or most recent values first.</p>
|
|
3806
|
+
* @public
|
|
3807
|
+
*/
|
|
3808
|
+
SortOrder: SortOrder | undefined;
|
|
3809
|
+
/**
|
|
3810
|
+
* <p>The field by which to sort the returned tasks. Valid values: <code>StartTime</code> (task creation timestamp), <code>TaskName</code> (alphabetically by task name), and <code>FailedEngagementCount</code> (number of failed engagements).</p>
|
|
3811
|
+
* @public
|
|
3812
|
+
*/
|
|
3813
|
+
SortBy: ProspectingFromEngagementTaskSortName | undefined;
|
|
3814
|
+
}
|
|
3815
|
+
/**
|
|
3816
|
+
* <p>Represents the request structure for listing prospecting tasks. All filter parameters are optional. Results are paginated — uses <code>NextToken</code> from the response to retrieve subsequent pages.</p>
|
|
3817
|
+
* @public
|
|
3818
|
+
*/
|
|
3819
|
+
export interface ListProspectingFromEngagementTasksRequest {
|
|
3820
|
+
/**
|
|
3821
|
+
* <p>Specifies the catalog to list tasks from. Specify <code>AWS</code> for production environments and <code>Sandbox</code> for testing and development purposes.</p>
|
|
3822
|
+
* @public
|
|
3823
|
+
*/
|
|
3824
|
+
Catalog: string | undefined;
|
|
3825
|
+
/**
|
|
3826
|
+
* <p>The maximum number of results to return in a single page. If additional results exist, the response includes a <code>NextToken</code> value for retrieving the next page. If omitted, the API uses a service-defined default page size.</p>
|
|
3827
|
+
* @public
|
|
3828
|
+
*/
|
|
3829
|
+
MaxResults?: number | undefined;
|
|
3830
|
+
/**
|
|
3831
|
+
* <p>The pagination token from a previous call to this API. Include this value to retrieve the next page of results. If omitted, the first page is returned.</p>
|
|
3832
|
+
* @public
|
|
3833
|
+
*/
|
|
3834
|
+
NextToken?: string | undefined;
|
|
3835
|
+
/**
|
|
3836
|
+
* <p>Filters the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.</p>
|
|
3837
|
+
* @public
|
|
3838
|
+
*/
|
|
3839
|
+
TaskIdentifier?: string[] | undefined;
|
|
3840
|
+
/**
|
|
3841
|
+
* <p>Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.</p>
|
|
3842
|
+
* @public
|
|
3843
|
+
*/
|
|
3844
|
+
TaskName?: string[] | undefined;
|
|
3845
|
+
/**
|
|
3846
|
+
* <p>Filters tasks to include only those that started after the specified timestamp. Use this with <code>StartBefore</code> to define a start-time range for your query. The format follows ISO 8601 date-time notation.</p>
|
|
3847
|
+
* @public
|
|
3848
|
+
*/
|
|
3849
|
+
StartAfter?: Date | undefined;
|
|
3850
|
+
/**
|
|
3851
|
+
* <p>Filters tasks to include only those that started before the specified timestamp. Use this with <code>StartAfter</code> to define a start-time range for your query. The format follows ISO 8601 date-time notation.</p>
|
|
3852
|
+
* @public
|
|
3853
|
+
*/
|
|
3854
|
+
StartBefore?: Date | undefined;
|
|
3855
|
+
/**
|
|
3856
|
+
* <p>Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.</p>
|
|
3857
|
+
* @public
|
|
3858
|
+
*/
|
|
3859
|
+
Sort?: ProspectingFromEngagementTaskSort | undefined;
|
|
3860
|
+
}
|
|
3861
|
+
/**
|
|
3862
|
+
* <p>A summary of a single prospecting task, returned by <code>ListProspectingFromEngagementTasks</code>. Contains key metrics and status information without the full per-engagement detail available from <code>GetProspectingFromEngagementTask</code>.</p>
|
|
3863
|
+
* @public
|
|
3864
|
+
*/
|
|
3865
|
+
export interface ProspectingTaskSummary {
|
|
3866
|
+
/**
|
|
3867
|
+
* <p>The unique identifier of the task. Use this value with <code>GetProspectingFromEngagementTask</code> to retrieve full task details.</p>
|
|
3868
|
+
* @public
|
|
3869
|
+
*/
|
|
3870
|
+
TaskId: string | undefined;
|
|
3871
|
+
/**
|
|
3872
|
+
* <p>The Amazon Resource Name (ARN) of the task.</p>
|
|
3873
|
+
* @public
|
|
3874
|
+
*/
|
|
3875
|
+
TaskArn: string | undefined;
|
|
3876
|
+
/**
|
|
3877
|
+
* <p>The descriptive name of the task provided when it was created.</p>
|
|
3878
|
+
* @public
|
|
3879
|
+
*/
|
|
3880
|
+
TaskName: string | undefined;
|
|
3881
|
+
/**
|
|
3882
|
+
* <p>The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.</p>
|
|
3883
|
+
* @public
|
|
3884
|
+
*/
|
|
3885
|
+
StartTime: Date | undefined;
|
|
3886
|
+
/**
|
|
3887
|
+
* <p>The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.</p>
|
|
3888
|
+
* @public
|
|
3889
|
+
*/
|
|
3890
|
+
EndTime?: Date | undefined;
|
|
3891
|
+
/**
|
|
3892
|
+
* <p>The total number of engagements included in the task.</p>
|
|
3893
|
+
* @public
|
|
3894
|
+
*/
|
|
3895
|
+
TotalEngagementCount: number | undefined;
|
|
3896
|
+
/**
|
|
3897
|
+
* <p>The number of engagements that have been successfully converted into prospecting leads.</p>
|
|
3898
|
+
* @public
|
|
3899
|
+
*/
|
|
3900
|
+
CompletedEngagementCount: number | undefined;
|
|
3901
|
+
/**
|
|
3902
|
+
* <p>The number of engagements that failed to be converted. Retrieve the full task details using <code>GetProspectingFromEngagementTask</code> for per-engagement error information.</p>
|
|
3903
|
+
* @public
|
|
3904
|
+
*/
|
|
3905
|
+
FailedEngagementCount: number | undefined;
|
|
3906
|
+
}
|
|
3907
|
+
/**
|
|
3908
|
+
* <p>Represents the response structure containing a paginated list of prospecting task summaries matching the request filters. Indicates through <code>NextToken</code> when additional results are available.</p>
|
|
3909
|
+
* @public
|
|
3910
|
+
*/
|
|
3911
|
+
export interface ListProspectingFromEngagementTasksResponse {
|
|
3912
|
+
/**
|
|
3913
|
+
* <p>A pagination token used to retrieve the next page of results. If this field is present, pass its value as <code>NextToken</code> in the next call. If absent or empty, there are no further pages.</p>
|
|
3914
|
+
* @public
|
|
3915
|
+
*/
|
|
3916
|
+
NextToken?: string | undefined;
|
|
3917
|
+
/**
|
|
3918
|
+
* <p>Prospecting task summaries matching the specified filters. Each summary includes the task identifier, name, status counters, and timing information. If no tasks match the filter criteria, the list is empty.</p>
|
|
3919
|
+
* @public
|
|
3920
|
+
*/
|
|
3921
|
+
TaskSummaries: ProspectingTaskSummary[] | undefined;
|
|
3922
|
+
}
|
|
3923
|
+
/**
|
|
3924
|
+
* <p>Represents the request structure for starting a prospecting task. Includes up to 100 engagement identifiers and a task name. Uses <code>ClientToken</code> to ensure idempotency.</p>
|
|
3925
|
+
* @public
|
|
3926
|
+
*/
|
|
3927
|
+
export interface StartProspectingFromEngagementTaskRequest {
|
|
3928
|
+
/**
|
|
3929
|
+
* <p>Specifies the catalog in which the task is initiated. Specify <code>AWS</code> for production environments and <code>Sandbox</code> for testing and development purposes.</p>
|
|
3930
|
+
* @public
|
|
3931
|
+
*/
|
|
3932
|
+
Catalog: string | undefined;
|
|
3933
|
+
/**
|
|
3934
|
+
* <p>The list of engagement identifiers to include in this prospecting task. Each identifier must correspond to an existing engagement in the specified catalog. Maximum of 100 identifiers per task.</p>
|
|
3935
|
+
* @public
|
|
3936
|
+
*/
|
|
3937
|
+
Identifiers: string[] | undefined;
|
|
3938
|
+
/**
|
|
3939
|
+
* <p>A descriptive name for the task. This name helps identify the task in list and get operations. The name must contain 1 to 128 characters.</p>
|
|
3940
|
+
* @public
|
|
3941
|
+
*/
|
|
3942
|
+
TaskName: string | undefined;
|
|
3943
|
+
/**
|
|
3944
|
+
* <p>A unique, case-sensitive identifier provided by the client to ensure idempotency. Making the same request with the same <code>ClientToken</code> returns the same response without creating a duplicate task.</p>
|
|
3945
|
+
* @public
|
|
3946
|
+
*/
|
|
3947
|
+
ClientToken?: string | undefined;
|
|
3948
|
+
}
|
|
3949
|
+
/**
|
|
3950
|
+
* <p>Represents the response structure returned when a prospecting task is successfully submitted. Contains the task identifier, ARN, and initial status. Uses <code>TaskId</code> with <code>GetProspectingFromEngagementTask</code> to poll for completion.</p>
|
|
3951
|
+
* @public
|
|
3952
|
+
*/
|
|
3953
|
+
export interface StartProspectingFromEngagementTaskResponse {
|
|
3954
|
+
/**
|
|
3955
|
+
* <p>The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.</p>
|
|
3956
|
+
* @public
|
|
3957
|
+
*/
|
|
3958
|
+
Identifiers: string[] | undefined;
|
|
3959
|
+
/**
|
|
3960
|
+
* <p>The task name from the request.</p>
|
|
3961
|
+
* @public
|
|
3962
|
+
*/
|
|
3963
|
+
TaskName: string | undefined;
|
|
3964
|
+
/**
|
|
3965
|
+
* <p>A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.</p>
|
|
3966
|
+
* @public
|
|
3967
|
+
*/
|
|
3968
|
+
Message?: string | undefined;
|
|
3969
|
+
/**
|
|
3970
|
+
* <p>An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding <code>Message</code> field for a human-readable description of the failure.</p>
|
|
3971
|
+
* @public
|
|
3972
|
+
*/
|
|
3973
|
+
ReasonCode?: string | undefined;
|
|
3974
|
+
/**
|
|
3975
|
+
* <p>The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.</p>
|
|
3976
|
+
* @public
|
|
3977
|
+
*/
|
|
3978
|
+
StartTime: Date | undefined;
|
|
3979
|
+
/**
|
|
3980
|
+
* <p>The unique identifier assigned to this task. Use this identifier with <code>GetProspectingFromEngagementTask</code> to retrieve task details and check status.</p>
|
|
3981
|
+
* @public
|
|
3982
|
+
*/
|
|
3983
|
+
TaskId?: string | undefined;
|
|
3984
|
+
/**
|
|
3985
|
+
* <p>The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.</p>
|
|
3986
|
+
* @public
|
|
3987
|
+
*/
|
|
3988
|
+
TaskArn?: string | undefined;
|
|
3989
|
+
/**
|
|
3990
|
+
* <p>The current status of the task. Possible values: <code>PENDING</code> (waiting to run), <code>IN_PROGRESS</code> (actively processing), <code>COMPLETED</code> (successfully processed), and <code>FAILED</code> (unrecoverable error).</p>
|
|
3991
|
+
* @public
|
|
3992
|
+
*/
|
|
3993
|
+
TaskStatus: ProspectingTaskStatus | undefined;
|
|
3994
|
+
}
|
|
3490
3995
|
/**
|
|
3491
3996
|
* @public
|
|
3492
3997
|
*/
|
|
@@ -4436,12 +4941,17 @@ export interface UpdateLeadContext {
|
|
|
4436
4941
|
* @public
|
|
4437
4942
|
*/
|
|
4438
4943
|
Interaction?: LeadInteraction | undefined;
|
|
4944
|
+
/**
|
|
4945
|
+
* <p>Insights that AI generates and associates with the lead. These insights provide automated analysis to help partners assess the lead quality and readiness.</p>
|
|
4946
|
+
* @public
|
|
4947
|
+
*/
|
|
4948
|
+
Insights?: LeadInsights | undefined;
|
|
4439
4949
|
}
|
|
4440
4950
|
/**
|
|
4441
4951
|
* <p>Represents the updated payload of an engagement context. The structure of this payload varies based on the context type being updated.</p>
|
|
4442
4952
|
* @public
|
|
4443
4953
|
*/
|
|
4444
|
-
export type UpdateEngagementContextPayload = UpdateEngagementContextPayload.CustomerProjectMember | UpdateEngagementContextPayload.LeadMember | UpdateEngagementContextPayload.$UnknownMember;
|
|
4954
|
+
export type UpdateEngagementContextPayload = UpdateEngagementContextPayload.CustomerProjectMember | UpdateEngagementContextPayload.LeadMember | UpdateEngagementContextPayload.ProspectingResultMember | UpdateEngagementContextPayload.$UnknownMember;
|
|
4445
4955
|
/**
|
|
4446
4956
|
* @public
|
|
4447
4957
|
*/
|
|
@@ -4453,6 +4963,7 @@ export declare namespace UpdateEngagementContextPayload {
|
|
|
4453
4963
|
interface LeadMember {
|
|
4454
4964
|
Lead: UpdateLeadContext;
|
|
4455
4965
|
CustomerProject?: never;
|
|
4966
|
+
ProspectingResult?: never;
|
|
4456
4967
|
$unknown?: never;
|
|
4457
4968
|
}
|
|
4458
4969
|
/**
|
|
@@ -4462,6 +4973,17 @@ export declare namespace UpdateEngagementContextPayload {
|
|
|
4462
4973
|
interface CustomerProjectMember {
|
|
4463
4974
|
Lead?: never;
|
|
4464
4975
|
CustomerProject: CustomerProjectsContext;
|
|
4976
|
+
ProspectingResult?: never;
|
|
4977
|
+
$unknown?: never;
|
|
4978
|
+
}
|
|
4979
|
+
/**
|
|
4980
|
+
* <p>Contains updated prospecting result data when the context type is "ProspectingResult". This field includes enriched data and insights that the system generates when a partner runs an autonomous prospecting job on leads.</p>
|
|
4981
|
+
* @public
|
|
4982
|
+
*/
|
|
4983
|
+
interface ProspectingResultMember {
|
|
4984
|
+
Lead?: never;
|
|
4985
|
+
CustomerProject?: never;
|
|
4986
|
+
ProspectingResult: ProspectingResult;
|
|
4465
4987
|
$unknown?: never;
|
|
4466
4988
|
}
|
|
4467
4989
|
/**
|
|
@@ -4470,6 +4992,7 @@ export declare namespace UpdateEngagementContextPayload {
|
|
|
4470
4992
|
interface $UnknownMember {
|
|
4471
4993
|
Lead?: never;
|
|
4472
4994
|
CustomerProject?: never;
|
|
4995
|
+
ProspectingResult?: never;
|
|
4473
4996
|
$unknown: [string, any];
|
|
4474
4997
|
}
|
|
4475
4998
|
/**
|
|
@@ -4479,6 +5002,7 @@ export declare namespace UpdateEngagementContextPayload {
|
|
|
4479
5002
|
interface Visitor<T> {
|
|
4480
5003
|
Lead: (value: UpdateLeadContext) => T;
|
|
4481
5004
|
CustomerProject: (value: CustomerProjectsContext) => T;
|
|
5005
|
+
ProspectingResult: (value: ProspectingResult) => T;
|
|
4482
5006
|
_: (name: string, value: any) => T;
|
|
4483
5007
|
}
|
|
4484
5008
|
}
|