AWS cli documentation change
Summary
Updated CLI version reference from 2.28.8 to 2.28.11, reordered command parameters, added new field descriptions for opportunity sorting/spend estimation, and improved documentation structure
Security assessment
Changes primarily involve documentation structure improvements, parameter reordering, and added field descriptions without mentioning security vulnerabilities or protections. The added 'Catalog' field clarification (AWS/Sandbox) and payload identifier tracking are operational clarifications rather than security fixes.
Diff
diff --git a/cli/latest/reference/partnercentral-selling/list-opportunities.md b/cli/latest/reference/partnercentral-selling/list-opportunities.md index ac6baf79e..2cbb2cb1a 100644 --- a//cli/latest/reference/partnercentral-selling/list-opportunities.md +++ b//cli/latest/reference/partnercentral-selling/list-opportunities.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -61 +61 @@ This request accepts a list of filters that retrieve opportunity subsets as well -To synchronize your system with Amazon Web Services, only list the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus, you can also use the `ListOpportunities` action. +To synchronize your system with Amazon Web Services, list only the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus. You can also use the `ListOpportunities` action. @@ -80,2 +80 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne - [--customer-company-name <value>] - [--identifier <value>] + [--sort <value>] @@ -83 +82 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne - [--life-cycle-review-status <value>] + [--identifier <value>] @@ -85 +84,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne - [--sort <value>] + [--life-cycle-review-status <value>] + [--customer-company-name <value>] @@ -117 +117 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne -`--customer-company-name` (list) +`--sort` (structure) @@ -119 +119 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne -> Filters the opportunities based on the customer’s company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string. +> An object that specifies how the response is sorted. The default `Sort.SortBy` value is `LastModifiedDate` . @@ -121,4 +121,9 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/partne -> (string) - -Syntax: - +> SortOrder -> (string) +> +>> Sort order. +>> +>> Default: `Descending` +> +> SortBy -> (string) +> +>> Field name to sort by. @@ -126 +131 @@ Syntax: - "string" "string" ... +Shorthand Syntax: @@ -129 +134 @@ Syntax: -`--identifier` (list) + SortOrder=string,SortBy=string @@ -131,3 +135,0 @@ Syntax: -> Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results. -> -> (string) @@ -135 +137 @@ Syntax: -Syntax: +JSON Syntax: @@ -138 +140,4 @@ Syntax: - "string" "string" ... + { + "SortOrder": "ASCENDING"|"DESCENDING", + "SortBy": "LastModifiedDate"|"Identifier"|"CustomerCompanyName" + } @@ -168 +173 @@ JSON Syntax: -`--life-cycle-review-status` (list) +`--identifier` (list) @@ -170 +175 @@ JSON Syntax: -> Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as `Pending Submission` , `In Review` , `Action Required` , or `Approved` . +> Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results. @@ -179,8 +183,0 @@ Syntax: - Where valid values are: - Pending Submission - Submitted - In review - Approved - Rejected - Action Required - @@ -209 +206 @@ Syntax: -`--sort` (structure) +`--life-cycle-review-status` (list) @@ -211,7 +208 @@ Syntax: -> An object that specifies how the response is sorted. The default `Sort.SortBy` value is `LastModifiedDate` . -> -> SortBy -> (string) -> ->> Field name to sort by. -> -> SortOrder -> (string) +> Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as `Pending Submission` , `In Review` , `Action Required` , or `Approved` . @@ -219,3 +210 @@ Syntax: ->> Sort order. ->> ->> Default: `Descending` +> (string) @@ -223 +212 @@ Syntax: -Shorthand Syntax: +Syntax: @@ -226 +215 @@ Shorthand Syntax: - SortBy=string,SortOrder=string + "string" "string" ... @@ -227,0 +217,7 @@ Shorthand Syntax: + Where valid values are: + Pending Submission + Submitted + In review + Approved + Rejected + Action Required @@ -229 +224,0 @@ Shorthand Syntax: -JSON Syntax: @@ -230,0 +226,7 @@ JSON Syntax: +`--customer-company-name` (list) + +> Filters the opportunities based on the customer’s company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string. +> +> (string) + +Syntax: @@ -232,4 +234,2 @@ JSON Syntax: - { - "SortBy": "LastModifiedDate"|"Identifier"|"CustomerCompanyName", - "SortOrder": "ASCENDING"|"DESCENDING" - } + + "string" "string" ... @@ -355,4 +354,0 @@ Disable automatically prompt for CLI input parameters. -NextToken -> (string) - -> A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available. - @@ -366,0 +363,8 @@ OpportunitySummaries -> (list) +>> Catalog -> (string) +>> +>>> Specifies the catalog associated with the opportunity, either `AWS` or `Sandbox` . This indicates the environment in which the opportunity is managed. +>> +>> Id -> (string) +>> +>>> Read-only, system-generated `Opportunity` unique identifier. +>> @@ -371 +375 @@ OpportunitySummaries -> (list) ->> Catalog -> (string) +>> PartnerOpportunityIdentifier -> (string) @@ -373 +377,17 @@ OpportunitySummaries -> (list) ->>> Specifies the catalog associated with the opportunity, either `AWS` or `Sandbox` . This indicates the environment in which the opportunity is managed. +>>> Specifies the `Opportunity` ‘s unique identifier in the partner’s CRM system. This value is essential to track and reconcile because it’s included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM. +>> +>> OpportunityType -> (string) +>> +>>> Specifies opportunity type as a renewal, new, or expansion. +>>> +>>> Opportunity types: +>>> +>>> * New Opportunity: Represents a new business opportunity with a potential customer that’s not previously engaged with your solutions or services. +>>> * Renewal Opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service. +>>> * Expansion Opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer. +>>> + +>> +>> LastModifiedDate -> (timestamp) +>> +>>> `DateTime` when the `Opportunity` was last modified. @@ -379 +399 @@ OpportunitySummaries -> (list) ->> Customer -> (structure) +>> LifeCycle -> (structure) @@ -381 +401 @@ OpportunitySummaries -> (list) ->>> An object that contains the `Opportunity` ‘s customer details. +>>> An object that contains the `Opportunity` ‘s lifecycle details. @@ -383 +403 @@ OpportunitySummaries -> (list) ->>> Account -> (structure) +>>> Stage -> (string) @@ -385,29 +405 @@ OpportunitySummaries -> (list) ->>>> An object that contains a customer’s account details. ->>>> ->>>> Address -> (structure) ->>>> ->>>>> Specifies the end `Customer` ‘s address details associated with the `Opportunity` . ->>>>> ->>>>> City -> (string) ->>>>> ->>>>>> Specifies the end `Customer` ‘s city associated with the `Opportunity` . ->>>>> ->>>>> CountryCode -> (string) ->>>>> ->>>>>> Specifies the end `Customer` ‘s country 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` ->>>> ->>>> CompanyName -> (string) ->>>> ->>>>> Specifies the end `Customer` ‘s company name associated with the `Opportunity` . ->>>> ->>>> Industry -> (string) +>>>> Specifies the current stage of the `Opportunity` ‘s lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the `Opportunity` ‘s progression in the sales cycle, according to Amazon Web Services definitions. @@ -415,5 +407 @@ OpportunitySummaries -> (list)