AWS cli documentation change
Summary
Updated CLI reference version from 2.28.8 to 2.28.11. Modified multiple field descriptions and structure definitions in engagement invitation documentation, including changes to payload structure, member tracking, and invitation metadata.
Security assessment
The changes primarily involve structural reorganization and clarification of field descriptions without mentioning security controls, vulnerabilities, or protective measures. New fields like SenderAwsAccountId improve traceability but don't directly address security vulnerabilities. The tagged union structure enforces data validation but isn't explicitly security-related.
Diff
diff --git a/cli/latest/reference/partnercentral-selling/get-engagement-invitation.md b/cli/latest/reference/partnercentral-selling/get-engagement-invitation.md index 705fa41b5..269325405 100644 --- a//cli/latest/reference/partnercentral-selling/get-engagement-invitation.md +++ b//cli/latest/reference/partnercentral-selling/get-engagement-invitation.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -204 +204 @@ Arn -> (string) -Catalog -> (string) +PayloadType -> (string) @@ -206 +206 @@ 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. +> The type of payload contained in the engagement invitation, indicating what data or context the payload covers. @@ -208 +208 @@ Catalog -> (string) -EngagementDescription -> (string) +Id -> (string) @@ -210 +210 @@ EngagementDescription -> (string) -> The description of the engagement associated with this invitation. +> Unique identifier assigned to the engagement invitation being retrieved. @@ -220 +220 @@ EngagementTitle -> (string) -ExistingMembers -> (list) +Status -> (string) @@ -222 +222,21 @@ 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. +> The current status of the engagement invitation. + +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. + +SenderCompanyName -> (string) + +> The name of the AWS organization or team that sent the engagement invitation. + +Receiver -> (tagged union structure) + +> Information about the partner organization or team that received the engagement invitation, including contact details and identifiers. @@ -224,2 +244 @@ ExistingMembers -> (list) -> * CompanyName: The name of the member’s company. -> * WebsiteUrl: The website URL of the member’s company. +> ### Note @@ -227 +246 @@ ExistingMembers -> (list) - +> This is a Tagged Union structure. Only one of the following top level keys can be set: `Account`. @@ -229 +248 @@ ExistingMembers -> (list) -> (structure) +> Account -> (structure) @@ -231 +250 @@ ExistingMembers -> (list) ->> 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. +>> 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. @@ -233 +252 @@ ExistingMembers -> (list) ->> CompanyName -> (string) +>> Alias -> (string) @@ -235 +254 @@ ExistingMembers -> (list) ->>> The official name of the member’s company or organization. +>>> Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs. @@ -237 +256 @@ ExistingMembers -> (list) ->> WebsiteUrl -> (string) +>> AwsAccountId -> (string) @@ -239,9 +258 @@ ExistingMembers -> (list) ->>> 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. - -ExpirationDate -> (timestamp) - -> Indicates the date on which the engagement invitation will expire if not accepted by the partner. - -Id -> (string) - -> Unique identifier assigned to the engagement invitation being retrieved. +>>> 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. @@ -249 +260 @@ Id -> (string) -InvitationDate -> (timestamp) +Catalog -> (string) @@ -251 +262 @@ InvitationDate -> (timestamp) -> The date when the engagement invitation was sent to the partner. +> 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. @@ -253 +264 @@ InvitationDate -> (timestamp) -InvitationMessage -> (string) +RejectionReason -> (string) @@ -255 +266 @@ InvitationMessage -> (string) -> The message sent to the invited partner when the invitation was created. +> If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection. @@ -269 +280 @@ Payload -> (tagged union structure) ->> Customer -> (structure) +>> SenderContacts -> (list) @@ -271,3 +282 @@ Payload -> (tagged union 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. ->>> ->>> CompanyName -> (string) +>>> Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders. @@ -275 +284 @@ Payload -> (tagged union structure) ->>>> Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer. +>>> (structure) @@ -277 +286,25 @@ Payload -> (tagged union structure) ->>> 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. @@ -279 +312,5 @@ Payload -> (tagged union structure) ->>>> 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. @@ -284,0 +322,4 @@ Payload -> (tagged union structure) +>>> CompanyName -> (string) +>>> +>>>> Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer. +>>> @@ -287,0 +329,4 @@ Payload -> (tagged union structure) +>>> +>>> CountryCode -> (string) +>>> +>>>> Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs. @@ -296,0 +342,8 @@ Payload -> (tagged union structure) +>>> 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. +>>> @@ -313,4 +365,0 @@ Payload -> (tagged union structure) ->>>>> EstimationUrl -> (string) ->>>>> ->>>>>> A URL providing additional information or context about the spend estimation. ->>>>> @@ -319 +368 @@ Payload -> (tagged union structure) ->>>>>> 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. @@ -323,43 +372,5 @@ Payload -> (tagged union structure) ->>>>>> 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)