AWS cli documentation change
Summary
Updated CLI version reference, reordered parameters, added sorting documentation, expanded payload type details, restructured response field descriptions, and added sender identification fields
Security assessment
Changes primarily focus on improving command documentation structure and parameter descriptions. While new sender identification fields (SenderAwsAccountId/SenderCompanyName) and invitation expiration details improve traceability, there's no evidence these changes address a specific security vulnerability or weakness. The updates appear to be routine documentation improvements rather than security fixes.
Diff
diff --git a/cli/latest/reference/partnercentral-selling/list-engagement-invitations.md b/cli/latest/reference/partnercentral-selling/list-engagement-invitations.md index 706c4fdc6..4228c89bf 100644 --- a//cli/latest/reference/partnercentral-selling/list-engagement-invitations.md +++ b//cli/latest/reference/partnercentral-selling/list-engagement-invitations.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -70,4 +69,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne - [--engagement-identifier <value>] - --participant-type <value> - [--payload-type <value>] - [--sender-aws-account-id <value>] @@ -74,0 +71,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne + [--payload-type <value>] + --participant-type <value> @@ -75,0 +74,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne + [--engagement-identifier <value>] + [--sender-aws-account-id <value>] @@ -107 +107 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne -`--engagement-identifier` (list) +`--sort` (structure) @@ -109 +109,28 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne -> Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days. +> Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as `InvitationDate` or `Status` to help partners view results in their preferred order. +> +> SortOrder -> (string) +> +>> Defines the order in which the Engagement Invitations are sorted. The values can be `ASC` (ascending) or `DESC` (descending). +> +> SortBy -> (string) +> +>> Specifies the field by which the Engagement Invitations are sorted. Common values include `InvitationDate` and `Status` . + +Shorthand Syntax: + + + SortOrder=string,SortBy=string + + +JSON Syntax: + + + { + "SortOrder": "ASCENDING"|"DESCENDING", + "SortBy": "InvitationDate" + } + + +`--payload-type` (list) + +> Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation. @@ -117,0 +145,3 @@ Syntax: + Where valid values are: + OpportunityInvitation + @@ -130 +160 @@ Syntax: -`--payload-type` (list) +`--status` (list) @@ -132 +162 @@ Syntax: -> Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation. +> Status values to filter the invitations. @@ -142 +172,4 @@ Syntax: - OpportunityInvitation + ACCEPTED + PENDING + REJECTED + EXPIRED @@ -145 +178 @@ Syntax: -`--sender-aws-account-id` (list) +`--engagement-identifier` (list) @@ -147 +180 @@ Syntax: -> List of sender AWS account IDs to filter the invitations. +> Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days. @@ -157,28 +190 @@ Syntax: -`--sort` (structure) - -> Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as `InvitationDate` or `Status` to help partners view results in their preferred order. -> -> SortBy -> (string) -> ->> Specifies the field by which the Engagement Invitations are sorted. Common values include `InvitationDate` and `Status` . -> -> SortOrder -> (string) -> ->> Defines the order in which the Engagement Invitations are sorted. The values can be `ASC` (ascending) or `DESC` (descending). - -Shorthand Syntax: - - - SortBy=string,SortOrder=string - - -JSON Syntax: - - - { - "SortBy": "InvitationDate", - "SortOrder": "ASCENDING"|"DESCENDING" - } - - -`--status` (list) +`--sender-aws-account-id` (list) @@ -186 +192 @@ JSON Syntax: -> Status values to filter the invitations. +> List of sender AWS account IDs to filter the invitations. @@ -195,6 +200,0 @@ Syntax: - Where valid values are: - ACCEPTED - PENDING - REJECTED - EXPIRED - @@ -331 +331 @@ EngagementInvitationSummaries -> (list) ->> Catalog -> (string) +>> PayloadType -> (string) @@ -333 +333,5 @@ EngagementInvitationSummaries -> (list) ->>> Specifies the catalog in which the Engagement Invitation resides. This can be either the `AWS` or `Sandbox` catalog, indicating whether the opportunity is live or being tested. +>>> Describes the type of payload associated with the Engagement Invitation, such as `Opportunity` or `MarketplaceOffer` . This helps partners understand the nature of the engagement request from AWS. +>> +>> Id -> (string) +>> +>>> Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection. @@ -343,5 +347 @@ EngagementInvitationSummaries -> (list) ->> ExpirationDate -> (timestamp) ->> ->>> Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner. ->> ->> Id -> (string) +>> Status -> (string) @@ -349 +349 @@ EngagementInvitationSummaries -> (list) ->>> Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection. +>>> Represents the current status of the Engagement Invitation, such as `Pending` , `Accepted` , or `Rejected` . The status helps track the progress and response to the invitation. @@ -355 +355 @@ EngagementInvitationSummaries -> (list) ->> ParticipantType -> (string) +>> ExpirationDate -> (timestamp) @@ -357 +357 @@ EngagementInvitationSummaries -> (list) ->>> Identifies the role of the caller in the engagement invitation. +>>> Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner. @@ -359 +359 @@ EngagementInvitationSummaries -> (list) ->> PayloadType -> (string) +>> SenderAwsAccountId -> (string) @@ -361 +361,5 @@ EngagementInvitationSummaries -> (list) ->>> Describes the type of payload associated with the Engagement Invitation, such as `Opportunity` or `MarketplaceOffer` . This helps partners understand the nature of the engagement request from AWS. +>>> Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity. +>> +>> SenderCompanyName -> (string) +>> +>>> Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement. @@ -383,5 +387 @@ EngagementInvitationSummaries -> (list) ->> SenderAwsAccountId -> (string) ->> ->>> Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity. ->> ->> SenderCompanyName -> (string) +>> Catalog -> (string) @@ -389 +389 @@ EngagementInvitationSummaries -> (list) ->>> Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement. +>>> Specifies the catalog in which the Engagement Invitation resides. This can be either the `AWS` or `Sandbox` catalog, indicating whether the opportunity is live or being tested. @@ -391 +391 @@ EngagementInvitationSummaries -> (list) ->> Status -> (string) +>> ParticipantType -> (string) @@ -393 +393 @@ EngagementInvitationSummaries -> (list) ->>> Represents the current status of the Engagement Invitation, such as `Pending` , `Accepted` , or `Rejected` . The status helps track the progress and response to the invitation. +>>> Identifies the role of the caller in the engagement invitation. @@ -409 +409 @@ NextToken -> (string) - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) »