[ aws . partnercentral-selling ]
create-engagement¶
Description¶
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
Synopsis¶
create-engagement
--catalog <value>
[--client-token <value>]
--title <value>
--description <value>
[--contexts <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
Options¶
--catalog (string) [required]
The
CreateEngagementRequest$Catalogparameter specifies the catalog related to the engagement. Accepted values areAWSandSandbox, which determine the environment in which the engagement is managed.Constraints:
- pattern:
[a-zA-Z]+
--client-token (string)
The
CreateEngagementRequest$ClientTokenparameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.Constraints:
- pattern:
.{1,255}
--title (string) [required]
Specifies the title of the
Engagement.Constraints:
- pattern:
(?s).{1,40}
--description (string) [required]
Provides a description of the
Engagement.Constraints:
- pattern:
(?s).{0,255}
--contexts (list)
The
Contextsfield 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 aTypefield indicating the context type, which must beCustomerProjectin this version, and aPayloadfield containing theCustomerProjectdetails. TheCustomerProjectobject is composed of two main components:CustomerandProject. TheCustomerobject includes information such asCompanyName,WebsiteUrl,Industry, andCountryCode, providing essential details about the customer. TheProjectobject containsTitle,BusinessProblem, andTargetCompletionDate, 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.Constraints:
- min:
0- max:
5(structure)
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.
Constraints:
- pattern:
(?s).{1,3}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.
Possible values:
CustomerProjectLeadProspectingResultPayload -> (tagged union structure)
Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:CustomerProject,Lead,ProspectingResult.CustomerProject -> (structure)
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 -> (structure)
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.
Possible values:
AerospaceAgricultureAutomotiveComputers and ElectronicsConsumer GoodsEducationEnergy - Oil and GasEnergy - Power and UtilitiesFinancial ServicesGamingGovernmentHealthcareHospitalityLife SciencesManufacturingMarketing and AdvertisingMedia and EntertainmentMiningNon-Profit OrganizationProfessional ServicesReal Estate and ConstructionRetailSoftware and InternetTelecommunicationsTransportation and LogisticsTravelWholesale and DistributionOtherCompanyName -> (string) [required]
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
Constraints:
- pattern:
(?s).{1,120}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.
Constraints:
- pattern:
(?=.{4,255}$)((http|https)://)??(www[.])??([a-zA-Z0-9]|-)+?([.][a-zA-Z0-9(-|/|=|?)??]+?)+?CountryCode -> (string) [required]
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Possible values:
USAFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRCIHRCUCWCYCZCDDKDJDMDOECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKRKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSZSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWProject -> (structure)
Information about the customer project associated with the Engagement.
Title -> (string) [required]
The title of the project.
Constraints:
- pattern:
(?s).{1,255}BusinessProblem -> (string) [required]
A description of the business problem the project aims to solve.
Constraints:
- pattern:
(?s).{20,2000}TargetCompletionDate -> (string) [required]
The target completion date for the customer’s project.
Constraints:
- pattern:
[1-9][0-9]{3}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])Lead -> (structure)
Contains detailed information about a lead when the context type is “Lead”. This field is present only when the Type in EngagementContextDetails is set to “Lead”.
Insights -> (structure)
Insights that AI generates and associates with the lead. These insights provide automated analysis such as lead readiness scoring to help partners assess the lead quality.
LeadReadinessScore -> (string)
A score that indicates the lead’s readiness for engagement. Valid values areLow,Medium, andHigh. Use this score to prioritize leads based on their likelihood of conversion.QualificationStatus -> (string)
Indicates the current qualification status of the lead, such as whether it has been qualified, disqualified, or is still under evaluation. This helps track the lead’s progression through the qualification process.
Constraints:
- pattern:
(?s).{1,255}Customer -> (structure) [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.
Possible values:
AerospaceAgricultureAutomotiveComputers and ElectronicsConsumer GoodsEducationEnergy - Oil and GasEnergy - Power and UtilitiesFinancial ServicesGamingGovernmentHealthcareHospitalityLife SciencesManufacturingMarketing and AdvertisingMedia and EntertainmentMiningNon-Profit OrganizationProfessional ServicesReal Estate and ConstructionRetailSoftware and InternetTelecommunicationsTransportation and LogisticsTravelWholesale and DistributionOtherCompanyName -> (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.
Constraints:
- pattern:
(?s).{1,120}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.
Constraints:
- pattern:
(?=.{4,255}$)((http|https)://)??(www[.])??([a-zA-Z0-9]|-)+?([.][a-zA-Z0-9(-|/|=|?)??]+?)+?Address -> (structure) [required]
An object that contains an
Addressobject’s subset of fields.City -> (string)
Specifies the end
Customer‘s city associated with theOpportunity.Constraints:
- pattern:
(?s).{0,255}PostalCode -> (string)
Specifies the end
Customer‘s postal code associated with theOpportunity.Constraints:
- pattern:
(?s).{0,20}StateOrRegion -> (string)
Specifies the end
Customer‘s state or region associated with theOpportunity.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, APCountryCode -> (string)
Specifies the end
Customer‘s country associated with theOpportunity.Possible values:
USAFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRCIHRCUCWCYCZCDDKDJDMDOECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKRKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSZSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAwsMaturity -> (string)
Indicates the customer’s level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
Constraints:
- pattern:
(?s).{1,20}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.
Possible values:
EnterpriseLargeMediumSmallMicroInteractions -> (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.
Constraints:
- min:
1- max:
10(structure)
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.
Constraints:
- pattern:
(?s).{1,255}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.
Constraints:
- pattern:
(?s).{1,255}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.
Constraints:
- pattern:
(?s).{1,255}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.
Constraints:
- pattern:
(?s).{1,255}InteractionDate -> (timestamp)
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.
Constraints:
- pattern:
(?s).{1,255}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.
Constraints:
- pattern:
(?s).{20,2000}Contact -> (structure) [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.
Constraints:
- pattern:
(?s).{0,80}Email -> (string) [required]
The lead contact’s email address associated with the engagement.
Constraints:
- pattern:
(?=.{0,80}$)[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?FirstName -> (string) [required]
The lead contact’s first name associated with the engagement.
Constraints:
- pattern:
(?s).{0,80}LastName -> (string) [required]
The lead contact’s last name associated with the engagement.
Constraints:
- pattern:
(?s).{0,80}Phone -> (string)
The lead contact’s phone number associated with the engagement.
Constraints:
- pattern:
\+[1-9]\d{1,14}ProspectingResult -> (structure)
Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is “ProspectingResult”.
Aws -> (structure)
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
StartTime -> (timestamp)
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).EndTime -> (timestamp)
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).TaskId -> (string)
The unique identifier of the prospecting task that generates this result.
Constraints:
- pattern:
task-[0-9a-z]{14}TaskArn -> (string)
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
Constraints:
- pattern:
arn:.*TaskName -> (string)
The name that the user provides for the prospecting task that generates this result.
Constraints:
- min:
1- max:
128Customer -> (structure)
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName -> (string)
The name of the prospected customer account.
Constraints:
- min:
0- max:
255Geo -> (string)
The geographic region classification of the prospected customer account.
Constraints:
- min:
0- max:
255Region -> (string)
The specific region of the prospected customer account.
Constraints:
- min:
0- max:
255SubRegion -> (string)
The subregion classification of the prospected customer account.
Constraints:
- min:
0- max:
255Country -> (string)
The country code of the prospected customer account.
Possible values:
USAFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRCIHRCUCWCYCZCDDKDJDMDOECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKRKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSZSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWIndustry -> (string)
The industry classification of the prospected customer account.
Possible values:
AerospaceAgricultureAutomotiveComputers and ElectronicsConsumer GoodsEducationEnergy - Oil and GasEnergy - Power and UtilitiesFinancial ServicesGamingGovernmentHealthcareHospitalityLife SciencesManufacturingMarketing and AdvertisingMedia and EntertainmentMiningNon-Profit OrganizationProfessional ServicesReal Estate and ConstructionRetailSoftware and InternetTelecommunicationsTransportation and LogisticsTravelWholesale and DistributionOtherSubIndustry -> (string)
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Constraints:
- min:
0- max:
255Segment -> (string)
The market segment classification of the prospected customer account.
Constraints:
- min:
0- max:
255CompanySize -> (string)
The company size classification of the prospected customer account.
Constraints:
- min:
0- max:
255EligiblePrograms -> (list)
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string)
PublicProfileSummary -> (string)
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Constraints:
- min:
0- max:
5000Insights -> (structure)
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore -> (string)
A score that indicates the prospected customer’s level of engagement with AWS Marketplace. Valid values are
High,Medium, andLow.Constraints:
- min:
0- max:
255SolutionScore -> (string)
A score that indicates how well the partner’s solution fits the prospected customer’s needs.SolutionCategory -> (string)
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.SolutionSubCategory -> (string)
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
JSON Syntax:
[
{
"Id": "string",
"Type": "CustomerProject"|"Lead"|"ProspectingResult",
"Payload": {
"CustomerProject": {
"Customer": {
"Industry": "Aerospace"|"Agriculture"|"Automotive"|"Computers and Electronics"|"Consumer Goods"|"Education"|"Energy - Oil and Gas"|"Energy - Power and Utilities"|"Financial Services"|"Gaming"|"Government"|"Healthcare"|"Hospitality"|"Life Sciences"|"Manufacturing"|"Marketing and Advertising"|"Media and Entertainment"|"Mining"|"Non-Profit Organization"|"Professional Services"|"Real Estate and Construction"|"Retail"|"Software and Internet"|"Telecommunications"|"Transportation and Logistics"|"Travel"|"Wholesale and Distribution"|"Other",
"CompanyName": "string",
"WebsiteUrl": "string",
"CountryCode": "US"|"AF"|"AX"|"AL"|"DZ"|"AS"|"AD"|"AO"|"AI"|"AQ"|"AG"|"AR"|"AM"|"AW"|"AU"|"AT"|"AZ"|"BS"|"BH"|"BD"|"BB"|"BY"|"BE"|"BZ"|"BJ"|"BM"|"BT"|"BO"|"BQ"|"BA"|"BW"|"BV"|"BR"|"IO"|"BN"|"BG"|"BF"|"BI"|"KH"|"CM"|"CA"|"CV"|"KY"|"CF"|"TD"|"CL"|"CN"|"CX"|"CC"|"CO"|"KM"|"CG"|"CK"|"CR"|"CI"|"HR"|"CU"|"CW"|"CY"|"CZ"|"CD"|"DK"|"DJ"|"DM"|"DO"|"EC"|"EG"|"SV"|"GQ"|"ER"|"EE"|"ET"|"FK"|"FO"|"FJ"|"FI"|"FR"|"GF"|"PF"|"TF"|"GA"|"GM"|"GE"|"DE"|"GH"|"GI"|"GR"|"GL"|"GD"|"GP"|"GU"|"GT"|"GG"|"GN"|"GW"|"GY"|"HT"|"HM"|"VA"|"HN"|"HK"|"HU"|"IS"|"IN"|"ID"|"IR"|"IQ"|"IE"|"IM"|"IL"|"IT"|"JM"|"JP"|"JE"|"JO"|"KZ"|"KE"|"KI"|"KR"|"KW"|"KG"|"LA"|"LV"|"LB"|"LS"|"LR"|"LY"|"LI"|"LT"|"LU"|"MO"|"MK"|"MG"|"MW"|"MY"|"MV"|"ML"|"MT"|"MH"|"MQ"|"MR"|"MU"|"YT"|"MX"|"FM"|"MD"|"MC"|"MN"|"ME"|"MS"|"MA"|"MZ"|"MM"|"NA"|"NR"|"NP"|"NL"|"AN"|"NC"|"NZ"|"NI"|"NE"|"NG"|"NU"|"NF"|"MP"|"NO"|"OM"|"PK"|"PW"|"PS"|"PA"|"PG"|"PY"|"PE"|"PH"|"PN"|"PL"|"PT"|"PR"|"QA"|"RE"|"RO"|"RU"|"RW"|"BL"|"SH"|"KN"|"LC"|"MF"|"PM"|"VC"|"WS"|"SM"|"ST"|"SA"|"SN"|"RS"|"SC"|"SL"|"SG"|"SX"|"SK"|"SI"|"SB"|"SO"|"ZA"|"GS"|"SS"|"ES"|"LK"|"SD"|"SR"|"SJ"|"SZ"|"SE"|"CH"|"SY"|"TW"|"TJ"|"TZ"|"TH"|"TL"|"TG"|"TK"|"TO"|"TT"|"TN"|"TR"|"TM"|"TC"|"TV"|"UG"|"UA"|"AE"|"GB"|"UM"|"UY"|"UZ"|"VU"|"VE"|"VN"|"VG"|"VI"|"WF"|"EH"|"YE"|"ZM"|"ZW"
},
"Project": {
"Title": "string",
"BusinessProblem": "string",
"TargetCompletionDate": "string"
}
},
"Lead": {
"Insights": {
"LeadReadinessScore": "string"
},
"QualificationStatus": "string",
"Customer": {
"Industry": "Aerospace"|"Agriculture"|"Automotive"|"Computers and Electronics"|"Consumer Goods"|"Education"|"Energy - Oil and Gas"|"Energy - Power and Utilities"|"Financial Services"|"Gaming"|"Government"|"Healthcare"|"Hospitality"|"Life Sciences"|"Manufacturing"|"Marketing and Advertising"|"Media and Entertainment"|"Mining"|"Non-Profit Organization"|"Professional Services"|"Real Estate and Construction"|"Retail"|"Software and Internet"|"Telecommunications"|"Transportation and Logistics"|"Travel"|"Wholesale and Distribution"|"Other",
"CompanyName": "string",
"WebsiteUrl": "string",
"Address": {
"City": "string",
"PostalCode": "string",
"StateOrRegion": "string",
"CountryCode": "US"|"AF"|"AX"|"AL"|"DZ"|"AS"|"AD"|"AO"|"AI"|"AQ"|"AG"|"AR"|"AM"|"AW"|"AU"|"AT"|"AZ"|"BS"|"BH"|"BD"|"BB"|"BY"|"BE"|"BZ"|"BJ"|"BM"|"BT"|"BO"|"BQ"|"BA"|"BW"|"BV"|"BR"|"IO"|"BN"|"BG"|"BF"|"BI"|"KH"|"CM"|"CA"|"CV"|"KY"|"CF"|"TD"|"CL"|"CN"|"CX"|"CC"|"CO"|"KM"|"CG"|"CK"|"CR"|"CI"|"HR"|"CU"|"CW"|"CY"|"CZ"|"CD"|"DK"|"DJ"|"DM"|"DO"|"EC"|"EG"|"SV"|"GQ"|"ER"|"EE"|"ET"|"FK"|"FO"|"FJ"|"FI"|"FR"|"GF"|"PF"|"TF"|"GA"|"GM"|"GE"|"DE"|"GH"|"GI"|"GR"|"GL"|"GD"|"GP"|"GU"|"GT"|"GG"|"GN"|"GW"|"GY"|"HT"|"HM"|"VA"|"HN"|"HK"|"HU"|"IS"|"IN"|"ID"|"IR"|"IQ"|"IE"|"IM"|"IL"|"IT"|"JM"|"JP"|"JE"|"JO"|"KZ"|"KE"|"KI"|"KR"|"KW"|"KG"|"LA"|"LV"|"LB"|"LS"|"LR"|"LY"|"LI"|"LT"|"LU"|"MO"|"MK"|"MG"|"MW"|"MY"|"MV"|"ML"|"MT"|"MH"|"MQ"|"MR"|"MU"|"YT"|"MX"|"FM"|"MD"|"MC"|"MN"|"ME"|"MS"|"MA"|"MZ"|"MM"|"NA"|"NR"|"NP"|"NL"|"AN"|"NC"|"NZ"|"NI"|"NE"|"NG"|"NU"|"NF"|"MP"|"NO"|"OM"|"PK"|"PW"|"PS"|"PA"|"PG"|"PY"|"PE"|"PH"|"PN"|"PL"|"PT"|"PR"|"QA"|"RE"|"RO"|"RU"|"RW"|"BL"|"SH"|"KN"|"LC"|"MF"|"PM"|"VC"|"WS"|"SM"|"ST"|"SA"|"SN"|"RS"|"SC"|"SL"|"SG"|"SX"|"SK"|"SI"|"SB"|"SO"|"ZA"|"GS"|"SS"|"ES"|"LK"|"SD"|"SR"|"SJ"|"SZ"|"SE"|"CH"|"SY"|"TW"|"TJ"|"TZ"|"TH"|"TL"|"TG"|"TK"|"TO"|"TT"|"TN"|"TR"|"TM"|"TC"|"TV"|"UG"|"UA"|"AE"|"GB"|"UM"|"UY"|"UZ"|"VU"|"VE"|"VN"|"VG"|"VI"|"WF"|"EH"|"YE"|"ZM"|"ZW"
},
"AwsMaturity": "string",
"MarketSegment": "Enterprise"|"Large"|"Medium"|"Small"|"Micro"
},
"Interactions": [
{
"SourceType": "string",
"SourceId": "string",
"SourceName": "string",
"Usecase": "string",
"InteractionDate": timestamp,
"CustomerAction": "string",
"BusinessProblem": "string",
"Contact": {
"BusinessTitle": "string",
"Email": "string",
"FirstName": "string",
"LastName": "string",
"Phone": "string"
}
}
...
]
},
"ProspectingResult": {
"Aws": {
"StartTime": timestamp,
"EndTime": timestamp,
"TaskId": "string",
"TaskArn": "string",
"TaskName": "string",
"Customer": {
"AccountName": "string",
"Geo": "string",
"Region": "string",
"SubRegion": "string",
"Country": "US"|"AF"|"AX"|"AL"|"DZ"|"AS"|"AD"|"AO"|"AI"|"AQ"|"AG"|"AR"|"AM"|"AW"|"AU"|"AT"|"AZ"|"BS"|"BH"|"BD"|"BB"|"BY"|"BE"|"BZ"|"BJ"|"BM"|"BT"|"BO"|"BQ"|"BA"|"BW"|"BV"|"BR"|"IO"|"BN"|"BG"|"BF"|"BI"|"KH"|"CM"|"CA"|"CV"|"KY"|"CF"|"TD"|"CL"|"CN"|"CX"|"CC"|"CO"|"KM"|"CG"|"CK"|"CR"|"CI"|"HR"|"CU"|"CW"|"CY"|"CZ"|"CD"|"DK"|"DJ"|"DM"|"DO"|"EC"|"EG"|"SV"|"GQ"|"ER"|"EE"|"ET"|"FK"|"FO"|"FJ"|"FI"|"FR"|"GF"|"PF"|"TF"|"GA"|"GM"|"GE"|"DE"|"GH"|"GI"|"GR"|"GL"|"GD"|"GP"|"GU"|"GT"|"GG"|"GN"|"GW"|"GY"|"HT"|"HM"|"VA"|"HN"|"HK"|"HU"|"IS"|"IN"|"ID"|"IR"|"IQ"|"IE"|"IM"|"IL"|"IT"|"JM"|"JP"|"JE"|"JO"|"KZ"|"KE"|"KI"|"KR"|"KW"|"KG"|"LA"|"LV"|"LB"|"LS"|"LR"|"LY"|"LI"|"LT"|"LU"|"MO"|"MK"|"MG"|"MW"|"MY"|"MV"|"ML"|"MT"|"MH"|"MQ"|"MR"|"MU"|"YT"|"MX"|"FM"|"MD"|"MC"|"MN"|"ME"|"MS"|"MA"|"MZ"|"MM"|"NA"|"NR"|"NP"|"NL"|"AN"|"NC"|"NZ"|"NI"|"NE"|"NG"|"NU"|"NF"|"MP"|"NO"|"OM"|"PK"|"PW"|"PS"|"PA"|"PG"|"PY"|"PE"|"PH"|"PN"|"PL"|"PT"|"PR"|"QA"|"RE"|"RO"|"RU"|"RW"|"BL"|"SH"|"KN"|"LC"|"MF"|"PM"|"VC"|"WS"|"SM"|"ST"|"SA"|"SN"|"RS"|"SC"|"SL"|"SG"|"SX"|"SK"|"SI"|"SB"|"SO"|"ZA"|"GS"|"SS"|"ES"|"LK"|"SD"|"SR"|"SJ"|"SZ"|"SE"|"CH"|"SY"|"TW"|"TJ"|"TZ"|"TH"|"TL"|"TG"|"TK"|"TO"|"TT"|"TN"|"TR"|"TM"|"TC"|"TV"|"UG"|"UA"|"AE"|"GB"|"UM"|"UY"|"UZ"|"VU"|"VE"|"VN"|"VG"|"VI"|"WF"|"EH"|"YE"|"ZM"|"ZW",
"Industry": "Aerospace"|"Agriculture"|"Automotive"|"Computers and Electronics"|"Consumer Goods"|"Education"|"Energy - Oil and Gas"|"Energy - Power and Utilities"|"Financial Services"|"Gaming"|"Government"|"Healthcare"|"Hospitality"|"Life Sciences"|"Manufacturing"|"Marketing and Advertising"|"Media and Entertainment"|"Mining"|"Non-Profit Organization"|"Professional Services"|"Real Estate and Construction"|"Retail"|"Software and Internet"|"Telecommunications"|"Transportation and Logistics"|"Travel"|"Wholesale and Distribution"|"Other",
"SubIndustry": "string",
"Segment": "string",
"CompanySize": "string",
"EligiblePrograms": ["string", ...],
"PublicProfileSummary": "string"
},
"Insights": {
"MarketplaceEngagementScore": "string",
"SolutionScore": "string",
"SolutionCategory": "string",
"SolutionSubCategory": "string"
}
}
}
}
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
- off
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
- legacy
- json
- yaml
- text
- table
- enhanced
Output¶
Id -> (string)
Unique identifier assigned to the newly created engagement.
Constraints:
- pattern:
eng-[0-9a-z]{14}
Arn -> (string)
The Amazon Resource Name (ARN) that identifies the engagement.
Constraints:
- pattern:
arn:.*
ModifiedAt -> (timestamp)
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”.