2026/06/16 - Partner Central Selling API - 3 new 7 updated api methods
Changes Added Prospecting APIs to convert engagements into AI-enriched leads with scoring insights. Extended Engagement APIs with ProspectingResult and Lead contexts. Added CoSell Scoring to GetAwsOpportunitySummary- quality score, trend, agent-driven recommendations, and engagement classification.
Lists all prospecting tasks initiated by the caller's account. Supports optional filters by task identifier, task name, or start time range. Results can be sorted using configurable options. The response is paginated. Use the NextToken value from each response to retrieve subsequent pages.
See also: AWS API Documentation
Request Syntax
client.list_prospecting_from_engagement_tasks(
Catalog='string',
MaxResults=123,
NextToken='string',
TaskIdentifier=[
'string',
],
TaskName=[
'string',
],
StartAfter=datetime(2015, 1, 1),
StartBefore=datetime(2015, 1, 1),
Sort={
'SortOrder': 'ASCENDING'|'DESCENDING',
'SortBy': 'StartTime'|'TaskName'|'FailedEngagementCount'
}
)
string
[REQUIRED]
Specifies the catalog to list tasks from. Specify AWS for production environments and Sandbox for testing and development purposes.
integer
The maximum number of results to return in a single page. If additional results exist, the response includes a NextToken value for retrieving the next page. If omitted, the API uses a service-defined default page size.
string
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.
list
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.
(string) --
list
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.
(string) --
datetime
Filters tasks to include only those that started after the specified timestamp. Use this with StartBefore to define a start-time range for your query. The format follows ISO 8601 date-time notation.
datetime
Filters tasks to include only those that started before the specified timestamp. Use this with StartAfter to define a start-time range for your query. The format follows ISO 8601 date-time notation.
dict
Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.
SortOrder (string) -- [REQUIRED]
The direction in which to sort the results. Use ASCENDING to return the smallest or earliest values first, or DESCENDING to return the largest or most recent values first.
SortBy (string) -- [REQUIRED]
The field by which to sort the returned tasks. Valid values: StartTime (task creation timestamp), TaskName (alphabetically by task name), and FailedEngagementCount (number of failed engagements).
dict
Response Syntax
{
'NextToken': 'string',
'TaskSummaries': [
{
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TotalEngagementCount': 123,
'CompletedEngagementCount': 123,
'FailedEngagementCount': 123
},
]
}
Response Structure
(dict) --
Represents the response structure containing a paginated list of prospecting task summaries matching the request filters. Indicates through NextToken when additional results are available.
NextToken (string) --
A pagination token used to retrieve the next page of results. If this field is present, pass its value as NextToken in the next call. If absent or empty, there are no further pages.
TaskSummaries (list) --
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.
(dict) --
A summary of a single prospecting task, returned by ListProspectingFromEngagementTasks. Contains key metrics and status information without the full per-engagement detail available from GetProspectingFromEngagementTask.
TaskId (string) --
The unique identifier of the task. Use this value with GetProspectingFromEngagementTask to retrieve full task details.
TaskArn (string) --
The Amazon Resource Name (ARN) of the task.
TaskName (string) --
The descriptive name of the task provided when it was created.
StartTime (datetime) --
The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
EndTime (datetime) --
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.
TotalEngagementCount (integer) --
The total number of engagements included in the task.
CompletedEngagementCount (integer) --
The number of engagements that have been successfully converted into prospecting leads.
FailedEngagementCount (integer) --
The number of engagements that failed to be converted. Retrieve the full task details using GetProspectingFromEngagementTask for per-engagement error information.
Starts a task to convert one or more engagement contexts into new prospecting leads. The task runs asynchronously. To poll for status, use GetProspectingFromEngagementTask, or use ListProspectingFromEngagementTasks to monitor multiple tasks.
See also: AWS API Documentation
Request Syntax
client.start_prospecting_from_engagement_task(
Catalog='string',
Identifiers=[
'string',
],
TaskName='string',
ClientToken='string'
)
string
[REQUIRED]
Specifies the catalog in which the task is initiated. Specify AWS for production environments and Sandbox for testing and development purposes.
list
[REQUIRED]
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.
(string) --
string
[REQUIRED]
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.
string
[REQUIRED]
A unique, case-sensitive identifier provided by the client to ensure idempotency. Making the same request with the same ClientToken returns the same response without creating a duplicate task.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Identifiers': [
'string',
],
'TaskName': 'string',
'Message': 'string',
'ReasonCode': 'string',
'StartTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskStatus': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'
}
Response Structure
(dict) --
Represents the response structure returned when a prospecting task is successfully submitted. Contains the task identifier, ARN, and initial status. Uses TaskId with GetProspectingFromEngagementTask to poll for completion.
Identifiers (list) --
The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.
(string) --
TaskName (string) --
The task name from the request.
Message (string) --
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.
ReasonCode (string) --
An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding Message field for a human-readable description of the failure.
StartTime (datetime) --
The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
TaskId (string) --
The unique identifier assigned to this task. Use this identifier with GetProspectingFromEngagementTask to retrieve task details and check status.
TaskArn (string) --
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.
TaskStatus (string) --
The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).
Retrieves the details and current status of a prospecting task previously started with StartProspectingFromEngagementTask to enable polling for completion and access to per-engagement processing results.
See also: AWS API Documentation
Request Syntax
client.get_prospecting_from_engagement_task(
Catalog='string',
TaskIdentifier='string'
)
string
[REQUIRED]
Specifies the catalog associated with the task. Specify AWS for production environments and Sandbox for testing and development purposes. The value must match the catalog used when the task was created.
string
[REQUIRED]
The unique identifier of the prospecting task to retrieve. This value is returned in the TaskId field of the StartProspectingFromEngagementTask response.
dict
Response Syntax
{
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'Engagements': [
{
'EngagementIdentifier': 'string',
'EngagementContextId': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'ReasonCode': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Represents the response structure containing the full details of a prospecting task, including per-engagement processing results. Includes the Status field of each EngagementProspectingResult entry to determine individual outcomes.
TaskId (string) --
The unique identifier of the task.
TaskArn (string) --
The Amazon Resource Name (ARN) of the task.
TaskName (string) --
The descriptive name of the task that you provided when you created it.
StartTime (datetime) --
The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
EndTime (datetime) --
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.
Engagements (list) --
An array of EngagementProspectingResult 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.
(dict) --
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.
EngagementIdentifier (string) --
The unique identifier of the engagement that was processed.
EngagementContextId (string) --
The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations.
Status (string) --
The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.
ReasonCode (string) --
An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.
Message (string) --
A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.
{'Contexts': {'Payload': {'Lead': {'Insights': {'LeadReadinessScore': 'string'}},
'ProspectingResult': {'Aws': {'Customer': {'AccountName': 'string',
'CompanySize': 'string',
'Country': 'US '
'| '
'AF '
'| '
'AX '
'| '
'AL '
'| '
'DZ '
'| '
'AS '
'| '
'AD '
'| '
'AO '
'| '
'AI '
'| '
'AQ '
'| '
'AG '
'| '
'AR '
'| '
'AM '
'| '
'AW '
'| '
'AU '
'| '
'AT '
'| '
'AZ '
'| '
'BS '
'| '
'BH '
'| '
'BD '
'| '
'BB '
'| '
'BY '
'| '
'BE '
'| '
'BZ '
'| '
'BJ '
'| '
'BM '
'| '
'BT '
'| '
'BO '
'| '
'BQ '
'| '
'BA '
'| '
'BW '
'| '
'BV '
'| '
'BR '
'| '
'IO '
'| '
'BN '
'| '
'BG '
'| '
'BF '
'| '
'BI '
'| '
'KH '
'| '
'CM '
'| '
'CA '
'| '
'CV '
'| '
'KY '
'| '
'CF '
'| '
'TD '
'| '
'CL '
'| '
'CN '
'| '
'CX '
'| '
'CC '
'| '
'CO '
'| '
'KM '
'| '
'CG '
'| '
'CK '
'| '
'CR '
'| '
'CI '
'| '
'HR '
'| '
'CU '
'| '
'CW '
'| '
'CY '
'| '
'CZ '
'| '
'CD '
'| '
'DK '
'| '
'DJ '
'| '
'DM '
'| '
'DO '
'| '
'EC '
'| '
'EG '
'| '
'SV '
'| '
'GQ '
'| '
'ER '
'| '
'EE '
'| '
'ET '
'| '
'FK '
'| '
'FO '
'| '
'FJ '
'| '
'FI '
'| '
'FR '
'| '
'GF '
'| '
'PF '
'| '
'TF '
'| '
'GA '
'| '
'GM '
'| '
'GE '
'| '
'DE '
'| '
'GH '
'| '
'GI '
'| '
'GR '
'| '
'GL '
'| '
'GD '
'| '
'GP '
'| '
'GU '
'| '
'GT '
'| '
'GG '
'| '
'GN '
'| '
'GW '
'| '
'GY '
'| '
'HT '
'| '
'HM '
'| '
'VA '
'| '
'HN '
'| '
'HK '
'| '
'HU '
'| '
'IS '
'| '
'IN '
'| '
'ID '
'| '
'IR '
'| '
'IQ '
'| '
'IE '
'| '
'IM '
'| '
'IL '
'| '
'IT '
'| '
'JM '
'| '
'JP '
'| '
'JE '
'| '
'JO '
'| '
'KZ '
'| '
'KE '
'| '
'KI '
'| '
'KR '
'| '
'KW '
'| '
'KG '
'| '
'LA '
'| '
'LV '
'| '
'LB '
'| '
'LS '
'| '
'LR '
'| '
'LY '
'| '
'LI '
'| '
'LT '
'| '
'LU '
'| '
'MO '
'| '
'MK '
'| '
'MG '
'| '
'MW '
'| '
'MY '
'| '
'MV '
'| '
'ML '
'| '
'MT '
'| '
'MH '
'| '
'MQ '
'| '
'MR '
'| '
'MU '
'| '
'YT '
'| '
'MX '
'| '
'FM '
'| '
'MD '
'| '
'MC '
'| '
'MN '
'| '
'ME '
'| '
'MS '
'| '
'MA '
'| '
'MZ '
'| '
'MM '
'| '
'NA '
'| '
'NR '
'| '
'NP '
'| '
'NL '
'| '
'AN '
'| '
'NC '
'| '
'NZ '
'| '
'NI '
'| '
'NE '
'| '
'NG '
'| '
'NU '
'| '
'NF '
'| '
'MP '
'| '
'NO '
'| '
'OM '
'| '
'PK '
'| '
'PW '
'| '
'PS '
'| '
'PA '
'| '
'PG '
'| '
'PY '
'| '
'PE '
'| '
'PH '
'| '
'PN '
'| '
'PL '
'| '
'PT '
'| '
'PR '
'| '
'QA '
'| '
'RE '
'| '
'RO '
'| '
'RU '
'| '
'RW '
'| '
'BL '
'| '
'SH '
'| '
'KN '
'| '
'LC '
'| '
'MF '
'| '
'PM '
'| '
'VC '
'| '
'WS '
'| '
'SM '
'| '
'ST '
'| '
'SA '
'| '
'SN '
'| '
'RS '
'| '
'SC '
'| '
'SL '
'| '
'SG '
'| '
'SX '
'| '
'SK '
'| '
'SI '
'| '
'SB '
'| '
'SO '
'| '
'ZA '
'| '
'GS '
'| '
'SS '
'| '
'ES '
'| '
'LK '
'| '
'SD '
'| '
'SR '
'| '
'SJ '
'| '
'SZ '
'| '
'SE '
'| '
'CH '
'| '
'SY '
'| '
'TW '
'| '
'TJ '
'| '
'TZ '
'| '
'TH '
'| '
'TL '
'| '
'TG '
'| '
'TK '
'| '
'TO '
'| '
'TT '
'| '
'TN '
'| '
'TR '
'| '
'TM '
'| '
'TC '
'| '
'TV '
'| '
'UG '
'| '
'UA '
'| '
'AE '
'| '
'GB '
'| '
'UM '
'| '
'UY '
'| '
'UZ '
'| '
'VU '
'| '
'VE '
'| '
'VN '
'| '
'VG '
'| '
'VI '
'| '
'WF '
'| '
'EH '
'| '
'YE '
'| '
'ZM '
'| '
'ZW',
'EligiblePrograms': ['string'],
'Geo': 'string',
'Industry': 'Aerospace '
'| '
'Agriculture '
'| '
'Automotive '
'| '
'Computers '
'and '
'Electronics '
'| '
'Consumer '
'Goods '
'| '
'Education '
'| '
'Energy '
'- '
'Oil '
'and '
'Gas '
'| '
'Energy '
'- '
'Power '
'and '
'Utilities '
'| '
'Financial '
'Services '
'| '
'Gaming '
'| '
'Government '
'| '
'Healthcare '
'| '
'Hospitality '
'| '
'Life '
'Sciences '
'| '
'Manufacturing '
'| '
'Marketing '
'and '
'Advertising '
'| '
'Media '
'and '
'Entertainment '
'| '
'Mining '
'| '
'Non-Profit '
'Organization '
'| '
'Professional '
'Services '
'| '
'Real '
'Estate '
'and '
'Construction '
'| '
'Retail '
'| '
'Software '
'and '
'Internet '
'| '
'Telecommunications '
'| '
'Transportation '
'and '
'Logistics '
'| '
'Travel '
'| '
'Wholesale '
'and '
'Distribution '
'| '
'Other',
'PublicProfileSummary': 'string',
'Region': 'string',
'Segment': 'string',
'SubIndustry': 'string',
'SubRegion': 'string'},
'EndTime': 'timestamp',
'Insights': {'MarketplaceEngagementScore': 'string',
'SolutionCategory': 'string',
'SolutionScore': 'string',
'SolutionSubCategory': 'string'},
'StartTime': 'timestamp',
'TaskArn': 'string',
'TaskId': 'string',
'TaskName': 'string'}}},
'Type': {'ProspectingResult'}}}
The CreateEngagement action allows you to create an Engagement, which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. This action automatically adds the caller's AWS account as an active member of the newly created Engagement.
See also: AWS API Documentation
Request Syntax
client.create_engagement(
Catalog='string',
ClientToken='string',
Title='string',
Description='string',
Contexts=[
{
'Id': 'string',
'Type': 'CustomerProject'|'Lead'|'ProspectingResult',
'Payload': {
'CustomerProject': {
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'Title': 'string',
'BusinessProblem': 'string',
'TargetCompletionDate': 'string'
}
},
'Lead': {
'Insights': {
'LeadReadinessScore': 'string'
},
'QualificationStatus': 'string',
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'AwsMaturity': 'string',
'MarketSegment': 'Enterprise'|'Large'|'Medium'|'Small'|'Micro'
},
'Interactions': [
{
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'InteractionDate': datetime(2015, 1, 1),
'CustomerAction': 'string',
'BusinessProblem': 'string',
'Contact': {
'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'
}
},
]
},
'ProspectingResult': {
'Aws': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string',
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
}
}
}
}
},
]
)
string
[REQUIRED]
The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
string
[REQUIRED]
The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies the title of the Engagement.
string
[REQUIRED]
Provides a description of the Engagement.
list
The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.
(dict) --
Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.
Id (string) --
The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.
Type (string) -- [REQUIRED]
Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.
Payload (dict) --
Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
CustomerProject (dict) --
Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".
Customer (dict) --
Contains details about the customer associated with the Engagement Invitation, including company information and industry.
Industry (string) -- [REQUIRED]
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) -- [REQUIRED]
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) -- [REQUIRED]
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) -- [REQUIRED]
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Information about the customer project associated with the Engagement.
Title (string) -- [REQUIRED]
The title of the project.
BusinessProblem (string) -- [REQUIRED]
A description of the business problem the project aims to solve.
TargetCompletionDate (string) -- [REQUIRED]
The target completion date for the customer's project.
Lead (dict) --
Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".
Insights (dict) --
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.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
QualificationStatus (string) --
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.
Customer (dict) -- [REQUIRED]
Contains detailed information about the customer associated with the lead, including company information, contact details, and other relevant customer data.
Industry (string) --
Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
CompanyName (string) -- [REQUIRED]
The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
WebsiteUrl (string) --
The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
Address (dict) -- [REQUIRED]
An object that contains an Address object's subset of fields.
City (string) --
Specifies the end Customer's city associated with the Opportunity.
PostalCode (string) --
Specifies the end Customer's postal code associated with the Opportunity.
StateOrRegion (string) --
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
CountryCode (string) --
Specifies the end Customer's country associated with the Opportunity.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
MarketSegment (string) --
Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
Interactions (list) -- [REQUIRED]
An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
(dict) --
Represents a specific interaction or touchpoint with a lead customer. This structure captures details about communications, meetings, or other engagement activities that help track the lead's progression and engagement history.
SourceType (string) -- [REQUIRED]
Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
SourceId (string) -- [REQUIRED]
The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
SourceName (string) -- [REQUIRED]
The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
Usecase (string) --
Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
InteractionDate (datetime) --
The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
CustomerAction (string) -- [REQUIRED]
Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
BusinessProblem (string) --
Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
Contact (dict) -- [REQUIRED]
Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
BusinessTitle (string) -- [REQUIRED]
The lead contact's business title or job role associated with the engagement.
Email (string) -- [REQUIRED]
The lead contact's email address associated with the engagement.
FirstName (string) -- [REQUIRED]
The lead contact's first name associated with the engagement.
LastName (string) -- [REQUIRED]
The lead contact's last name associated with the engagement.
Phone (string) --
The lead contact's phone number associated with the engagement.
ProspectingResult (dict) --
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".
Aws (dict) --
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
StartTime (datetime) --
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
EndTime (datetime) --
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
TaskId (string) --
The unique identifier of the prospecting task that generates this result.
TaskArn (string) --
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
TaskName (string) --
The name that the user provides for the prospecting task that generates this result.
Customer (dict) --
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'ModifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Id (string) --
Unique identifier assigned to the newly created engagement.
Arn (string) --
The Amazon Resource Name (ARN) that identifies the engagement.
ModifiedAt (datetime) --
The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). For newly created engagements, this value matches the creation timestamp. Example: "2023-05-01T20:37:46Z".
{'Payload': {'Lead': {'Insights': {'LeadReadinessScore': 'string'}},
'ProspectingResult': {'Aws': {'Customer': {'AccountName': 'string',
'CompanySize': 'string',
'Country': 'US | AF | '
'AX | AL | '
'DZ | AS | '
'AD | AO | '
'AI | AQ | '
'AG | AR | '
'AM | AW | '
'AU | AT | '
'AZ | BS | '
'BH | BD | '
'BB | BY | '
'BE | BZ | '
'BJ | BM | '
'BT | BO | '
'BQ | BA | '
'BW | BV | '
'BR | IO | '
'BN | BG | '
'BF | BI | '
'KH | CM | '
'CA | CV | '
'KY | CF | '
'TD | CL | '
'CN | CX | '
'CC | CO | '
'KM | CG | '
'CK | CR | '
'CI | HR | '
'CU | CW | '
'CY | CZ | '
'CD | DK | '
'DJ | DM | '
'DO | EC | '
'EG | SV | '
'GQ | ER | '
'EE | ET | '
'FK | FO | '
'FJ | FI | '
'FR | GF | '
'PF | TF | '
'GA | GM | '
'GE | DE | '
'GH | GI | '
'GR | GL | '
'GD | GP | '
'GU | GT | '
'GG | GN | '
'GW | GY | '
'HT | HM | '
'VA | HN | '
'HK | HU | '
'IS | IN | '
'ID | IR | '
'IQ | IE | '
'IM | IL | '
'IT | JM | '
'JP | JE | '
'JO | KZ | '
'KE | KI | '
'KR | KW | '
'KG | LA | '
'LV | LB | '
'LS | LR | '
'LY | LI | '
'LT | LU | '
'MO | MK | '
'MG | MW | '
'MY | MV | '
'ML | MT | '
'MH | MQ | '
'MR | MU | '
'YT | MX | '
'FM | MD | '
'MC | MN | '
'ME | MS | '
'MA | MZ | '
'MM | NA | '
'NR | NP | '
'NL | AN | '
'NC | NZ | '
'NI | NE | '
'NG | NU | '
'NF | MP | '
'NO | OM | '
'PK | PW | '
'PS | PA | '
'PG | PY | '
'PE | PH | '
'PN | PL | '
'PT | PR | '
'QA | RE | '
'RO | RU | '
'RW | BL | '
'SH | KN | '
'LC | MF | '
'PM | VC | '
'WS | SM | '
'ST | SA | '
'SN | RS | '
'SC | SL | '
'SG | SX | '
'SK | SI | '
'SB | SO | '
'ZA | GS | '
'SS | ES | '
'LK | SD | '
'SR | SJ | '
'SZ | SE | '
'CH | SY | '
'TW | TJ | '
'TZ | TH | '
'TL | TG | '
'TK | TO | '
'TT | TN | '
'TR | TM | '
'TC | TV | '
'UG | UA | '
'AE | GB | '
'UM | UY | '
'UZ | VU | '
'VE | VN | '
'VG | VI | '
'WF | EH | '
'YE | ZM | '
'ZW',
'EligiblePrograms': ['string'],
'Geo': 'string',
'Industry': 'Aerospace '
'| '
'Agriculture '
'| '
'Automotive '
'| '
'Computers '
'and '
'Electronics '
'| '
'Consumer '
'Goods | '
'Education '
'| Energy '
'- Oil and '
'Gas | '
'Energy - '
'Power and '
'Utilities '
'| '
'Financial '
'Services '
'| Gaming '
'| '
'Government '
'| '
'Healthcare '
'| '
'Hospitality '
'| Life '
'Sciences '
'| '
'Manufacturing '
'| '
'Marketing '
'and '
'Advertising '
'| Media '
'and '
'Entertainment '
'| Mining '
'| '
'Non-Profit '
'Organization '
'| '
'Professional '
'Services '
'| Real '
'Estate '
'and '
'Construction '
'| Retail '
'| '
'Software '
'and '
'Internet '
'| '
'Telecommunications '
'| '
'Transportation '
'and '
'Logistics '
'| Travel '
'| '
'Wholesale '
'and '
'Distribution '
'| Other',
'PublicProfileSummary': 'string',
'Region': 'string',
'Segment': 'string',
'SubIndustry': 'string',
'SubRegion': 'string'},
'EndTime': 'timestamp',
'Insights': {'MarketplaceEngagementScore': 'string',
'SolutionCategory': 'string',
'SolutionScore': 'string',
'SolutionSubCategory': 'string'},
'StartTime': 'timestamp',
'TaskArn': 'string',
'TaskId': 'string',
'TaskName': 'string'}}},
'Type': {'ProspectingResult'}}
Creates a new context within an existing engagement. This action allows you to add contextual information such as customer projects or documents to an engagement, providing additional details that help facilitate collaboration between engagement members.
See also: AWS API Documentation
Request Syntax
client.create_engagement_context(
Catalog='string',
EngagementIdentifier='string',
ClientToken='string',
Type='CustomerProject'|'Lead'|'ProspectingResult',
Payload={
'CustomerProject': {
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'Title': 'string',
'BusinessProblem': 'string',
'TargetCompletionDate': 'string'
}
},
'Lead': {
'Insights': {
'LeadReadinessScore': 'string'
},
'QualificationStatus': 'string',
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'AwsMaturity': 'string',
'MarketSegment': 'Enterprise'|'Large'|'Medium'|'Small'|'Micro'
},
'Interactions': [
{
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'InteractionDate': datetime(2015, 1, 1),
'CustomerAction': 'string',
'BusinessProblem': 'string',
'Contact': {
'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'
}
},
]
},
'ProspectingResult': {
'Aws': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string',
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
}
}
}
}
)
string
[REQUIRED]
Specifies the catalog associated with the engagement context request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is created in. Use AWS to create contexts in the production environment, and Sandbox for testing in secure, isolated environments.
string
[REQUIRED]
The unique identifier of the Engagement for which the context is being created. This parameter ensures the context is associated with the correct engagement and provides the necessary linkage between the engagement and its contextual information.
string
[REQUIRED]
A unique, case-sensitive identifier provided by the client to ensure that the request is handled exactly once. This token helps prevent duplicate context creations and must not exceed sixty-four alphanumeric characters. Use a UUID or other unique string to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include CustomerProject for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.
dict
[REQUIRED]
Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails.
CustomerProject (dict) --
Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".
Customer (dict) --
Contains details about the customer associated with the Engagement Invitation, including company information and industry.
Industry (string) -- [REQUIRED]
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) -- [REQUIRED]
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) -- [REQUIRED]
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) -- [REQUIRED]
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Information about the customer project associated with the Engagement.
Title (string) -- [REQUIRED]
The title of the project.
BusinessProblem (string) -- [REQUIRED]
A description of the business problem the project aims to solve.
TargetCompletionDate (string) -- [REQUIRED]
The target completion date for the customer's project.
Lead (dict) --
Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".
Insights (dict) --
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.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
QualificationStatus (string) --
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.
Customer (dict) -- [REQUIRED]
Contains detailed information about the customer associated with the lead, including company information, contact details, and other relevant customer data.
Industry (string) --
Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
CompanyName (string) -- [REQUIRED]
The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
WebsiteUrl (string) --
The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
Address (dict) -- [REQUIRED]
An object that contains an Address object's subset of fields.
City (string) --
Specifies the end Customer's city associated with the Opportunity.
PostalCode (string) --
Specifies the end Customer's postal code associated with the Opportunity.
StateOrRegion (string) --
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
CountryCode (string) --
Specifies the end Customer's country associated with the Opportunity.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
MarketSegment (string) --
Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
Interactions (list) -- [REQUIRED]
An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
(dict) --
Represents a specific interaction or touchpoint with a lead customer. This structure captures details about communications, meetings, or other engagement activities that help track the lead's progression and engagement history.
SourceType (string) -- [REQUIRED]
Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
SourceId (string) -- [REQUIRED]
The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
SourceName (string) -- [REQUIRED]
The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
Usecase (string) --
Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
InteractionDate (datetime) --
The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
CustomerAction (string) -- [REQUIRED]
Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
BusinessProblem (string) --
Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
Contact (dict) -- [REQUIRED]
Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
BusinessTitle (string) -- [REQUIRED]
The lead contact's business title or job role associated with the engagement.
Email (string) -- [REQUIRED]
The lead contact's email address associated with the engagement.
FirstName (string) -- [REQUIRED]
The lead contact's first name associated with the engagement.
LastName (string) -- [REQUIRED]
The lead contact's last name associated with the engagement.
Phone (string) --
The lead contact's phone number associated with the engagement.
ProspectingResult (dict) --
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".
Aws (dict) --
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
StartTime (datetime) --
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
EndTime (datetime) --
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
TaskId (string) --
The unique identifier of the prospecting task that generates this result.
TaskArn (string) --
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
TaskName (string) --
The name that the user provides for the prospecting task that generates this result.
Customer (dict) --
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
dict
Response Syntax
{
'EngagementId': 'string',
'EngagementArn': 'string',
'EngagementLastModifiedAt': datetime(2015, 1, 1),
'ContextId': 'string'
}
Response Structure
(dict) --
EngagementId (string) --
The unique identifier of the engagement to which the context was added. This ID confirms the successful association of the context with the specified engagement.
EngagementArn (string) --
The Amazon Resource Name (ARN) of the engagement to which the context was added. This globally unique identifier can be used for cross-service references and IAM policies.
EngagementLastModifiedAt (datetime) --
The timestamp indicating when the engagement was last modified as a result of adding the context, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".
ContextId (string) --
The unique identifier assigned to the newly created engagement context. This ID can be used to reference the specific context within the engagement for future operations.
{'CosellMotion': 'string',
'Insights': {'OpportunityQuality': {'Score': 'integer', 'Trend': 'string'},
'Recommendations': [{'Attributes': {'string': 'string'},
'Details': 'string',
'Type': 'string'}]}}
Retrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity sourced from AWS, such as lifecycle information, customer details, and involvement type. It is useful for tracking updates on the AWS opportunity corresponding to an opportunity in the partner's account.
See also: AWS API Documentation
Request Syntax
client.get_aws_opportunity_summary(
Catalog='string',
RelatedOpportunityIdentifier='string'
)
string
[REQUIRED]
Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.
string
[REQUIRED]
The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.
dict
Response Syntax
{
'RelatedOpportunityId': 'string',
'Origin': 'AWS Referral'|'Partner Referral',
'InvolvementType': 'For Visibility Only'|'Co-Sell',
'Visibility': 'Full'|'Limited',
'LifeCycle': {
'TargetCloseDate': 'string',
'ClosedLostReason': 'Administrative'|'Business Associate Agreement'|'Company Acquired/Dissolved'|'Competitive Offering'|'Customer Data Requirement'|'Customer Deficiency'|'Customer Experience'|'Delay / Cancellation of Project'|'Duplicate'|'Duplicate Opportunity'|'Executive Blocker'|'Failed Vetting'|'Feature Limitation'|'Financial/Commercial'|'Insufficient Amazon Value'|'Insufficient AWS Value'|'International Constraints'|'Legal / Tax / Regulatory'|'Legal Terms and Conditions'|'Lost to Competitor'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - Other'|'Lost to Competitor - Rackspace'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'No Customer Reference'|'No Integration Resources'|'No Opportunity'|'No Perceived Value of MP'|'No Response'|'Not Committed to AWS'|'No Update'|'On Premises Deployment'|'Other'|'Other (Details in Description)'|'Partner Gap'|'Past Due'|'People/Relationship/Governance'|'Platform Technology Limitation'|'Preference for Competitor'|'Price'|'Product/Technology'|'Product Not on AWS'|'Security / Compliance'|'Self-Service'|'Technical Limitations'|'Term Sheet Impasse',
'Stage': 'Not Started'|'In Progress'|'Prospect'|'Engaged'|'Identified'|'Qualify'|'Research'|'Seller Engaged'|'Evaluating'|'Seller Registered'|'Term Sheet Negotiation'|'Contract Negotiation'|'Onboarding'|'Building Integration'|'Qualified'|'On-hold'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Deferred to Partner'|'Closed Lost'|'Completed'|'Closed Incomplete',
'NextSteps': 'string',
'NextStepsHistory': [
{
'Value': 'string',
'Time': datetime(2015, 1, 1)
},
]
},
'OpportunityTeam': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'AWSSalesRep'|'AWSAccountOwner'|'WWPSPDM'|'PDM'|'PSM'|'ISVSM'
},
],
'Insights': {
'NextBestActions': 'string',
'EngagementScore': 'High'|'Medium'|'Low',
'AwsProductsSpendInsightsBySource': {
'Partner': {
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TotalAmount': 'string',
'TotalOptimizedAmount': 'string',
'TotalPotentialSavingsAmount': 'string',
'TotalAmountByCategory': {
'string': 'string'
},
'AwsProducts': [
{
'ProductCode': 'string',
'ServiceCode': 'string',
'Categories': [
'string',
],
'Amount': 'string',
'OptimizedAmount': 'string',
'PotentialSavingsAmount': 'string',
'Optimizations': [
{
'Description': 'string',
'SavingsAmount': 'string'
},
]
},
]
},
'AWS': {
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TotalAmount': 'string',
'TotalOptimizedAmount': 'string',
'TotalPotentialSavingsAmount': 'string',
'TotalAmountByCategory': {
'string': 'string'
},
'AwsProducts': [
{
'ProductCode': 'string',
'ServiceCode': 'string',
'Categories': [
'string',
],
'Amount': 'string',
'OptimizedAmount': 'string',
'PotentialSavingsAmount': 'string',
'Optimizations': [
{
'Description': 'string',
'SavingsAmount': 'string'
},
]
},
]
}
},
'OpportunityQuality': {
'Score': 123,
'Trend': 'string'
},
'Recommendations': [
{
'Type': 'string',
'Details': 'string',
'Attributes': {
'string': 'string'
}
},
]
},
'InvolvementTypeChangeReason': 'Expansion Opportunity'|'Change in Deal Information'|'Customer Requested'|'Technical Complexity'|'Risk Mitigation',
'RelatedEntityIds': {
'AwsProducts': [
'string',
],
'Solutions': [
'string',
]
},
'Customer': {
'Contacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
]
},
'Project': {
'ExpectedCustomerSpend': [
{
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TargetCompany': 'string',
'EstimationUrl': 'string'
},
],
'AwsPartition': 'aws-eusc'
},
'CosellMotion': 'string',
'Catalog': 'string'
}
Response Structure
(dict) --
RelatedOpportunityId (string) --
Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.
Origin (string) --
Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.
InvolvementType (string) --
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.
Visibility (string) --
Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.
LifeCycle (dict) --
Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.
TargetCloseDate (string) --
Indicates the expected date by which the opportunity is projected to close. This field helps in planning resources and timelines for both the partner and AWS.
ClosedLostReason (string) --
Indicates the reason why an opportunity was marked as Closed Lost. This helps in understanding the context behind the lost opportunity and aids in refining future strategies.
Stage (string) --
Represents the current stage of the opportunity in its lifecycle, such as Qualification, Validation, or Closed Won. This helps in understanding the opportunity's progress.
NextSteps (string) --
Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.
NextStepsHistory (list) --
Provides a historical log of previous next steps that were taken to move the opportunity forward. This helps in tracking the decision-making process and identifying any delays or obstacles encountered.
(dict) --
Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.
Value (string) --
Represents the details of the next step recorded, such as follow-up actions or decisions made. This field helps in tracking progress and ensuring alignment with project goals.
Time (datetime) --
Indicates the date and time when a particular next step was recorded or planned. This helps in managing the timeline for the opportunity.
OpportunityTeam (list) --
Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.
(dict) --
Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.
Email (string) --
Provides the Amazon Web Services team member's email address.
FirstName (string) --
Provides the Amazon Web Services team member's first name.
LastName (string) --
Provides the Amazon Web Services team member's last name.
BusinessTitle (string) --
Specifies the Amazon Web Services team member's business title and indicates their organizational role.
Insights (dict) --
Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.
NextBestActions (string) --
Provides recommendations from AWS on the next best actions to take in order to move the opportunity forward and increase the likelihood of success.
EngagementScore (string) --
Represents a score assigned by AWS to indicate the level of engagement and potential success for the opportunity. This score helps partners prioritize their efforts.
AwsProductsSpendInsightsBySource (dict) --
Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates.
Partner (dict) --
Partner-sourced insights derived from Pricing Calculator URLs.
CurrencyCode (string) --
ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
Frequency (string) --
Time period for spend amounts.
TotalAmount (string) --
Total estimated spend for this source before optimizations.
TotalOptimizedAmount (string) --
Total estimated spend after applying recommended optimizations.
TotalPotentialSavingsAmount (string) --
Quantified savings achievable through implementing optimizations.
TotalAmountByCategory (dict) --
Spend amounts mapped to AWS programs and modernization pathways.
(string) --
(string) --
AwsProducts (list) --
Product-level details including costs and optimization recommendations.
(dict) --
List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
ProductCode (string) --
AWS Partner Central product identifier used for opportunity association.
ServiceCode (string) --
Pricing Calculator service code.
Categories (list) --
List of program and pathway categories this product is eligible for.
(string) --
Amount (string) --
Baseline service cost before optimizations.
OptimizedAmount (string) --
Service cost after applying optimizations.
PotentialSavingsAmount (string) --
Service-specific cost reduction through optimizations.
Optimizations (list) --
List of specific optimization recommendations for this product.
(dict) --
Specific optimization strategies partners can implement to reduce costs.
Description (string) --
Human-readable explanation of the optimization strategy.
SavingsAmount (string) --
Quantified cost savings achievable by implementing this optimization.
AWS (dict) --
AI-generated insights including recommended products from AWS.
CurrencyCode (string) --
ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
Frequency (string) --
Time period for spend amounts.
TotalAmount (string) --
Total estimated spend for this source before optimizations.
TotalOptimizedAmount (string) --
Total estimated spend after applying recommended optimizations.
TotalPotentialSavingsAmount (string) --
Quantified savings achievable through implementing optimizations.
TotalAmountByCategory (dict) --
Spend amounts mapped to AWS programs and modernization pathways.
(string) --
(string) --
AwsProducts (list) --
Product-level details including costs and optimization recommendations.
(dict) --
List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
ProductCode (string) --
AWS Partner Central product identifier used for opportunity association.
ServiceCode (string) --
Pricing Calculator service code.
Categories (list) --
List of program and pathway categories this product is eligible for.
(string) --
Amount (string) --
Baseline service cost before optimizations.
OptimizedAmount (string) --
Service cost after applying optimizations.
PotentialSavingsAmount (string) --
Service-specific cost reduction through optimizations.
Optimizations (list) --
List of specific optimization recommendations for this product.
(dict) --
Specific optimization strategies partners can implement to reduce costs.
Description (string) --
Human-readable explanation of the optimization strategy.
SavingsAmount (string) --
Quantified cost savings achievable by implementing this optimization.
OpportunityQuality (dict) --
Opportunity quality assessment. Null if not yet scored.
Score (integer) --
Deal quality score based on opportunity content completeness and sales methodology criteria. Values range from 0 to 100.
Trend (string) --
Direction of score change since last scoring iteration. Known values: Improving, Declining, No Change.
Recommendations (list) --
List of recommendations from various agent-driven sources.
(dict) --
A recommendation from an agent-driven source.
Type (string) --
The recommendation source type. Known values: OpportunityQuality, SolutionRecommendation, SpecialistRecommendation.
Details (string) --
Human-readable recommendation text from this source.
Attributes (dict) --
Source-specific metadata as key-value pairs.
(string) --
(string) --
InvolvementTypeChangeReason (string) --
Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.
RelatedEntityIds (dict) --
Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.
AwsProducts (list) --
Specifies the AWS products associated with the opportunity. This field helps track the specific products that are part of the proposed solution.
(string) --
Solutions (list) --
Specifies the partner solutions related to the opportunity. These solutions represent the partner's offerings that are being positioned as part of the overall AWS opportunity.
(string) --
Customer (dict) --
Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other customer data. These details help partners understand the business context of the opportunity.
Contacts (list) --
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.
(dict) --
An object that contains a Customer Partner's contact details.
Email (string) --
The contact's email address associated with the Opportunity.
FirstName (string) --
The contact's first name associated with the Opportunity.
LastName (string) --
The contact's last name associated with the Opportunity.
BusinessTitle (string) --
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
Phone (string) --
The contact's phone number associated with the Opportunity.
Project (dict) --
Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.
ExpectedCustomerSpend (list) --
Indicates the expected spending by the customer over the course of the project. This value helps partners and AWS estimate the financial impact of the opportunity. Use the AWS Pricing Calculator to create an estimate of the customer’s total spend. If only annual recurring revenue (ARR) is available, distribute it across 12 months to provide an average monthly value.
(dict) --
Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.
Amount (string) --
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
CurrencyCode (string) --
Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).
TargetCompany (string) --
Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
AwsPartition (string) --
AWS partition where the opportunity will be deployed. Possible values: aws-eusc for AWS European Sovereign Cloud, null for all other partitions.
CosellMotion (string) --
Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led.
Catalog (string) --
Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.
{'Contexts': {'Payload': {'Lead': {'Insights': {'LeadReadinessScore': 'string'}},
'ProspectingResult': {'Aws': {'Customer': {'AccountName': 'string',
'CompanySize': 'string',
'Country': 'US '
'| '
'AF '
'| '
'AX '
'| '
'AL '
'| '
'DZ '
'| '
'AS '
'| '
'AD '
'| '
'AO '
'| '
'AI '
'| '
'AQ '
'| '
'AG '
'| '
'AR '
'| '
'AM '
'| '
'AW '
'| '
'AU '
'| '
'AT '
'| '
'AZ '
'| '
'BS '
'| '
'BH '
'| '
'BD '
'| '
'BB '
'| '
'BY '
'| '
'BE '
'| '
'BZ '
'| '
'BJ '
'| '
'BM '
'| '
'BT '
'| '
'BO '
'| '
'BQ '
'| '
'BA '
'| '
'BW '
'| '
'BV '
'| '
'BR '
'| '
'IO '
'| '
'BN '
'| '
'BG '
'| '
'BF '
'| '
'BI '
'| '
'KH '
'| '
'CM '
'| '
'CA '
'| '
'CV '
'| '
'KY '
'| '
'CF '
'| '
'TD '
'| '
'CL '
'| '
'CN '
'| '
'CX '
'| '
'CC '
'| '
'CO '
'| '
'KM '
'| '
'CG '
'| '
'CK '
'| '
'CR '
'| '
'CI '
'| '
'HR '
'| '
'CU '
'| '
'CW '
'| '
'CY '
'| '
'CZ '
'| '
'CD '
'| '
'DK '
'| '
'DJ '
'| '
'DM '
'| '
'DO '
'| '
'EC '
'| '
'EG '
'| '
'SV '
'| '
'GQ '
'| '
'ER '
'| '
'EE '
'| '
'ET '
'| '
'FK '
'| '
'FO '
'| '
'FJ '
'| '
'FI '
'| '
'FR '
'| '
'GF '
'| '
'PF '
'| '
'TF '
'| '
'GA '
'| '
'GM '
'| '
'GE '
'| '
'DE '
'| '
'GH '
'| '
'GI '
'| '
'GR '
'| '
'GL '
'| '
'GD '
'| '
'GP '
'| '
'GU '
'| '
'GT '
'| '
'GG '
'| '
'GN '
'| '
'GW '
'| '
'GY '
'| '
'HT '
'| '
'HM '
'| '
'VA '
'| '
'HN '
'| '
'HK '
'| '
'HU '
'| '
'IS '
'| '
'IN '
'| '
'ID '
'| '
'IR '
'| '
'IQ '
'| '
'IE '
'| '
'IM '
'| '
'IL '
'| '
'IT '
'| '
'JM '
'| '
'JP '
'| '
'JE '
'| '
'JO '
'| '
'KZ '
'| '
'KE '
'| '
'KI '
'| '
'KR '
'| '
'KW '
'| '
'KG '
'| '
'LA '
'| '
'LV '
'| '
'LB '
'| '
'LS '
'| '
'LR '
'| '
'LY '
'| '
'LI '
'| '
'LT '
'| '
'LU '
'| '
'MO '
'| '
'MK '
'| '
'MG '
'| '
'MW '
'| '
'MY '
'| '
'MV '
'| '
'ML '
'| '
'MT '
'| '
'MH '
'| '
'MQ '
'| '
'MR '
'| '
'MU '
'| '
'YT '
'| '
'MX '
'| '
'FM '
'| '
'MD '
'| '
'MC '
'| '
'MN '
'| '
'ME '
'| '
'MS '
'| '
'MA '
'| '
'MZ '
'| '
'MM '
'| '
'NA '
'| '
'NR '
'| '
'NP '
'| '
'NL '
'| '
'AN '
'| '
'NC '
'| '
'NZ '
'| '
'NI '
'| '
'NE '
'| '
'NG '
'| '
'NU '
'| '
'NF '
'| '
'MP '
'| '
'NO '
'| '
'OM '
'| '
'PK '
'| '
'PW '
'| '
'PS '
'| '
'PA '
'| '
'PG '
'| '
'PY '
'| '
'PE '
'| '
'PH '
'| '
'PN '
'| '
'PL '
'| '
'PT '
'| '
'PR '
'| '
'QA '
'| '
'RE '
'| '
'RO '
'| '
'RU '
'| '
'RW '
'| '
'BL '
'| '
'SH '
'| '
'KN '
'| '
'LC '
'| '
'MF '
'| '
'PM '
'| '
'VC '
'| '
'WS '
'| '
'SM '
'| '
'ST '
'| '
'SA '
'| '
'SN '
'| '
'RS '
'| '
'SC '
'| '
'SL '
'| '
'SG '
'| '
'SX '
'| '
'SK '
'| '
'SI '
'| '
'SB '
'| '
'SO '
'| '
'ZA '
'| '
'GS '
'| '
'SS '
'| '
'ES '
'| '
'LK '
'| '
'SD '
'| '
'SR '
'| '
'SJ '
'| '
'SZ '
'| '
'SE '
'| '
'CH '
'| '
'SY '
'| '
'TW '
'| '
'TJ '
'| '
'TZ '
'| '
'TH '
'| '
'TL '
'| '
'TG '
'| '
'TK '
'| '
'TO '
'| '
'TT '
'| '
'TN '
'| '
'TR '
'| '
'TM '
'| '
'TC '
'| '
'TV '
'| '
'UG '
'| '
'UA '
'| '
'AE '
'| '
'GB '
'| '
'UM '
'| '
'UY '
'| '
'UZ '
'| '
'VU '
'| '
'VE '
'| '
'VN '
'| '
'VG '
'| '
'VI '
'| '
'WF '
'| '
'EH '
'| '
'YE '
'| '
'ZM '
'| '
'ZW',
'EligiblePrograms': ['string'],
'Geo': 'string',
'Industry': 'Aerospace '
'| '
'Agriculture '
'| '
'Automotive '
'| '
'Computers '
'and '
'Electronics '
'| '
'Consumer '
'Goods '
'| '
'Education '
'| '
'Energy '
'- '
'Oil '
'and '
'Gas '
'| '
'Energy '
'- '
'Power '
'and '
'Utilities '
'| '
'Financial '
'Services '
'| '
'Gaming '
'| '
'Government '
'| '
'Healthcare '
'| '
'Hospitality '
'| '
'Life '
'Sciences '
'| '
'Manufacturing '
'| '
'Marketing '
'and '
'Advertising '
'| '
'Media '
'and '
'Entertainment '
'| '
'Mining '
'| '
'Non-Profit '
'Organization '
'| '
'Professional '
'Services '
'| '
'Real '
'Estate '
'and '
'Construction '
'| '
'Retail '
'| '
'Software '
'and '
'Internet '
'| '
'Telecommunications '
'| '
'Transportation '
'and '
'Logistics '
'| '
'Travel '
'| '
'Wholesale '
'and '
'Distribution '
'| '
'Other',
'PublicProfileSummary': 'string',
'Region': 'string',
'Segment': 'string',
'SubIndustry': 'string',
'SubRegion': 'string'},
'EndTime': 'timestamp',
'Insights': {'MarketplaceEngagementScore': 'string',
'SolutionCategory': 'string',
'SolutionScore': 'string',
'SolutionSubCategory': 'string'},
'StartTime': 'timestamp',
'TaskArn': 'string',
'TaskId': 'string',
'TaskName': 'string'}}},
'Type': {'ProspectingResult'}}}
Use this action to retrieve the engagement record for a given EngagementIdentifier.
See also: AWS API Documentation
Request Syntax
client.get_engagement(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.
string
[REQUIRED]
Specifies the identifier of the Engagement record to retrieve.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'Title': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'MemberCount': 123,
'ModifiedAt': datetime(2015, 1, 1),
'ModifiedBy': 'string',
'Contexts': [
{
'Id': 'string',
'Type': 'CustomerProject'|'Lead'|'ProspectingResult',
'Payload': {
'CustomerProject': {
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'Title': 'string',
'BusinessProblem': 'string',
'TargetCompletionDate': 'string'
}
},
'Lead': {
'Insights': {
'LeadReadinessScore': 'string'
},
'QualificationStatus': 'string',
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'AwsMaturity': 'string',
'MarketSegment': 'Enterprise'|'Large'|'Medium'|'Small'|'Micro'
},
'Interactions': [
{
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'InteractionDate': datetime(2015, 1, 1),
'CustomerAction': 'string',
'BusinessProblem': 'string',
'Contact': {
'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'
}
},
]
},
'ProspectingResult': {
'Aws': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string',
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
}
}
}
}
},
]
}
Response Structure
(dict) --
Id (string) --
The unique resource identifier of the engagement retrieved.
Arn (string) --
The Amazon Resource Name (ARN) of the engagement retrieved.
Title (string) --
The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.
Description (string) --
A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.
CreatedAt (datetime) --
The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.
CreatedBy (string) --
The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.
MemberCount (integer) --
Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.
ModifiedAt (datetime) --
The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z". This helps track the most recent changes to the engagement.
ModifiedBy (string) --
The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.
Contexts (list) --
A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.
(dict) --
Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.
Id (string) --
The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.
Type (string) --
Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.
Payload (dict) --
Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
CustomerProject (dict) --
Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".
Customer (dict) --
Contains details about the customer associated with the Engagement Invitation, including company information and industry.
Industry (string) --
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) --
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) --
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) --
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Information about the customer project associated with the Engagement.
Title (string) --
The title of the project.
BusinessProblem (string) --
A description of the business problem the project aims to solve.
TargetCompletionDate (string) --
The target completion date for the customer's project.
Lead (dict) --
Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".
Insights (dict) --
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.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
QualificationStatus (string) --
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.
Customer (dict) --
Contains detailed information about the customer associated with the lead, including company information, contact details, and other relevant customer data.
Industry (string) --
Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
CompanyName (string) --
The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
WebsiteUrl (string) --
The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
Address (dict) --
An object that contains an Address object's subset of fields.
City (string) --
Specifies the end Customer's city associated with the Opportunity.
PostalCode (string) --
Specifies the end Customer's postal code associated with the Opportunity.
StateOrRegion (string) --
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
CountryCode (string) --
Specifies the end Customer's country associated with the Opportunity.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
MarketSegment (string) --
Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
Interactions (list) --
An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
(dict) --
Represents a specific interaction or touchpoint with a lead customer. This structure captures details about communications, meetings, or other engagement activities that help track the lead's progression and engagement history.
SourceType (string) --
Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
SourceId (string) --
The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
SourceName (string) --
The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
Usecase (string) --
Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
InteractionDate (datetime) --
The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
CustomerAction (string) --
Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
BusinessProblem (string) --
Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
Contact (dict) --
Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
BusinessTitle (string) --
The lead contact's business title or job role associated with the engagement.
Email (string) --
The lead contact's email address associated with the engagement.
FirstName (string) --
The lead contact's first name associated with the engagement.
LastName (string) --
The lead contact's last name associated with the engagement.
Phone (string) --
The lead contact's phone number associated with the engagement.
ProspectingResult (dict) --
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".
Aws (dict) --
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
StartTime (datetime) --
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
EndTime (datetime) --
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
TaskId (string) --
The unique identifier of the prospecting task that generates this result.
TaskArn (string) --
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
TaskName (string) --
The name that the user provides for the prospecting task that generates this result.
Customer (dict) --
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
{'Payload': {'AwsOpportunitySummaryFullView': {'CosellMotion': 'string',
'Insights': {'OpportunityQuality': {'Score': 'integer',
'Trend': 'string'},
'Recommendations': [{'Attributes': {'string': 'string'},
'Details': 'string',
'Type': 'string'}]}}}}
Use this action to retrieve a specific snapshot record.
See also: AWS API Documentation
Request Syntax
client.get_resource_snapshot(
Catalog='string',
EngagementIdentifier='string',
ResourceType='Opportunity',
ResourceIdentifier='string',
ResourceSnapshotTemplateIdentifier='string',
Revision=123
)
string
[REQUIRED]
Specifies the catalog related to the request. Valid values are:
AWS: Retrieves the snapshot from the production AWS environment.
Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.
string
[REQUIRED]
The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.
string
[REQUIRED]
Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes: Opportunity: For opportunity-related data.
string
[REQUIRED]
The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID
string
[REQUIRED]
he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.
integer
Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.
dict
Response Syntax
{
'Catalog': 'string',
'Arn': 'string',
'CreatedBy': 'string',
'CreatedAt': datetime(2015, 1, 1),
'EngagementId': 'string',
'ResourceType': 'Opportunity',
'ResourceId': 'string',
'ResourceSnapshotTemplateName': 'string',
'Revision': 123,
'Payload': {
'OpportunitySummary': {
'OpportunityType': 'Net New Business'|'Flat Renewal'|'Expansion',
'Lifecycle': {
'TargetCloseDate': 'string',
'ReviewStatus': 'Pending Submission'|'Submitted'|'In review'|'Approved'|'Rejected'|'Action Required',
'Stage': 'Prospect'|'Qualified'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Closed Lost',
'NextSteps': 'string'
},
'OpportunityTeam': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
'PrimaryNeedsFromAws': [
'Co-Sell - Architectural Validation'|'Co-Sell - Business Presentation'|'Co-Sell - Competitive Information'|'Co-Sell - Pricing Assistance'|'Co-Sell - Technical Consultation'|'Co-Sell - Total Cost of Ownership Evaluation'|'Co-Sell - Deal Support'|'Co-Sell - Support for Public Tender / RFx',
],
'Customer': {
'Account': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'OtherIndustry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'AwsAccountId': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'StreetAddress': 'string'
},
'Duns': 'string'
},
'Contacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
]
},
'Project': {
'DeliveryModels': [
'SaaS or PaaS'|'BYOL or AMI'|'Managed Services'|'Professional Services'|'Resell'|'Other',
],
'ExpectedCustomerSpend': [
{
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TargetCompany': 'string',
'EstimationUrl': 'string'
},
],
'ExpectedContractDuration': {
'Term': 'Months',
'Value': 'string'
},
'CustomerUseCase': 'string',
'SalesActivities': [
'Initialized discussions with customer'|'Customer has shown interest in solution'|'Conducted POC / Demo'|'In evaluation / planning stage'|'Agreed on solution to Business Problem'|'Completed Action Plan'|'Finalized Deployment Need'|'SOW Signed',
],
'OtherSolutionDescription': 'string'
},
'RelatedEntityIdentifiers': {
'AwsMarketplaceOffers': [
'string',
],
'AwsMarketplaceOfferSets': [
'string',
],
'Solutions': [
'string',
],
'AwsProducts': [
'string',
]
}
},
'AwsOpportunitySummaryFullView': {
'RelatedOpportunityId': 'string',
'Origin': 'AWS Referral'|'Partner Referral',
'InvolvementType': 'For Visibility Only'|'Co-Sell',
'Visibility': 'Full'|'Limited',
'LifeCycle': {
'TargetCloseDate': 'string',
'ClosedLostReason': 'Administrative'|'Business Associate Agreement'|'Company Acquired/Dissolved'|'Competitive Offering'|'Customer Data Requirement'|'Customer Deficiency'|'Customer Experience'|'Delay / Cancellation of Project'|'Duplicate'|'Duplicate Opportunity'|'Executive Blocker'|'Failed Vetting'|'Feature Limitation'|'Financial/Commercial'|'Insufficient Amazon Value'|'Insufficient AWS Value'|'International Constraints'|'Legal / Tax / Regulatory'|'Legal Terms and Conditions'|'Lost to Competitor'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - Other'|'Lost to Competitor - Rackspace'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'No Customer Reference'|'No Integration Resources'|'No Opportunity'|'No Perceived Value of MP'|'No Response'|'Not Committed to AWS'|'No Update'|'On Premises Deployment'|'Other'|'Other (Details in Description)'|'Partner Gap'|'Past Due'|'People/Relationship/Governance'|'Platform Technology Limitation'|'Preference for Competitor'|'Price'|'Product/Technology'|'Product Not on AWS'|'Security / Compliance'|'Self-Service'|'Technical Limitations'|'Term Sheet Impasse',
'Stage': 'Not Started'|'In Progress'|'Prospect'|'Engaged'|'Identified'|'Qualify'|'Research'|'Seller Engaged'|'Evaluating'|'Seller Registered'|'Term Sheet Negotiation'|'Contract Negotiation'|'Onboarding'|'Building Integration'|'Qualified'|'On-hold'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Deferred to Partner'|'Closed Lost'|'Completed'|'Closed Incomplete',
'NextSteps': 'string',
'NextStepsHistory': [
{
'Value': 'string',
'Time': datetime(2015, 1, 1)
},
]
},
'OpportunityTeam': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'AWSSalesRep'|'AWSAccountOwner'|'WWPSPDM'|'PDM'|'PSM'|'ISVSM'
},
],
'Insights': {
'NextBestActions': 'string',
'EngagementScore': 'High'|'Medium'|'Low',
'AwsProductsSpendInsightsBySource': {
'Partner': {
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TotalAmount': 'string',
'TotalOptimizedAmount': 'string',
'TotalPotentialSavingsAmount': 'string',
'TotalAmountByCategory': {
'string': 'string'
},
'AwsProducts': [
{
'ProductCode': 'string',
'ServiceCode': 'string',
'Categories': [
'string',
],
'Amount': 'string',
'OptimizedAmount': 'string',
'PotentialSavingsAmount': 'string',
'Optimizations': [
{
'Description': 'string',
'SavingsAmount': 'string'
},
]
},
]
},
'AWS': {
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TotalAmount': 'string',
'TotalOptimizedAmount': 'string',
'TotalPotentialSavingsAmount': 'string',
'TotalAmountByCategory': {
'string': 'string'
},
'AwsProducts': [
{
'ProductCode': 'string',
'ServiceCode': 'string',
'Categories': [
'string',
],
'Amount': 'string',
'OptimizedAmount': 'string',
'PotentialSavingsAmount': 'string',
'Optimizations': [
{
'Description': 'string',
'SavingsAmount': 'string'
},
]
},
]
}
},
'OpportunityQuality': {
'Score': 123,
'Trend': 'string'
},
'Recommendations': [
{
'Type': 'string',
'Details': 'string',
'Attributes': {
'string': 'string'
}
},
]
},
'InvolvementTypeChangeReason': 'Expansion Opportunity'|'Change in Deal Information'|'Customer Requested'|'Technical Complexity'|'Risk Mitigation',
'RelatedEntityIds': {
'AwsProducts': [
'string',
],
'Solutions': [
'string',
]
},
'Customer': {
'Contacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
]
},
'Project': {
'ExpectedCustomerSpend': [
{
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TargetCompany': 'string',
'EstimationUrl': 'string'
},
],
'AwsPartition': 'aws-eusc'
},
'CosellMotion': 'string'
}
},
'TargetMemberAccounts': [
'string',
]
}
Response Structure
(dict) --
Catalog (string) --
The catalog in which the snapshot was created. Matches the Catalog specified in the request.
Arn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the resource snapshot.
CreatedBy (string) --
The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.
CreatedAt (datetime) --
The timestamp when the snapshot was created, in ISO 8601 format (e.g., "2023-06-01T14:30:00Z"). This allows for precise tracking of when the snapshot was taken.
EngagementId (string) --
The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.
ResourceType (string) --
The type of the resource that was snapshotted. Matches the ResourceType specified in the request.
ResourceId (string) --
The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.
ResourceSnapshotTemplateName (string) --
The name of the view used for this snapshot. This is the same as the template name.
Revision (integer) --
The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.
Payload (dict) --
Represents the payload of a resource snapshot. This structure is designed to accommodate different types of resource snapshots, currently supporting opportunity summaries.
OpportunitySummary (dict) --
An object that contains an opportunity's subset of fields.
OpportunityType (string) --
Specifies the opportunity type.
Lifecycle (dict) --
Contains information about the opportunity's lifecycle, including its current stage, status, and important dates such as creation and last modification times.
TargetCloseDate (string) --
The projected launch date of the opportunity shared through a snapshot.
ReviewStatus (string) --
Defines the approval status of the opportunity shared through a snapshot.
Stage (string) --
Defines the current stage of the opportunity shared through a snapshot.
NextSteps (string) --
Describes the next steps for the opportunity shared through a snapshot.
OpportunityTeam (list) --
Represents the internal team handling the opportunity. Specify the members involved in collaborating on an opportunity within the partner's organization.
(dict) --
An object that contains a Customer Partner's contact details.
Email (string) --
The contact's email address associated with the Opportunity.
FirstName (string) --
The contact's first name associated with the Opportunity.
LastName (string) --
The contact's last name associated with the Opportunity.
BusinessTitle (string) --
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
Phone (string) --
The contact's phone number associated with the Opportunity.
PrimaryNeedsFromAws (list) --
Identifies the type of support the partner needs from AWS.
(string) --
Customer (dict) --
An object that contains the customer's Account and Contact.
Account (dict) --
An object that contains the customer's account details.
Industry (string) --
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.
OtherIndustry (string) --
Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.
CompanyName (string) --
Specifies the end Customer's company name associated with the Opportunity.
WebsiteUrl (string) --
Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security.
AwsAccountId (string) --
Specifies the Customer Amazon Web Services account ID associated with the Opportunity.
Address (dict) --
Specifies the end Customer's address details associated with the Opportunity.
City (string) --
Specifies the end Customer's city associated with the Opportunity.
PostalCode (string) --
Specifies the end Customer's postal code associated with the Opportunity.
StateOrRegion (string) --
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
CountryCode (string) --
Specifies the end Customer's country associated with the Opportunity.
StreetAddress (string) --
Specifies the end Customer's street address associated with the Opportunity.
Duns (string) --
Indicates the Customer DUNS number, if available.
Contacts (list) --
Represents the contact details for individuals associated with the customer of the Opportunity. This field captures relevant contacts, including decision-makers, influencers, and technical stakeholders within the customer organization. These contacts are key to progressing the opportunity.
(dict) --
An object that contains a Customer Partner's contact details.
Email (string) --
The contact's email address associated with the Opportunity.
FirstName (string) --
The contact's first name associated with the Opportunity.
LastName (string) --
The contact's last name associated with the Opportunity.
BusinessTitle (string) --
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
Phone (string) --
The contact's phone number associated with the Opportunity.
Project (dict) --
Contains summary information about the project associated with the opportunity, including project name, description, timeline, and other relevant details.
DeliveryModels (list) --
Describes the deployment or consumption model for the partner solution or offering. This field indicates how the project's solution will be delivered or implemented for the customer.
(string) --
ExpectedCustomerSpend (list) --
Provides information about the anticipated customer spend related to this project. This may include details such as amount, frequency, and currency of expected expenditure.
(dict) --
Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.
Amount (string) --
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
CurrencyCode (string) --
Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).
TargetCompany (string) --
Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
ExpectedContractDuration (dict) --
Optional. The expected contract duration for this opportunity, representing the anticipated length of the contract in the unit specified by Term.
Term (string) --
The unit of measurement for the contract duration value. Currently accepts only Months.
Value (string) --
A String representation of the contract duration as an integer, expressed in the unit defined by Term. Valid values range from 1 to 144.
CustomerUseCase (string) --
Specifies the proposed solution focus or type of workload for the project.
SalesActivities (list) --
Lists the pre-sales activities that have occurred with the end-customer related to the opportunity. This field is conditionally mandatory when the project is qualified for Co-Sell and helps drive assignment priority on the AWS side. It provides insight into the engagement level with the customer.
(string) --
OtherSolutionDescription (string) --
Offers a description of other solutions if the standard solutions do not adequately cover the project's scope.
RelatedEntityIdentifiers (dict) --
This field provides the associations' information for other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.
AwsMarketplaceOffers (list) --
Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this format: "offers": ["arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32"].
Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in the associated Marketplace seller account.
(string) --
AwsMarketplaceOfferSets (list) --
Enables the association of AWS Marketplace offer sets with the Opportunity. Offer sets allow grouping multiple related marketplace offers together for comprehensive solution packaging. Each value is an Amazon Resource Name (ARN) in this format: arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/OfferSet/offerset-sampleOfferSet32.
(string) --
Solutions (list) --
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. 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 communicate the offerings that are being considered or implemented to address the customer's business problem.
(string) --
AwsProducts (list) --
Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's needs. Returns multiple values separated by commas. For example, "AWSProducts" : ["AmazonRedshift", "AWSAppFabric", "AWSCleanRooms"].
Use the file with the list of Amazon Web Services products hosted on GitHub: Amazon Web Services products.
(string) --
AwsOpportunitySummaryFullView (dict) --
Provides a comprehensive view of AwsOpportunitySummaryFullView template.
RelatedOpportunityId (string) --
Identifier of the related partner opportunity.
Origin (string) --
Source origin of the AWS opportunity.
InvolvementType (string) --
Type of AWS involvement in the opportunity.
Visibility (string) --
Visibility level for the AWS opportunity.
LifeCycle (dict) --
Tracks the lifecycle of the AWS opportunity, including stages such as qualification, validation, and closure. This field helps partners understand the current status and progression of the opportunity.
TargetCloseDate (string) --
Indicates the expected date by which the opportunity is projected to close. This field helps in planning resources and timelines for both the partner and AWS.
ClosedLostReason (string) --
Indicates the reason why an opportunity was marked as Closed Lost. This helps in understanding the context behind the lost opportunity and aids in refining future strategies.
Stage (string) --
Represents the current stage of the opportunity in its lifecycle, such as Qualification, Validation, or Closed Won. This helps in understanding the opportunity's progress.
NextSteps (string) --
Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.
NextStepsHistory (list) --
Provides a historical log of previous next steps that were taken to move the opportunity forward. This helps in tracking the decision-making process and identifying any delays or obstacles encountered.
(dict) --
Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.
Value (string) --
Represents the details of the next step recorded, such as follow-up actions or decisions made. This field helps in tracking progress and ensuring alignment with project goals.
Time (datetime) --
Indicates the date and time when a particular next step was recorded or planned. This helps in managing the timeline for the opportunity.
OpportunityTeam (list) --
AWS team members involved in the opportunity.
(dict) --
Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.
Email (string) --
Provides the Amazon Web Services team member's email address.
FirstName (string) --
Provides the Amazon Web Services team member's first name.
LastName (string) --
Provides the Amazon Web Services team member's last name.
BusinessTitle (string) --
Specifies the Amazon Web Services team member's business title and indicates their organizational role.
Insights (dict) --
Contains insights provided by AWS for the opportunity, offering recommendations and analysis that can help the partner optimize their engagement and strategy.
NextBestActions (string) --
Provides recommendations from AWS on the next best actions to take in order to move the opportunity forward and increase the likelihood of success.
EngagementScore (string) --
Represents a score assigned by AWS to indicate the level of engagement and potential success for the opportunity. This score helps partners prioritize their efforts.
AwsProductsSpendInsightsBySource (dict) --
Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates.
Partner (dict) --
Partner-sourced insights derived from Pricing Calculator URLs.
CurrencyCode (string) --
ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
Frequency (string) --
Time period for spend amounts.
TotalAmount (string) --
Total estimated spend for this source before optimizations.
TotalOptimizedAmount (string) --
Total estimated spend after applying recommended optimizations.
TotalPotentialSavingsAmount (string) --
Quantified savings achievable through implementing optimizations.
TotalAmountByCategory (dict) --
Spend amounts mapped to AWS programs and modernization pathways.
(string) --
(string) --
AwsProducts (list) --
Product-level details including costs and optimization recommendations.
(dict) --
List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
ProductCode (string) --
AWS Partner Central product identifier used for opportunity association.
ServiceCode (string) --
Pricing Calculator service code.
Categories (list) --
List of program and pathway categories this product is eligible for.
(string) --
Amount (string) --
Baseline service cost before optimizations.
OptimizedAmount (string) --
Service cost after applying optimizations.
PotentialSavingsAmount (string) --
Service-specific cost reduction through optimizations.
Optimizations (list) --
List of specific optimization recommendations for this product.
(dict) --
Specific optimization strategies partners can implement to reduce costs.
Description (string) --
Human-readable explanation of the optimization strategy.
SavingsAmount (string) --
Quantified cost savings achievable by implementing this optimization.
AWS (dict) --
AI-generated insights including recommended products from AWS.
CurrencyCode (string) --
ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
Frequency (string) --
Time period for spend amounts.
TotalAmount (string) --
Total estimated spend for this source before optimizations.
TotalOptimizedAmount (string) --
Total estimated spend after applying recommended optimizations.
TotalPotentialSavingsAmount (string) --
Quantified savings achievable through implementing optimizations.
TotalAmountByCategory (dict) --
Spend amounts mapped to AWS programs and modernization pathways.
(string) --
(string) --
AwsProducts (list) --
Product-level details including costs and optimization recommendations.
(dict) --
List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
ProductCode (string) --
AWS Partner Central product identifier used for opportunity association.
ServiceCode (string) --
Pricing Calculator service code.
Categories (list) --
List of program and pathway categories this product is eligible for.
(string) --
Amount (string) --
Baseline service cost before optimizations.
OptimizedAmount (string) --
Service cost after applying optimizations.
PotentialSavingsAmount (string) --
Service-specific cost reduction through optimizations.
Optimizations (list) --
List of specific optimization recommendations for this product.
(dict) --
Specific optimization strategies partners can implement to reduce costs.
Description (string) --
Human-readable explanation of the optimization strategy.
SavingsAmount (string) --
Quantified cost savings achievable by implementing this optimization.
OpportunityQuality (dict) --
Opportunity quality assessment. Null if not yet scored.
Score (integer) --
Deal quality score based on opportunity content completeness and sales methodology criteria. Values range from 0 to 100.
Trend (string) --
Direction of score change since last scoring iteration. Known values: Improving, Declining, No Change.
Recommendations (list) --
List of recommendations from various agent-driven sources.
(dict) --
A recommendation from an agent-driven source.
Type (string) --
The recommendation source type. Known values: OpportunityQuality, SolutionRecommendation, SpecialistRecommendation.
Details (string) --
Human-readable recommendation text from this source.
Attributes (dict) --
Source-specific metadata as key-value pairs.
(string) --
(string) --
InvolvementTypeChangeReason (string) --
Reason for changes in AWS involvement type for the opportunity.
RelatedEntityIds (dict) --
Represents other entities related to the AWS opportunity, such as AWS products, partner solutions, and marketplace offers. These associations help build a complete picture of the solution being sold.
AwsProducts (list) --
Specifies the AWS products associated with the opportunity. This field helps track the specific products that are part of the proposed solution.
(string) --
Solutions (list) --
Specifies the partner solutions related to the opportunity. These solutions represent the partner's offerings that are being positioned as part of the overall AWS opportunity.
(string) --
Customer (dict) --
Represents the customer associated with the AWS opportunity. This field captures key details about the customer that are necessary for managing the opportunity.
Contacts (list) --
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.
(dict) --
An object that contains a Customer Partner's contact details.
Email (string) --
The contact's email address associated with the Opportunity.
FirstName (string) --
The contact's first name associated with the Opportunity.
LastName (string) --
The contact's last name associated with the Opportunity.
BusinessTitle (string) --
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
Phone (string) --
The contact's phone number associated with the Opportunity.
Project (dict) --
Captures details about the project associated with the opportunity, including objectives, scope, and customer requirements.
ExpectedCustomerSpend (list) --
Indicates the expected spending by the customer over the course of the project. This value helps partners and AWS estimate the financial impact of the opportunity. Use the AWS Pricing Calculator to create an estimate of the customer’s total spend. If only annual recurring revenue (ARR) is available, distribute it across 12 months to provide an average monthly value.
(dict) --
Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.
Amount (string) --
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
CurrencyCode (string) --
Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).
TargetCompany (string) --
Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
AwsPartition (string) --
AWS partition where the opportunity will be deployed. Possible values: aws-eusc for AWS European Sovereign Cloud, null for all other partitions.
CosellMotion (string) --
Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led.
TargetMemberAccounts (list) --
Target member accounts associated with the resource snapshot.
(string) --
{'ContextTypes': {'ProspectingResult'},
'ExcludeContextTypes': {'ProspectingResult'}}
Response {'EngagementSummaryList': {'ContextTypes': {'ProspectingResult'}}}
This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process.
See also: AWS API Documentation
Request Syntax
client.list_engagements(
Catalog='string',
CreatedBy=[
'string',
],
ExcludeCreatedBy=[
'string',
],
ContextTypes=[
'CustomerProject'|'Lead'|'ProspectingResult',
],
ExcludeContextTypes=[
'CustomerProject'|'Lead'|'ProspectingResult',
],
Sort={
'SortOrder': 'ASCENDING'|'DESCENDING',
'SortBy': 'CreatedDate'
},
MaxResults=123,
NextToken='string',
EngagementIdentifier=[
'string',
]
)
string
[REQUIRED]
Specifies the catalog related to the request.
list
A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.
(string) --
list
An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.
(string) --
list
Filters engagements to include only those containing the specified context types, such as "CustomerProject" or "Lead". Use this to find engagements that have specific types of contextual information associated with them.
(string) --
list
Filters engagements to exclude those containing the specified context types. Use this to find engagements that do not have certain types of contextual information, helping to narrow results based on context exclusion criteria.
(string) --
dict
Specifies the sorting parameters for listing Engagements.
SortOrder (string) -- [REQUIRED]
The order in which to sort the results.
SortBy (string) -- [REQUIRED]
The field by which to sort the results.
integer
The maximum number of results to return in a single call.
string
The token for the next set of results. This value is returned from a previous call.
list
An array of strings representing engagement identifiers to retrieve.
(string) --
dict
Response Syntax
{
'EngagementSummaryList': [
{
'Arn': 'string',
'Id': 'string',
'Title': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'MemberCount': 123,
'ModifiedAt': datetime(2015, 1, 1),
'ModifiedBy': 'string',
'ContextTypes': [
'CustomerProject'|'Lead'|'ProspectingResult',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EngagementSummaryList (list) --
An array of engagement summary objects.
(dict) --
An object that contains an Engagement's subset of fields.
Arn (string) --
The Amazon Resource Name (ARN) of the created Engagement.
Id (string) --
The unique identifier for the Engagement.
Title (string) --
The title of the Engagement.
CreatedAt (datetime) --
The date and time when the Engagement was created.
CreatedBy (string) --
The AWS Account ID of the Engagement creator.
MemberCount (integer) --
The number of members in the Engagement.
ModifiedAt (datetime) --
The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".
ModifiedBy (string) --
The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.
ContextTypes (list) --
An array of context types associated with the engagement, such as "CustomerProject" or "Lead". This provides a quick overview of the types of contexts included in the engagement.
(string) --
NextToken (string) --
The token to retrieve the next set of results. This field will be null if there are no more results.
{'Payload': {'Lead': {'Insights': {'LeadReadinessScore': 'string'}},
'ProspectingResult': {'Aws': {'Customer': {'AccountName': 'string',
'CompanySize': 'string',
'Country': 'US | AF | '
'AX | AL | '
'DZ | AS | '
'AD | AO | '
'AI | AQ | '
'AG | AR | '
'AM | AW | '
'AU | AT | '
'AZ | BS | '
'BH | BD | '
'BB | BY | '
'BE | BZ | '
'BJ | BM | '
'BT | BO | '
'BQ | BA | '
'BW | BV | '
'BR | IO | '
'BN | BG | '
'BF | BI | '
'KH | CM | '
'CA | CV | '
'KY | CF | '
'TD | CL | '
'CN | CX | '
'CC | CO | '
'KM | CG | '
'CK | CR | '
'CI | HR | '
'CU | CW | '
'CY | CZ | '
'CD | DK | '
'DJ | DM | '
'DO | EC | '
'EG | SV | '
'GQ | ER | '
'EE | ET | '
'FK | FO | '
'FJ | FI | '
'FR | GF | '
'PF | TF | '
'GA | GM | '
'GE | DE | '
'GH | GI | '
'GR | GL | '
'GD | GP | '
'GU | GT | '
'GG | GN | '
'GW | GY | '
'HT | HM | '
'VA | HN | '
'HK | HU | '
'IS | IN | '
'ID | IR | '
'IQ | IE | '
'IM | IL | '
'IT | JM | '
'JP | JE | '
'JO | KZ | '
'KE | KI | '
'KR | KW | '
'KG | LA | '
'LV | LB | '
'LS | LR | '
'LY | LI | '
'LT | LU | '
'MO | MK | '
'MG | MW | '
'MY | MV | '
'ML | MT | '
'MH | MQ | '
'MR | MU | '
'YT | MX | '
'FM | MD | '
'MC | MN | '
'ME | MS | '
'MA | MZ | '
'MM | NA | '
'NR | NP | '
'NL | AN | '
'NC | NZ | '
'NI | NE | '
'NG | NU | '
'NF | MP | '
'NO | OM | '
'PK | PW | '
'PS | PA | '
'PG | PY | '
'PE | PH | '
'PN | PL | '
'PT | PR | '
'QA | RE | '
'RO | RU | '
'RW | BL | '
'SH | KN | '
'LC | MF | '
'PM | VC | '
'WS | SM | '
'ST | SA | '
'SN | RS | '
'SC | SL | '
'SG | SX | '
'SK | SI | '
'SB | SO | '
'ZA | GS | '
'SS | ES | '
'LK | SD | '
'SR | SJ | '
'SZ | SE | '
'CH | SY | '
'TW | TJ | '
'TZ | TH | '
'TL | TG | '
'TK | TO | '
'TT | TN | '
'TR | TM | '
'TC | TV | '
'UG | UA | '
'AE | GB | '
'UM | UY | '
'UZ | VU | '
'VE | VN | '
'VG | VI | '
'WF | EH | '
'YE | ZM | '
'ZW',
'EligiblePrograms': ['string'],
'Geo': 'string',
'Industry': 'Aerospace '
'| '
'Agriculture '
'| '
'Automotive '
'| '
'Computers '
'and '
'Electronics '
'| '
'Consumer '
'Goods | '
'Education '
'| Energy '
'- Oil and '
'Gas | '
'Energy - '
'Power and '
'Utilities '
'| '
'Financial '
'Services '
'| Gaming '
'| '
'Government '
'| '
'Healthcare '
'| '
'Hospitality '
'| Life '
'Sciences '
'| '
'Manufacturing '
'| '
'Marketing '
'and '
'Advertising '
'| Media '
'and '
'Entertainment '
'| Mining '
'| '
'Non-Profit '
'Organization '
'| '
'Professional '
'Services '
'| Real '
'Estate '
'and '
'Construction '
'| Retail '
'| '
'Software '
'and '
'Internet '
'| '
'Telecommunications '
'| '
'Transportation '
'and '
'Logistics '
'| Travel '
'| '
'Wholesale '
'and '
'Distribution '
'| Other',
'PublicProfileSummary': 'string',
'Region': 'string',
'Segment': 'string',
'SubIndustry': 'string',
'SubRegion': 'string'},
'EndTime': 'timestamp',
'Insights': {'MarketplaceEngagementScore': 'string',
'SolutionCategory': 'string',
'SolutionScore': 'string',
'SolutionSubCategory': 'string'},
'StartTime': 'timestamp',
'TaskArn': 'string',
'TaskId': 'string',
'TaskName': 'string'}}},
'Type': {'ProspectingResult'}}
Updates the context information for an existing engagement with new or modified data.
See also: AWS API Documentation
Request Syntax
client.update_engagement_context(
Catalog='string',
EngagementIdentifier='string',
ContextIdentifier='string',
EngagementLastModifiedAt=datetime(2015, 1, 1),
Type='CustomerProject'|'Lead'|'ProspectingResult',
Payload={
'Lead': {
'QualificationStatus': 'string',
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'AwsMaturity': 'string',
'MarketSegment': 'Enterprise'|'Large'|'Medium'|'Small'|'Micro'
},
'Interaction': {
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'InteractionDate': datetime(2015, 1, 1),
'CustomerAction': 'string',
'BusinessProblem': 'string',
'Contact': {
'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'
}
},
'Insights': {
'LeadReadinessScore': 'string'
}
},
'CustomerProject': {
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'Title': 'string',
'BusinessProblem': 'string',
'TargetCompletionDate': 'string'
}
},
'ProspectingResult': {
'Aws': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string',
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
}
}
}
}
)
string
[REQUIRED]
Specifies the catalog associated with the engagement context update request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is updated in.
string
[REQUIRED]
The unique identifier of the Engagement containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.
string
[REQUIRED]
The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.
datetime
[REQUIRED]
The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.
string
[REQUIRED]
Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.
dict
[REQUIRED]
Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.
Lead (dict) --
Contains updated information about a lead when the context type is "Lead". This field is present only when updating a lead context within the engagement.
QualificationStatus (string) --
The updated qualification status of the lead.
Customer (dict) -- [REQUIRED]
Updated customer information associated with the lead.
Industry (string) --
Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
CompanyName (string) -- [REQUIRED]
The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
WebsiteUrl (string) --
The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
Address (dict) -- [REQUIRED]
An object that contains an Address object's subset of fields.
City (string) --
Specifies the end Customer's city associated with the Opportunity.
PostalCode (string) --
Specifies the end Customer's postal code associated with the Opportunity.
StateOrRegion (string) --
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
CountryCode (string) --
Specifies the end Customer's country associated with the Opportunity.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
MarketSegment (string) --
Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
Interaction (dict) --
Updated interaction details for the lead context.
SourceType (string) -- [REQUIRED]
Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
SourceId (string) -- [REQUIRED]
The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
SourceName (string) -- [REQUIRED]
The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
Usecase (string) --
Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
InteractionDate (datetime) --
The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
CustomerAction (string) -- [REQUIRED]
Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
BusinessProblem (string) --
Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
Contact (dict) -- [REQUIRED]
Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
BusinessTitle (string) -- [REQUIRED]
The lead contact's business title or job role associated with the engagement.
Email (string) -- [REQUIRED]
The lead contact's email address associated with the engagement.
FirstName (string) -- [REQUIRED]
The lead contact's first name associated with the engagement.
LastName (string) -- [REQUIRED]
The lead contact's last name associated with the engagement.
Phone (string) --
The lead contact's phone number associated with the engagement.
Insights (dict) --
Insights that AI generates and associates with the lead. These insights provide automated analysis to help partners assess the lead quality and readiness.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
CustomerProject (dict) --
The CustomerProjects structure in Engagements offers a flexible framework for managing customer-project relationships. It supports multiple customers per Engagement and multiple projects per customer, while also allowing for customers without projects and projects without specific customers.
All Engagement members have full visibility of customers and their associated projects, enabling the capture of relevant context even when project details are not fully defined. This structure also facilitates targeted invitations, allowing partners to focus on specific customers and their business problems when sending Engagement invitations.
Customer (dict) --
Contains details about the customer associated with the Engagement Invitation, including company information and industry.
Industry (string) -- [REQUIRED]
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) -- [REQUIRED]
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) -- [REQUIRED]
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) -- [REQUIRED]
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Information about the customer project associated with the Engagement.
Title (string) -- [REQUIRED]
The title of the project.
BusinessProblem (string) -- [REQUIRED]
A description of the business problem the project aims to solve.
TargetCompletionDate (string) -- [REQUIRED]
The target completion date for the customer's project.
ProspectingResult (dict) --
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.
Aws (dict) --
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
StartTime (datetime) --
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
EndTime (datetime) --
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
TaskId (string) --
The unique identifier of the prospecting task that generates this result.
TaskArn (string) --
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
TaskName (string) --
The name that the user provides for the prospecting task that generates this result.
Customer (dict) --
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
dict
Response Syntax
{
'EngagementId': 'string',
'EngagementArn': 'string',
'EngagementLastModifiedAt': datetime(2015, 1, 1),
'ContextId': 'string'
}
Response Structure
(dict) --
EngagementId (string) --
The unique identifier of the engagement that was updated.
EngagementArn (string) --
The Amazon Resource Name (ARN) of the updated engagement.
EngagementLastModifiedAt (datetime) --
The timestamp when the engagement context was last modified.
ContextId (string) --
The unique identifier of the engagement context that was updated.