2025/12/01 - Partner Central Selling API - 4 new15 updated api methods
Changes New Features: Lead Management APIs for capturing and nurturing leads Lead invitation support for partner collaboration Lead-to-opportunity conversion operations AWS Marketplace OfferSets support for opportunities
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',
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'
}
}
},
'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'
}
}
}
)
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.
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.
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.
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',
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': {
'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'
}
},
]
}
}
)
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".
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.
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.
Lists all in-progress, completed, or failed opportunity creation tasks from engagements that were initiated by the caller's account.
See also: AWS API Documentation
Request Syntax
client.list_opportunity_from_engagement_tasks(
MaxResults=123,
NextToken='string',
Sort={
'SortOrder': 'ASCENDING'|'DESCENDING',
'SortBy': 'StartTime'
},
Catalog='string',
TaskStatus=[
'IN_PROGRESS'|'COMPLETE'|'FAILED',
],
TaskIdentifier=[
'string',
],
OpportunityIdentifier=[
'string',
],
EngagementIdentifier=[
'string',
],
ContextIdentifier=[
'string',
]
)
integer
Specifies the maximum number of results to return in a single page of the response. Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
string
The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.
dict
Defines the sorting parameters for listing tasks. This structure allows for specifying the field to sort by and the order of sorting.
SortOrder (string) -- [REQUIRED]
Determines the order in which the sorted results are presented.
SortBy (string) -- [REQUIRED]
Specifies the field by which the task list should be sorted.
string
[REQUIRED]
Specifies the catalog related to the request. Valid values are AWS for production environments and Sandbox for testing or development purposes. The catalog determines which environment the task data is retrieved from.
list
Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.
(string) --
list
Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.
(string) --
list
Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.
(string) --
list
Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.
(string) --
list
Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.
(string) --
dict
Response Syntax
{
'TaskSummaries': [
{
'TaskId': 'string',
'TaskArn': 'string',
'StartTime': datetime(2015, 1, 1),
'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'Message': 'string',
'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled'|'ContextNotFound'|'CustomerProjectContextNotPermitted'|'DisqualifiedLeadNotPermitted',
'OpportunityId': 'string',
'ResourceSnapshotJobId': 'string',
'EngagementId': 'string',
'ContextId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TaskSummaries (list) --
An array of ListOpportunityFromEngagementTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.
(dict) --
Provides a summary of a task related to creating an opportunity from an engagement. This structure contains key information about the task's status, associated identifiers, and any failure details for opportunity creation processes.
TaskId (string) --
The unique identifier of the task for creating an opportunity from an engagement.
TaskArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
StartTime (datetime) --
The timestamp indicating when the task was initiated, in RFC 3339 format.
TaskStatus (string) --
The current status of the task. Valid values are COMPLETE, INPROGRESS, or FAILED.
Message (string) --
A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution.
ReasonCode (string) --
A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
OpportunityId (string) --
The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.
ResourceSnapshotJobId (string) --
The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the opportunity creation process.
EngagementId (string) --
The unique identifier of the engagement from which the opportunity is being created. This field helps track the source of the opportunity creation task.
ContextId (string) --
The unique identifier of the engagement context associated with the opportunity creation task. This links the task to specific contextual information within the engagement.
NextToken (string) --
A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.
This action creates an opportunity from an existing engagement context. The task is asynchronous and orchestrates the process of converting engagement contextual information into a structured opportunity record within the partner's account.
See also: AWS API Documentation
Request Syntax
client.start_opportunity_from_engagement_task(
Catalog='string',
ClientToken='string',
Identifier='string',
ContextIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the catalog in which the opportunity creation task is executed. Acceptable values include AWS for production and Sandbox for testing environments.
string
[REQUIRED]
A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the engagement from which the opportunity creation task is to be initiated. This helps ensure that the task is applied to the correct engagement.
string
[REQUIRED]
The unique identifier of the engagement context from which to create the opportunity. This specifies the specific contextual information within the engagement that will be used for opportunity creation.
list
A map of the key-value pairs of the tag or tags to assign.
(dict) --
The key-value pair assigned to a specified resource.
Key (string) -- [REQUIRED]
The key in the tag.
Value (string) -- [REQUIRED]
The value in the tag.
dict
Response Syntax
{
'TaskId': 'string',
'TaskArn': 'string',
'StartTime': datetime(2015, 1, 1),
'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'Message': 'string',
'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled'|'ContextNotFound'|'CustomerProjectContextNotPermitted'|'DisqualifiedLeadNotPermitted',
'OpportunityId': 'string',
'ResourceSnapshotJobId': 'string',
'EngagementId': 'string',
'ContextId': 'string'
}
Response Structure
(dict) --
TaskId (string) --
The unique identifier of the task, used to track the task's progress.
TaskArn (string) --
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
StartTime (datetime) --
The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
TaskStatus (string) --
Indicates the current status of the task.
Message (string) --
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
ReasonCode (string) --
Indicates the reason for task failure using an enumerated code.
OpportunityId (string) --
The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.
ResourceSnapshotJobId (string) --
The identifier of the resource snapshot job created as part of the opportunity creation process.
EngagementId (string) --
The unique identifier of the engagement from which the opportunity was created.
ContextId (string) --
The unique identifier of the engagement context used to create the opportunity.
{'Assignee': {'Phone': 'string'}}
Enables you to reassign an existing Opportunity to another user within your Partner Central account. The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity.
This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one who creates it. Currently, there's no API to enumerate the list of available users.
See also: AWS API Documentation
Request Syntax
client.assign_opportunity(
Catalog='string',
Identifier='string',
Assignee={
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string',
'BusinessTitle': 'string'
}
)
string
[REQUIRED]
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
string
[REQUIRED]
Requires the Opportunity's unique identifier when you want to assign it to another user. Provide the correct identifier so the intended opportunity is reassigned.
dict
[REQUIRED]
Specifies the user or team member responsible for managing the assigned opportunity. This field identifies the Assignee based on the partner's internal team structure. Ensure that the email address is associated with a registered user in your Partner Central account.
Email (string) -- [REQUIRED]
Provides the email address of the assignee. This email is used for communications and notifications related to the opportunity.
FirstName (string) -- [REQUIRED]
Specifies the first name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
LastName (string) -- [REQUIRED]
Specifies the last name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
Phone (string) --
Specifies the contact phone number of the assignee responsible for the opportunity or engagement. This field enables direct communication for time-sensitive matters and facilitates coordination between AWS and partner teams.
BusinessTitle (string) -- [REQUIRED]
Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization. Use the value PartnerAccountManager to update details of the opportunity owner.
None
{'RelatedEntityType': {'AwsMarketplaceOfferSets'}}
Enables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types:
Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services.
Amazon Web Services Products: Amazon Web Services offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products.
Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, see Private offers in Amazon Web Services Marketplace.
To obtain identifiers for these entities, use the following methods:
Solution: Use the ListSolutions operation.
AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products.
Amazon Web Services Marketplace private offer: Use the Using the Amazon Web Services Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request returns the details of available private offers. For more information, see ListEntities.
See also: AWS API Documentation
Request Syntax
client.associate_opportunity(
Catalog='string',
OpportunityIdentifier='string',
RelatedEntityType='Solutions'|'AwsProducts'|'AwsMarketplaceOffers'|'AwsMarketplaceOfferSets',
RelatedEntityIdentifier='string'
)
string
[REQUIRED]
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
string
[REQUIRED]
Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.
string
[REQUIRED]
Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.
string
[REQUIRED]
Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.
None
{'Contexts': {'Id': 'string',
'Payload': {'Lead': {'Customer': {'Address': {'City': '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',
'PostalCode': 'string',
'StateOrRegion': 'string'},
'AwsMaturity': 'string',
'CompanyName': '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',
'MarketSegment': 'Enterprise | '
'Large | '
'Medium | '
'Small | '
'Micro',
'WebsiteUrl': 'string'},
'Interactions': [{'BusinessProblem': 'string',
'Contact': {'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'},
'CustomerAction': 'string',
'InteractionDate': 'timestamp',
'SourceId': 'string',
'SourceName': 'string',
'SourceType': 'string',
'Usecase': 'string'}],
'QualificationStatus': 'string'}},
'Type': {'Lead'}}}
Response {'ModifiedAt': 'timestamp'}
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',
'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': {
'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'
}
},
]
}
}
},
]
)
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".
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.
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".
{'Invitation': {'Payload': {'LeadInvitation': {'Customer': {'AwsMaturity': 'string',
'CompanyName': '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',
'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',
'MarketSegment': 'Enterprise '
'| '
'Large '
'| '
'Medium '
'| '
'Small '
'| '
'Micro',
'WebsiteUrl': 'string'},
'Interaction': {'ContactBusinessTitle': 'string',
'SourceId': 'string',
'SourceName': 'string',
'SourceType': 'string',
'Usecase': 'string'}}}}}
This action creates an invitation from a sender to a single receiver to join an engagement.
See also: AWS API Documentation
Request Syntax
client.create_engagement_invitation(
Catalog='string',
ClientToken='string',
EngagementIdentifier='string',
Invitation={
'Message': 'string',
'Receiver': {
'Account': {
'Alias': 'string',
'AwsAccountId': 'string'
}
},
'Payload': {
'OpportunityInvitation': {
'SenderContacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
'ReceiverResponsibilities': [
'Distributor'|'Reseller'|'Hardware Partner'|'Managed Service Provider'|'Software Partner'|'Services Partner'|'Training Partner'|'Co-Sell Facilitator'|'Facilitator',
],
'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': {
'BusinessProblem': 'string',
'Title': 'string',
'TargetCompletionDate': 'string',
'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'
},
]
}
},
'LeadInvitation': {
'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',
'AwsMaturity': 'string',
'MarketSegment': 'Enterprise'|'Large'|'Medium'|'Small'|'Micro'
},
'Interaction': {
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'ContactBusinessTitle': 'string'
}
}
}
}
)
string
[REQUIRED]
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]
Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.
dict
[REQUIRED]
The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.
Message (string) -- [REQUIRED]
A message accompanying the invitation.
Receiver (dict) -- [REQUIRED]
Represents the entity that received the Engagement Invitation, including account and company details. This field is essential for tracking the partner who is being invited to collaborate.
Account (dict) --
Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.
Alias (string) --
Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
AwsAccountId (string) -- [REQUIRED]
Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.
Payload (dict) -- [REQUIRED]
Contains the data payload associated with the Engagement Invitation. This payload includes essential details related to the AWS opportunity and is used by partners to evaluate whether to accept or reject the engagement.
OpportunityInvitation (dict) --
Specifies the details of the opportunity invitation within the Engagement Invitation payload. This data helps partners understand the context, scope, and expected involvement for the opportunity from AWS.
SenderContacts (list) --
Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.
(dict) --
An object that contains the details of the sender-provided contact person for the EngagementInvitation.
Email (string) -- [REQUIRED]
The sender-provided contact's email address associated with the EngagementInvitation.
FirstName (string) --
The sender-provided contact's last name associated with the EngagementInvitation.
LastName (string) --
The sender-provided contact's first name associated with the EngagementInvitation.
BusinessTitle (string) --
The sender-provided contact's title (job title or role) associated with the EngagementInvitation.
Phone (string) --
The sender-provided contact's phone number associated with the EngagementInvitation.
ReceiverResponsibilities (list) -- [REQUIRED]
Outlines the responsibilities or expectations of the receiver in the context of the invitation.
(string) --
Customer (dict) -- [REQUIRED]
Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements.
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) -- [REQUIRED]
Describes the project details associated with the opportunity, including the customer’s needs and the scope of work expected to be performed.
BusinessProblem (string) -- [REQUIRED]
Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s goals and objectives.
Title (string) -- [REQUIRED]
Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.
TargetCompletionDate (string) -- [REQUIRED]
Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.
ExpectedCustomerSpend (list) -- [REQUIRED]
Contains revenue estimates for the partner related to the project. This field provides an idea of the financial potential of the opportunity for the partner.
(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) -- [REQUIRED]
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
CurrencyCode (string) -- [REQUIRED]
Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.
Frequency (string) -- [REQUIRED]
Indicates how frequently the customer is expected to spend the projected amount. Only the value Monthly is allowed for the Frequency field, representing recurring monthly spend.
TargetCompany (string) -- [REQUIRED]
Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity. This field only accepts the value AWS. If any other value is provided, the system will automatically set it to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
LeadInvitation (dict) --
Specifies the details of the lead invitation within the Engagement Invitation payload. This data helps partners understand the lead context, customer information, and interaction history for the lead opportunity from AWS.
Customer (dict) -- [REQUIRED]
Contains information about the customer associated with the lead invitation. This data helps partners understand the customer's profile, industry, and business context to assess the lead opportunity.
Industry (string) --
Specifies the industry sector of the customer company associated with the lead invitation. This categorization helps partners understand the customer's business context and assess solution fit.
CompanyName (string) -- [REQUIRED]
The name of the customer company associated with the lead invitation. This field identifies the target organization for the lead engagement opportunity.
WebsiteUrl (string) --
The website URL of the customer company. This provides additional context about the customer organization and helps partners verify company details and assess business size and legitimacy.
CountryCode (string) -- [REQUIRED]
The country code indicating the geographic location of the customer company. This information helps partners understand regional requirements and assess their ability to serve the customer effectively.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps partners understand the customer's cloud maturity and tailor their engagement approach accordingly.
MarketSegment (string) --
Specifies the market segment classification of the customer, such as enterprise, mid-market, or small business. This segmentation helps partners determine the appropriate solution complexity and engagement strategy.
Interaction (dict) -- [REQUIRED]
Describes the interaction details associated with the lead, including the source of the lead generation and customer engagement information. This context helps partners evaluate the lead quality and engagement approach.
SourceType (string) -- [REQUIRED]
Specifies the type of source that generated the lead interaction, such as "Event", "Website", or "Campaign". This helps partners understand the lead generation channel and assess lead quality based on the source type.
SourceId (string) -- [REQUIRED]
The unique identifier of the specific source that generated the lead interaction. This provides traceability to the original lead generation activity for reference and follow-up purposes.
SourceName (string) -- [REQUIRED]
The descriptive name of the source that generated the lead interaction. This human-readable identifier helps partners understand the specific lead generation channel or campaign that created the opportunity.
Usecase (string) --
Describes the specific use case or business scenario associated with the lead interaction. This information helps partners understand the customer's interests and potential solution requirements.
ContactBusinessTitle (string) -- [REQUIRED]
The business title or job role of the customer contact involved in the lead interaction. This helps partners identify the decision-making level and engagement approach for the lead.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
Unique identifier assigned to the newly created engagement invitation.
Arn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.
{'RelatedEntityType': {'AwsMarketplaceOfferSets'}}
Allows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change.
Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.
See also: AWS API Documentation
Request Syntax
client.disassociate_opportunity(
Catalog='string',
OpportunityIdentifier='string',
RelatedEntityType='Solutions'|'AwsProducts'|'AwsMarketplaceOffers'|'AwsMarketplaceOfferSets',
RelatedEntityIdentifier='string'
)
string
[REQUIRED]
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
string
[REQUIRED]
The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.
Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.
string
[REQUIRED]
The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.
Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.
Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.
string
[REQUIRED]
The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.
For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.
Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.
None
{'Contexts': {'Id': 'string',
'Payload': {'Lead': {'Customer': {'Address': {'City': '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',
'PostalCode': 'string',
'StateOrRegion': 'string'},
'AwsMaturity': 'string',
'CompanyName': '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',
'MarketSegment': 'Enterprise | '
'Large | '
'Medium | '
'Small | '
'Micro',
'WebsiteUrl': 'string'},
'Interactions': [{'BusinessProblem': 'string',
'Contact': {'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'},
'CustomerAction': 'string',
'InteractionDate': 'timestamp',
'SourceId': 'string',
'SourceName': 'string',
'SourceType': 'string',
'Usecase': 'string'}],
'QualificationStatus': 'string'}},
'Type': {'Lead'}},
'ModifiedAt': 'timestamp',
'ModifiedBy': 'string'}
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',
'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': {
'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'
}
},
]
}
}
},
]
}
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".
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.
{'Payload': {'LeadInvitation': {'Customer': {'AwsMaturity': 'string',
'CompanyName': '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',
'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',
'MarketSegment': 'Enterprise | '
'Large | Medium '
'| Small | Micro',
'WebsiteUrl': 'string'},
'Interaction': {'ContactBusinessTitle': 'string',
'SourceId': 'string',
'SourceName': 'string',
'SourceType': 'string',
'Usecase': 'string'}}},
'PayloadType': {'LeadInvitation'}}
Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.
See also: AWS API Documentation
Request Syntax
client.get_engagement_invitation(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
Specifies the catalog associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments.
string
[REQUIRED]
Specifies the unique identifier for the retrieved engagement invitation.
dict
Response Syntax
{
'Arn': 'string',
'PayloadType': 'OpportunityInvitation'|'LeadInvitation',
'Id': 'string',
'EngagementId': 'string',
'EngagementTitle': 'string',
'Status': 'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED',
'InvitationDate': datetime(2015, 1, 1),
'ExpirationDate': datetime(2015, 1, 1),
'SenderAwsAccountId': 'string',
'SenderCompanyName': 'string',
'Receiver': {
'Account': {
'Alias': 'string',
'AwsAccountId': 'string'
}
},
'Catalog': 'string',
'RejectionReason': 'string',
'Payload': {
'OpportunityInvitation': {
'SenderContacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
'ReceiverResponsibilities': [
'Distributor'|'Reseller'|'Hardware Partner'|'Managed Service Provider'|'Software Partner'|'Services Partner'|'Training Partner'|'Co-Sell Facilitator'|'Facilitator',
],
'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': {
'BusinessProblem': 'string',
'Title': 'string',
'TargetCompletionDate': 'string',
'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'
},
]
}
},
'LeadInvitation': {
'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',
'AwsMaturity': 'string',
'MarketSegment': 'Enterprise'|'Large'|'Medium'|'Small'|'Micro'
},
'Interaction': {
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'ContactBusinessTitle': 'string'
}
}
},
'InvitationMessage': 'string',
'EngagementDescription': 'string',
'ExistingMembers': [
{
'CompanyName': 'string',
'WebsiteUrl': 'string'
},
]
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) that identifies the engagement invitation.
PayloadType (string) --
The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
Id (string) --
Unique identifier assigned to the engagement invitation being retrieved.
EngagementId (string) --
The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.
EngagementTitle (string) --
The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.
Status (string) --
The current status of the engagement invitation.
InvitationDate (datetime) --
The date when the engagement invitation was sent to the partner.
ExpirationDate (datetime) --
Indicates the date on which the engagement invitation will expire if not accepted by the partner.
SenderAwsAccountId (string) --
Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.
SenderCompanyName (string) --
The name of the AWS organization or team that sent the engagement invitation.
Receiver (dict) --
Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.
Account (dict) --
Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.
Alias (string) --
Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
AwsAccountId (string) --
Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.
Catalog (string) --
Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.
RejectionReason (string) --
If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.
Payload (dict) --
Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.
OpportunityInvitation (dict) --
Specifies the details of the opportunity invitation within the Engagement Invitation payload. This data helps partners understand the context, scope, and expected involvement for the opportunity from AWS.
SenderContacts (list) --
Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.
(dict) --
An object that contains the details of the sender-provided contact person for the EngagementInvitation.
Email (string) --
The sender-provided contact's email address associated with the EngagementInvitation.
FirstName (string) --
The sender-provided contact's last name associated with the EngagementInvitation.
LastName (string) --
The sender-provided contact's first name associated with the EngagementInvitation.
BusinessTitle (string) --
The sender-provided contact's title (job title or role) associated with the EngagementInvitation.
Phone (string) --
The sender-provided contact's phone number associated with the EngagementInvitation.
ReceiverResponsibilities (list) --
Outlines the responsibilities or expectations of the receiver in the context of the invitation.
(string) --
Customer (dict) --
Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements.
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) --
Describes the project details associated with the opportunity, including the customer’s needs and the scope of work expected to be performed.
BusinessProblem (string) --
Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s goals and objectives.
Title (string) --
Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.
TargetCompletionDate (string) --
Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.
ExpectedCustomerSpend (list) --
Contains revenue estimates for the partner related to the project. This field provides an idea of the financial potential of the opportunity for the partner.
(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.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Only the value Monthly is allowed for the Frequency field, representing recurring monthly spend.
TargetCompany (string) --
Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity. This field only accepts the value AWS. If any other value is provided, the system will automatically set it to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
LeadInvitation (dict) --
Specifies the details of the lead invitation within the Engagement Invitation payload. This data helps partners understand the lead context, customer information, and interaction history for the lead opportunity from AWS.
Customer (dict) --
Contains information about the customer associated with the lead invitation. This data helps partners understand the customer's profile, industry, and business context to assess the lead opportunity.
Industry (string) --
Specifies the industry sector of the customer company associated with the lead invitation. This categorization helps partners understand the customer's business context and assess solution fit.
CompanyName (string) --
The name of the customer company associated with the lead invitation. This field identifies the target organization for the lead engagement opportunity.
WebsiteUrl (string) --
The website URL of the customer company. This provides additional context about the customer organization and helps partners verify company details and assess business size and legitimacy.
CountryCode (string) --
The country code indicating the geographic location of the customer company. This information helps partners understand regional requirements and assess their ability to serve the customer effectively.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps partners understand the customer's cloud maturity and tailor their engagement approach accordingly.
MarketSegment (string) --
Specifies the market segment classification of the customer, such as enterprise, mid-market, or small business. This segmentation helps partners determine the appropriate solution complexity and engagement strategy.
Interaction (dict) --
Describes the interaction details associated with the lead, including the source of the lead generation and customer engagement information. This context helps partners evaluate the lead quality and engagement approach.
SourceType (string) --
Specifies the type of source that generated the lead interaction, such as "Event", "Website", or "Campaign". This helps partners understand the lead generation channel and assess lead quality based on the source type.
SourceId (string) --
The unique identifier of the specific source that generated the lead interaction. This provides traceability to the original lead generation activity for reference and follow-up purposes.
SourceName (string) --
The descriptive name of the source that generated the lead interaction. This human-readable identifier helps partners understand the specific lead generation channel or campaign that created the opportunity.
Usecase (string) --
Describes the specific use case or business scenario associated with the lead interaction. This information helps partners understand the customer's interests and potential solution requirements.
ContactBusinessTitle (string) --
The business title or job role of the customer contact involved in the lead interaction. This helps partners identify the decision-making level and engagement approach for the lead.
InvitationMessage (string) --
The message sent to the invited partner when the invitation was created.
EngagementDescription (string) --
The description of the engagement associated with this invitation.
ExistingMembers (list) --
A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.
CompanyName: The name of the member's company.
WebsiteUrl: The website URL of the member's company.
(dict) --
The EngagementMemberSummary provides a snapshot of essential information about participants in an AWS Partner Central Engagement. This compact data structure encapsulates key details of each member, facilitating efficient collaboration and management within the Engagement.
CompanyName (string) --
The official name of the member's company or organization.
WebsiteUrl (string) --
The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.
{'RelatedEntityIdentifiers': {'AwsMarketplaceOfferSets': ['string']}}
Fetches the Opportunity record from Partner Central by a given Identifier.
Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.
See also: AWS API Documentation
Request Syntax
client.get_opportunity(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure, isolated testing environment.
string
[REQUIRED]
Read-only, system generated Opportunity unique identifier.
dict
Response Syntax
{
'Catalog': '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',
],
'NationalSecurity': 'Yes'|'No',
'PartnerOpportunityIdentifier': 'string',
'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'
},
],
'Title': 'string',
'ApnPrograms': [
'string',
],
'CustomerBusinessProblem': 'string',
'CustomerUseCase': 'string',
'RelatedOpportunityIdentifier': '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',
],
'CompetitorName': 'Oracle Cloud'|'On-Prem'|'Co-location'|'Akamai'|'AliCloud'|'Google Cloud Platform'|'IBM Softlayer'|'Microsoft Azure'|'Other- Cost Optimization'|'No Competition'|'*Other',
'OtherCompetitorNames': 'string',
'OtherSolutionDescription': 'string',
'AdditionalComments': 'string'
},
'OpportunityType': 'Net New Business'|'Flat Renewal'|'Expansion',
'Marketing': {
'CampaignName': 'string',
'Source': 'Marketing Activity'|'None',
'UseCases': [
'string',
],
'Channels': [
'AWS Marketing Central'|'Content Syndication'|'Display'|'Email'|'Live Event'|'Out Of Home (OOH)'|'Print'|'Search'|'Social'|'Telemarketing'|'TV'|'Video'|'Virtual Event',
],
'AwsFundingUsed': 'Yes'|'No'
},
'SoftwareRevenue': {
'DeliveryModel': 'Contract'|'Pay-as-you-go'|'Subscription',
'Value': {
'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'
},
'EffectiveDate': 'string',
'ExpirationDate': 'string'
},
'Id': 'string',
'Arn': 'string',
'LastModifiedDate': datetime(2015, 1, 1),
'CreatedDate': datetime(2015, 1, 1),
'RelatedEntityIdentifiers': {
'AwsMarketplaceOffers': [
'string',
],
'AwsMarketplaceOfferSets': [
'string',
],
'Solutions': [
'string',
],
'AwsProducts': [
'string',
]
},
'LifeCycle': {
'Stage': 'Prospect'|'Qualified'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Closed Lost',
'ClosedLostReason': 'Customer Deficiency'|'Delay / Cancellation of Project'|'Legal / Tax / Regulatory'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'Lost to Competitor - Other'|'No Opportunity'|'On Premises Deployment'|'Partner Gap'|'Price'|'Security / Compliance'|'Technical Limitations'|'Customer Experience'|'Other'|'People/Relationship/Governance'|'Product/Technology'|'Financial/Commercial',
'NextSteps': 'string',
'TargetCloseDate': 'string',
'ReviewStatus': 'Pending Submission'|'Submitted'|'In review'|'Approved'|'Rejected'|'Action Required',
'ReviewComments': 'string',
'ReviewStatusReason': 'string',
'NextStepsHistory': [
{
'Value': 'string',
'Time': datetime(2015, 1, 1)
},
]
},
'OpportunityTeam': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
]
}
Response Structure
(dict) --
Catalog (string) --
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.
PrimaryNeedsFromAws (list) --
Identifies the type of support the partner needs from Amazon Web Services.
Valid values:
Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.
Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.
Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.
Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).
Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.
Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.
Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).
Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.
(string) --
NationalSecurity (string) --
Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.
PartnerOpportunityIdentifier (string) --
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.
Customer (dict) --
Specifies details of the customer associated with the Opportunity.
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) --
An object that contains project details summary for the Opportunity.
DeliveryModels (list) --
Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.
Options' descriptions from the Delivery Model field are:
SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment.
BYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer's Amazon Web Services environment.
Managed Services: The end customer's Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support).
Professional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning).
Resell: Amazon Web Services accounts and billing management for your customers.
Other: Delivery model not described above.
(string) --
ExpectedCustomerSpend (list) --
Represents the estimated amount that the customer is expected to spend on AWS services related to the opportunity. This helps in evaluating the potential financial value of the opportunity for AWS.
(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.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Only the value Monthly is allowed for the Frequency field, representing recurring monthly spend.
TargetCompany (string) --
Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity. This field only accepts the value AWS. If any other value is provided, the system will automatically set it to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
Title (string) --
Specifies the Opportunity's title or name.
ApnPrograms (list) --
Specifies the Amazon Partner Network (APN) program that influenced the Opportunity. APN programs refer to specific partner programs or initiatives that can impact the Opportunity.
Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS NDPP
(string) --
CustomerBusinessProblem (string) --
Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a concise narrative that outlines the customer's business challenge or issue. Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise language and precise descriptions to convey the context and significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic fit of the partner's solution.
CustomerUseCase (string) --
Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.
Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing/End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration/Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps
RelatedOpportunityIdentifier (string) --
Specifies the current opportunity's parent opportunity identifier.
SalesActivities (list) --
Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.
Valid values:
Initialized discussions with customer: Initial conversations with the customer to understand their needs and introduce your solution.
Customer has shown interest in solution: After initial discussions, the customer is interested in your solution.
Conducted POC/demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer.
In evaluation/planning stage: The customer is evaluating the solution and planning potential implementation.
Agreed on solution to Business Problem: Both parties agree on how the solution addresses the customer's business problem.
Completed Action Plan: A detailed action plan is complete and outlines the steps for implementation.
Finalized Deployment Need: Both parties agree with and finalized the deployment needs.
SOW Signed: Both parties signed a statement of work (SOW), and formalize the agreement and detail the project scope and deliverables.
(string) --
CompetitorName (string) --
Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.
OtherCompetitorNames (string) --
Only allowed when CompetitorNames has Other selected.
OtherSolutionDescription (string) --
Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.
AdditionalComments (string) --
Captures additional comments or information for the Opportunity that weren't captured in other fields.
OpportunityType (string) --
Specifies the opportunity type as renewal, new, or expansion.
Opportunity types:
New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.
Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, which helps to ensure service continuity.
Expansion opportunity: Represents an opportunity to expand the scope of a customer's contract or subscription, either by adding new services or increasing the volume of existing services.
Marketing (dict) --
An object that contains marketing details for the Opportunity.
CampaignName (string) --
Specifies the Opportunity marketing campaign code. The Amazon Web Services campaign code is a reference to specific marketing initiatives, promotions, or activities. This field captures the identifier used to track and categorize the Opportunity within marketing campaigns. If you don't have a campaign code, contact your Amazon Web Services point of contact to obtain one.
Source (string) --
Indicates if the Opportunity was sourced from an Amazon Web Services marketing activity. Use the value Marketing Activity. Use None if it's not associated with an Amazon Web Services marketing activity. This field helps Amazon Web Services track the return on marketing investments and enables better distribution of marketing budgets among partners.
UseCases (list) --
Specifies the marketing activity use case or purpose that led to the Opportunity's creation or contact. This field captures the context or marketing activity's execution's intention and the direct correlation to the generated opportunity or contact. Must be empty when Marketing.AWSFundingUsed = No.
Valid values: AI/ML | Analytics | Application Integration | Blockchain | Business Applications | Cloud Financial Management | Compute | Containers | Customer Engagement | Databases | Developer Tools | End User Computing | Front End Web & Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics | Satellite | Security | Serverless | Storage | VR & AR
(string) --
Channels (list) --
Specifies the Opportunity's channel that the marketing activity is associated with or was contacted through. This field provides information about the specific marketing channel that contributed to the generation of the lead or contact.
(string) --
AwsFundingUsed (string) --
Indicates if the Opportunity is a marketing development fund (MDF) funded activity.
SoftwareRevenue (dict) --
Specifies details of a customer's procurement terms. Required only for partners in eligible programs.
DeliveryModel (string) --
Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.
Value (dict) --
Specifies the payment value (amount and currency).
Amount (string) --
Specifies the payment amount.
CurrencyCode (string) --
Specifies the payment currency.
EffectiveDate (string) --
Specifies the Opportunity's customer engagement start date for the contract's effectiveness.
ExpirationDate (string) --
Specifies the expiration date for the contract between the customer and Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement period between both parties.
Id (string) --
Read-only, system generated Opportunity unique identifier.
Arn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the opportunity.
LastModifiedDate (datetime) --
DateTime when the opportunity was last modified.
CreatedDate (datetime) --
DateTime when the Opportunity was last created.
RelatedEntityIdentifiers (dict) --
Provides information about the associations of 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) --
LifeCycle (dict) --
An object that contains lifecycle details for the Opportunity.
Stage (string) --
Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.
The descriptions of each sales stage are:
Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).
Qualified: Your account team engaged with the customer to discuss viability and requirements. The customer agreed that the opportunity is real, of interest, and may solve business/technical needs.
Technical Validation: All parties understand the implementation plan.
Business Validation: Pricing was proposed, and all parties agree to the steps to close.
Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.
Launched: The workload is complete, and Amazon Web Services has started billing.
Closed Lost: The opportunity is lost, and there are no steps to move forward.
ClosedLostReason (string) --
Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes. The possible values are:
Customer Deficiency: The customer lacked necessary resources or capabilities.
Delay/Cancellation of Project: The project was delayed or canceled.
Legal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress.
Lost to Competitor—Google: The opportunity was lost to Google.
Lost to Competitor—Microsoft: The opportunity was lost to Microsoft.
Lost to Competitor—SoftLayer: The opportunity was lost to SoftLayer.
Lost to Competitor—VMWare: The opportunity was lost to VMWare.
Lost to Competitor—Other: The opportunity was lost to a competitor not listed above.
No Opportunity: There was no opportunity to pursue.
On Premises Deployment: The customer chose an on-premises solution.
Partner Gap: The partner lacked necessary resources or capabilities.
Price: The price was not competitive or acceptable to the customer.
Security/Compliance: Security or compliance issues prevented progress.
Technical Limitations: Technical limitations prevented progress.
Customer Experience: Issues related to the customer's experience impacted the decision.
Other: Any reason not covered by the other values.
People/Relationship/Governance: Issues related to people, relationships, or governance.
Product/Technology: Issues related to the product or technology.
Financial/Commercial: Financial or commercial issues impacted the decision.
NextSteps (string) --
Specifies the upcoming actions or tasks for the Opportunity. Use this field to communicate with Amazon Web Services about the next actions required for the Opportunity.
TargetCloseDate (string) --
Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.
Ensure the Target Close Date isn't in the past.
ReviewStatus (string) --
Indicates the review status of an opportunity referred by a partner. This field is read-only and only applicable for partner referrals. The possible values are:
Pending Submission: Not submitted for validation (editable).
Submitted: Submitted for validation, and Amazon Web Services hasn't reviewed it (read-only).
In Review: Amazon Web Services is validating (read-only).
Action Required: Issues that Amazon Web Services highlights need to be addressed. Partners should use the UpdateOpportunity API action to update the opportunity and helps to ensure that all required changes are made. Only the following fields are editable when the Lifecycle.ReviewStatus is Action Required:
Customer.Account.Address.City
Customer.Account.Address.CountryCode
Customer.Account.Address.PostalCode
Customer.Account.Address.StateOrRegion
Customer.Account.Address.StreetAddress
Customer.Account.WebsiteUrl
LifeCycle.TargetCloseDate
Project.ExpectedMonthlyAWSRevenue.Amount
Project.ExpectedMonthlyAWSRevenue.CurrencyCode
Project.CustomerBusinessProblem
PartnerOpportunityIdentifier
After updates, the opportunity re-enters the validation phase. This process repeats until all issues are resolved, and the opportunity's Lifecycle.ReviewStatus is set to Approved or Rejected.
Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).
Rejected: Disqualified (read-only).
ReviewComments (string) --
Contains detailed feedback from Amazon Web Services when requesting additional information from partners. Provides specific guidance on what partners need to provide or clarify for opportunity validation, complementing the ReviewStatusReason field.
ReviewStatusReason (string) --
Code indicating the validation decision during the Amazon Web Services opportunity review. Applies when status is Rejected or Action Required. Used to document validation results for AWS Partner Referrals and indicate when additional information is needed from partners as part of the APN Customer Engagement (ACE) program.
NextStepsHistory (list) --
Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.
(dict) --
Read-only; shows the last 50 values and change dates for the NextSteps field.
Value (string) --
Indicates the step's execution details.
Time (datetime) --
Indicates the step execution time.
OpportunityTeam (list) --
Represents the internal team handling the opportunity. Specify the members involved in collaborating on this 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.
{'Payload': {'OpportunitySummary': {'RelatedEntityIdentifiers': {'AwsMarketplaceOfferSets': ['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'
},
],
'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',
]
}
}
}
}
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.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Only the value Monthly is allowed for the Frequency field, representing recurring monthly spend.
TargetCompany (string) --
Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity. This field only accepts the value AWS. If any other value is provided, the system will automatically set it to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
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) --
{'TaskSummaries': {'ReasonCode': {'ContextNotFound',
'CustomerProjectContextNotPermitted',
'DisqualifiedLeadNotPermitted'}}}
Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account.
See also: AWS API Documentation
Request Syntax
client.list_engagement_by_accepting_invitation_tasks(
MaxResults=123,
NextToken='string',
Sort={
'SortOrder': 'ASCENDING'|'DESCENDING',
'SortBy': 'StartTime'
},
Catalog='string',
TaskStatus=[
'IN_PROGRESS'|'COMPLETE'|'FAILED',
],
OpportunityIdentifier=[
'string',
],
EngagementInvitationIdentifier=[
'string',
],
TaskIdentifier=[
'string',
]
)
integer
Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
string
Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.
dict
Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
SortOrder (string) -- [REQUIRED]
Determines the order in which the sorted results are presented.
SortBy (string) -- [REQUIRED]
Specifies the field by which the task list should be sorted.
string
[REQUIRED]
Specifies the catalog related to the request. Valid values are:
AWS: Retrieves the request from the production AWS environment.
Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.
list
Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
(string) --
list
Filters tasks by the identifiers of the opportunities they created or are associated with.
(string) --
list
Filters tasks by the identifiers of the engagement invitations they are processing.
(string) --
list
Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
(string) --
dict
Response Syntax
{
'TaskSummaries': [
{
'TaskId': 'string',
'TaskArn': 'string',
'StartTime': datetime(2015, 1, 1),
'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'Message': 'string',
'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled'|'ContextNotFound'|'CustomerProjectContextNotPermitted'|'DisqualifiedLeadNotPermitted',
'OpportunityId': 'string',
'ResourceSnapshotJobId': 'string',
'EngagementInvitationId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TaskSummaries (list) --
An array of EngagementByAcceptingInvitationTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.
(dict) --
Specifies a subset of fields associated with tasks related to accepting an engagement invitation.
TaskId (string) --
Unique identifier of the task.
TaskArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the task.
StartTime (datetime) --
Task start timestamp.
TaskStatus (string) --
Status of the task.
Message (string) --
Detailed message describing the failure and possible recovery steps.
ReasonCode (string) --
A code pointing to the specific reason for the failure.
OpportunityId (string) --
Unique identifier of opportunity that was created.
ResourceSnapshotJobId (string) --
Unique identifier of the resource snapshot job that was created.
EngagementInvitationId (string) --
The unique identifier of the engagement invitation that was accepted.
NextToken (string) --
A token used for pagination to retrieve the next page of results.If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.
{'TaskSummaries': {'ReasonCode': {'ContextNotFound',
'CustomerProjectContextNotPermitted',
'DisqualifiedLeadNotPermitted'}}}
Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account.
See also: AWS API Documentation
Request Syntax
client.list_engagement_from_opportunity_tasks(
MaxResults=123,
NextToken='string',
Sort={
'SortOrder': 'ASCENDING'|'DESCENDING',
'SortBy': 'StartTime'
},
Catalog='string',
TaskStatus=[
'IN_PROGRESS'|'COMPLETE'|'FAILED',
],
TaskIdentifier=[
'string',
],
OpportunityIdentifier=[
'string',
],
EngagementIdentifier=[
'string',
]
)
integer
Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
string
The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.
dict
Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
SortOrder (string) -- [REQUIRED]
Determines the order in which the sorted results are presented.
SortBy (string) -- [REQUIRED]
Specifies the field by which the task list should be sorted.
string
[REQUIRED]
Specifies the catalog related to the request. Valid values are:
AWS: Retrieves the request from the production AWS environment.
Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.
list
Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
(string) --
list
Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
(string) --
list
The identifier of the original opportunity associated with this task.
(string) --
list
Filters tasks by the identifiers of the engagements they created or are associated with.
(string) --
dict
Response Syntax
{
'TaskSummaries': [
{
'TaskId': 'string',
'TaskArn': 'string',
'StartTime': datetime(2015, 1, 1),
'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'Message': 'string',
'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled'|'ContextNotFound'|'CustomerProjectContextNotPermitted'|'DisqualifiedLeadNotPermitted',
'OpportunityId': 'string',
'ResourceSnapshotJobId': 'string',
'EngagementId': 'string',
'EngagementInvitationId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TaskSummaries (list) --
TaskSummaries An array of TaskSummary objects containing details about each task.
(dict) --
Provides a summary of a task related to creating an engagement from an opportunity. This structure contains key information about the task's status, associated identifiers, and any failure details.
TaskId (string) --
A unique identifier for a specific task.
TaskArn (string) --
The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
StartTime (datetime) --
The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.
TaskStatus (string) --
The current status of the task.
Message (string) --
A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution
ReasonCode (string) --
A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
OpportunityId (string) --
The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.
ResourceSnapshotJobId (string) --
The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.
EngagementId (string) --
The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.
EngagementInvitationId (string) --
The unique identifier of the Engagement Invitation.
NextToken (string) --
A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.
{'PayloadType': {'LeadInvitation'}}
Response {'EngagementInvitationSummaries': {'PayloadType': {'LeadInvitation'}}}
Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.
See also: AWS API Documentation
Request Syntax
client.list_engagement_invitations(
Catalog='string',
MaxResults=123,
NextToken='string',
Sort={
'SortOrder': 'ASCENDING'|'DESCENDING',
'SortBy': 'InvitationDate'
},
PayloadType=[
'OpportunityInvitation'|'LeadInvitation',
],
ParticipantType='SENDER'|'RECEIVER',
Status=[
'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED',
],
EngagementIdentifier=[
'string',
],
SenderAwsAccountId=[
'string',
]
)
string
[REQUIRED]
Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.
integer
Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
string
A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.
dict
Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.
SortOrder (string) -- [REQUIRED]
Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).
SortBy (string) -- [REQUIRED]
Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.
list
Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
(string) --
string
[REQUIRED]
Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
list
Status values to filter the invitations.
(string) --
list
Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.
(string) --
list
List of sender AWS account IDs to filter the invitations.
(string) --
dict
Response Syntax
{
'EngagementInvitationSummaries': [
{
'Arn': 'string',
'PayloadType': 'OpportunityInvitation'|'LeadInvitation',
'Id': 'string',
'EngagementId': 'string',
'EngagementTitle': 'string',
'Status': 'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED',
'InvitationDate': datetime(2015, 1, 1),
'ExpirationDate': datetime(2015, 1, 1),
'SenderAwsAccountId': 'string',
'SenderCompanyName': 'string',
'Receiver': {
'Account': {
'Alias': 'string',
'AwsAccountId': 'string'
}
},
'Catalog': 'string',
'ParticipantType': 'SENDER'|'RECEIVER'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EngagementInvitationSummaries (list) --
An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.
(dict) --
Provides a summarized view of the Engagement Invitation, including details like the identifier, status, and sender. This summary helps partners track and manage AWS originated opportunities.
Arn (string) --
The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique identifier that allows partners to reference the invitation in their system and manage its lifecycle.
PayloadType (string) --
Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.
Id (string) --
Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.
EngagementId (string) --
The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement.
EngagementTitle (string) --
Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.
Status (string) --
Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. The status helps track the progress and response to the invitation.
InvitationDate (datetime) --
Indicates the date when the Engagement Invitation was sent to the partner. This provides context for when the opportunity was shared and helps in tracking the timeline for engagement.
ExpirationDate (datetime) --
Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner.
SenderAwsAccountId (string) --
Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.
SenderCompanyName (string) --
Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement.
Receiver (dict) --
Specifies the partner company or individual that received the Engagement Invitation. This field is important for tracking who the invitation was sent to within the partner organization.
Account (dict) --
Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.
Alias (string) --
Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
AwsAccountId (string) --
Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.
Catalog (string) --
Specifies the catalog in which the Engagement Invitation resides. This can be either the AWS or Sandbox catalog, indicating whether the opportunity is live or being tested.
ParticipantType (string) --
Identifies the role of the caller in the engagement invitation.
NextToken (string) --
A pagination token returned when there are more results available than can be returned in a single call. Use this token to retrieve additional pages of engagement invitation summaries.
{'ContextTypes': ['CustomerProject | Lead'],
'ExcludeContextTypes': ['CustomerProject | Lead']}
Response {'EngagementSummaryList': {'ContextTypes': ['CustomerProject | Lead'],
'ModifiedAt': 'timestamp',
'ModifiedBy': 'string'}}
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',
],
ExcludeContextTypes=[
'CustomerProject'|'Lead',
],
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',
]
},
],
'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.
{'ReasonCode': {'ContextNotFound',
'CustomerProjectContextNotPermitted',
'DisqualifiedLeadNotPermitted'}}
This action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves the following steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS opportunity, and copying details for tracking. When completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.
See also: AWS API Documentation
Request Syntax
client.start_engagement_by_accepting_invitation_task(
Catalog='string',
ClientToken='string',
Identifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.
string
[REQUIRED]
A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.
list
A map of the key-value pairs of the tag or tags to assign.
(dict) --
The key-value pair assigned to a specified resource.
Key (string) -- [REQUIRED]
The key in the tag.
Value (string) -- [REQUIRED]
The value in the tag.
dict
Response Syntax
{
'TaskId': 'string',
'TaskArn': 'string',
'StartTime': datetime(2015, 1, 1),
'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'Message': 'string',
'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled'|'ContextNotFound'|'CustomerProjectContextNotPermitted'|'DisqualifiedLeadNotPermitted',
'OpportunityId': 'string',
'ResourceSnapshotJobId': 'string',
'EngagementInvitationId': 'string'
}
Response Structure
(dict) --
TaskId (string) --
The unique identifier of the task, used to track the task’s progress.
TaskArn (string) --
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
StartTime (datetime) --
The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
TaskStatus (string) --
Indicates the current status of the task.
Message (string) --
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
ReasonCode (string) --
Indicates the reason for task failure using an enumerated code.
OpportunityId (string) --
Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.
ResourceSnapshotJobId (string) --
The identifier of the Resource Snapshot Job created as part of this task.
EngagementInvitationId (string) --
Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.
{'ReasonCode': {'ContextNotFound',
'CustomerProjectContextNotPermitted',
'DisqualifiedLeadNotPermitted'}}
Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion. This action orchestrates a comprehensive workflow that combines multiple API operations into a single task to create and initiate an engagement from an existing opportunity. It automatically executes a sequence of operations including GetOpportunity, CreateEngagement (if it doesn't exist), CreateResourceSnapshot, CreateResourceSnapshotJob, CreateEngagementInvitation (if not already invited/accepted), and SubmitOpportunity.
See also: AWS API Documentation
Request Syntax
client.start_engagement_from_opportunity_task(
Catalog='string',
ClientToken='string',
Identifier='string',
AwsSubmission={
'InvolvementType': 'For Visibility Only'|'Co-Sell',
'Visibility': 'Full'|'Limited'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.
string
[REQUIRED]
A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.
dict
[REQUIRED]
Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.
InvolvementType (string) -- [REQUIRED]
Specifies the type of AWS involvement in the opportunity, such as coselling, deal support, or technical consultation. This helps categorize the nature of AWS participation.
Visibility (string) --
Determines who can view AWS involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.
list
A map of the key-value pairs of the tag or tags to assign.
(dict) --
The key-value pair assigned to a specified resource.
Key (string) -- [REQUIRED]
The key in the tag.
Value (string) -- [REQUIRED]
The value in the tag.
dict
Response Syntax
{
'TaskId': 'string',
'TaskArn': 'string',
'StartTime': datetime(2015, 1, 1),
'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'Message': 'string',
'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled'|'ContextNotFound'|'CustomerProjectContextNotPermitted'|'DisqualifiedLeadNotPermitted',
'OpportunityId': 'string',
'ResourceSnapshotJobId': 'string',
'EngagementId': 'string',
'EngagementInvitationId': 'string'
}
Response Structure
(dict) --
TaskId (string) --
The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.
TaskArn (string) --
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
StartTime (datetime) --
The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
TaskStatus (string) --
Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.
Message (string) --
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
ReasonCode (string) --
Indicates the reason for task failure using an enumerated code.
OpportunityId (string) --
Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.
ResourceSnapshotJobId (string) --
The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE
EngagementId (string) --
The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.
EngagementInvitationId (string) --
The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.