AWS cli medium security documentation change
Summary
Updated CLI version reference, restructured documentation for Engagement Invitation parameters with added field validations (e.g., Frequency restricted to 'Monthly', TargetCompany enforced to 'AWS'), and expanded JSON syntax examples.
Security assessment
The change restricts the 'TargetCompany' field to only accept 'AWS', automatically overriding other values. This prevents potential misconfiguration or impersonation by enforcing partner identity validation. The 'Frequency' field restriction to 'Monthly' also adds input validation but lacks explicit security context.
Diff
diff --git a/cli/latest/reference/partnercentral-selling/create-engagement-invitation.md b/cli/latest/reference/partnercentral-selling/create-engagement-invitation.md index 122378bd7..f1c68c525 100644 --- a//cli/latest/reference/partnercentral-selling/create-engagement-invitation.md +++ b//cli/latest/reference/partnercentral-selling/create-engagement-invitation.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -114,0 +115,20 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne +> Receiver -> (tagged union structure) +> +>> 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. +>> +>> ### 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. +>>> +>>> 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. +> @@ -127 +147 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne ->>> Customer -> (structure) +>>> SenderContacts -> (list) @@ -129,3 +149 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne ->>>> Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements. ->>>> ->>>> CompanyName -> (string) +>>>> Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders. @@ -133 +151 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne ->>>>> Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer. +>>>> (structure) @@ -135 +153,25 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne ->>>> CountryCode -> (string) +>>>>> 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. @@ -137 +179,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne ->>>>> Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs. +>>>> (string) +>>> +>>> Customer -> (structure) +>>> +>>>> Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements. @@ -142,0 +189,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne +>>>> CompanyName -> (string) +>>>> +>>>>> Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer. +>>>> @@ -145,0 +196,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne +>>>> +>>>> CountryCode -> (string) +>>>> +>>>>> Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs. @@ -154,0 +209,8 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne +>>>> 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. +>>>> @@ -171,4 +232,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne ->>>>>> EstimationUrl -> (string) ->>>>>> ->>>>>>> A URL providing additional information or context about the spend estimation. ->>>>>> @@ -177 +235 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne ->>>>>>> Indicates how frequently the customer is expected to spend the projected amount. This can include values such as `Monthly` , `Quarterly` , or `Annually` . The default value is `Monthly` , representing recurring monthly spend. +>>>>>>> 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. @@ -181,63 +239,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne ->>>>>>> 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. ->>>> ->>>> TargetCompletionDate -> (string) ->>>> ->>>>> Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations. ->>>> ->>>> Title -> (string) ->>>> ->>>>> Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project. ->>> ->>> ReceiverResponsibilities -> (list) ->>> ->>>> Outlines the responsibilities or expectations of the receiver in the context of the invitation. ->>>> ->>>> (string) ->>> ->>> SenderContacts -> (list) ->>> ->>>> Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders. ->>>> ->>>> (structure) ->>>> ->>>>> An object that contains the details of the sender-provided contact person for the `EngagementInvitation` . ->>>>> ->>>>> BusinessTitle -> (string) ->>>>> ->>>>>> The sender-provided contact’s title (job title or role) associated with 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` . ->>>>> ->>>>> Phone -> (string) ->>>>> ->>>>>> The sender-provided contact’s phone number associated with the `EngagementInvitation` . -> -> Receiver -> (tagged union structure) -> ->> 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. ->> ->> ### 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. ->>> ->>> 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. +>>>>>>> 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. @@ -249,0 +250,6 @@ JSON Syntax: + "Receiver": { + "Account": { + "Alias": "string", + "AwsAccountId": "string" + } + }, @@ -251,0 +258,11 @@ JSON Syntax: + "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", ...], @@ -253,2 +269,0 @@ JSON Syntax: - "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", @@ -256 +271,3 @@ JSON Syntax: - "WebsiteUrl": "string" + "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" @@ -259,0 +277,2 @@ JSON Syntax: + "Title": "string", + "TargetCompletionDate": "string", @@ -264 +282,0 @@ JSON Syntax: