AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 <value>]
[--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>]
[--v2-debug]

Options

--catalog (string)

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.

--client-token (string)

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.

--title (string)

Specifies the title of the Engagement .

--description (string)

Provides a description of the Engagement .

--contexts (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.

(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.

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 -> (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.

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)

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 -> (structure)

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 -> (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”.

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 -> (structure)

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 -> (structure)

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.

(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)

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 -> (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)

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 -> (structure)

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.

JSON Syntax:

[
  {
    "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": timestamp,
            "CustomerAction": "string",
            "BusinessProblem": "string",
            "Contact": {
              "BusinessTitle": "string",
              "Email": "string",
              "FirstName": "string",
              "LastName": "string",
              "Phone": "string"
            }
          }
          ...
        ]
      }
    }
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Id -> (string)

Unique identifier assigned to the newly created engagement.

Arn -> (string)

The Amazon Resource Name (ARN) that identifies the engagement.

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”.