[ aws . partnercentral-selling ]

get-engagement-invitation

Description

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

Synopsis

  get-engagement-invitation
--catalog <value>
--identifier <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]

Options

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

Constraints:

• pattern: [a-zA-Z]+

--identifier (string) [required]

Specifies the unique identifier for the retrieved engagement invitation.

Constraints:

• min: 1
• max: 255
• pattern: (arn:.*|engi-[0-9a-z]{13})

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

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

Output

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.

Possible values:

• OpportunityInvitation

Id -> (string)

Unique identifier assigned to the engagement invitation being retrieved.

Constraints:

• min: 1
• max: 255
• pattern: (arn:.*|engi-[0-9a-z]{13})

EngagementId -> (string)

The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.

Constraints:

• pattern: eng-[0-9a-z]{14}

EngagementTitle -> (string)

The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.

Constraints:

• min: 1
• max: 40

Status -> (string)

The current status of the engagement invitation.

Possible values:

• ACCEPTED
• PENDING
• REJECTED
• EXPIRED

InvitationDate -> (timestamp)

The date when the engagement invitation was sent to the partner.

ExpirationDate -> (timestamp)

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.

Constraints:

• pattern: ([0-9]{12}|\w{1,12})

SenderCompanyName -> (string)

The name of the AWS organization or team that sent the engagement invitation.

Constraints:

• min: 0
• max: 120

Receiver -> (tagged union structure)

Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Account.

Account -> (structure)

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.

Constraints:

• min: 0
• max: 80

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.

Constraints:

• pattern: ([0-9]{12}|\w{1,12})

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.

Constraints:

• pattern: [a-zA-Z]+

RejectionReason -> (string)

If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

Constraints:

• pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]{1,80}

Payload -> (tagged union structure)

Details of the engagement invitation payload, including specific data relevant to the invitation’s contents, such as customer information and opportunity insights.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: OpportunityInvitation.

OpportunityInvitation -> (structure)

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.

Constraints:

• min: 1
• max: 3

(structure)

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 .

Constraints:

• min: 0
• max: 80
• pattern: [a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*

FirstName -> (string)

The sender-provided contact’s last name associated with the EngagementInvitation .

Constraints:

• min: 0
• max: 80

LastName -> (string)

The sender-provided contact’s first name associated with the EngagementInvitation .

Constraints:

• min: 0
• max: 80

BusinessTitle -> (string)

The sender-provided contact’s title (job title or role) associated with the EngagementInvitation .

Constraints:

• min: 0
• max: 80

Phone -> (string)

The sender-provided contact’s phone number associated with the EngagementInvitation .

Constraints:

• min: 0
• max: 40
• pattern: \+[1-9]\d{1,14}

ReceiverResponsibilities -> (list) [required]

Outlines the responsibilities or expectations of the receiver in the context of the invitation.

(string)

Possible values:

• Distributor
• Reseller
• Hardware Partner
• Managed Service Provider
• Software Partner
• Services Partner
• Training Partner
• Co-Sell Facilitator
• Facilitator

Customer -> (structure) [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.

Possible values:

• 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) [required]

Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.

Constraints:

• min: 1
• max: 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:

• min: 4
• max: 255
• pattern: ((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:

• 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 -> (structure) [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.

Constraints:

• min: 20
• max: 255

Title -> (string) [required]

Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.

Constraints:

• min: 1
• max: 255

TargetCompletionDate -> (string) [required]

Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.

Constraints:

• pattern: [1-9][0-9]{3}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

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.

Constraints:

• min: 0
• max: 10

(structure)

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.

Constraints:

• pattern: (0|([1-9][0-9]{0,30}))(\.[0-9]{0,2})?

CurrencyCode -> (string) [required]

Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

Possible values:

• 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

Constraints:

• pattern: USD

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.

Possible values:

• Monthly

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 .

Constraints:

• min: 1
• max: 80

EstimationUrl -> (string)

A URL providing additional information or context about the spend estimation.

Constraints:

• min: 4
• max: 255

InvitationMessage -> (string)

The message sent to the invited partner when the invitation was created.

Constraints:

• min: 1
• max: 255

EngagementDescription -> (string)

The description of the engagement associated with this invitation.

Constraints:

• min: 0
• max: 255

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.

(structure)

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.

Constraints:

• min: 1
• max: 120

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.