AWS cli medium security documentation change
Summary
Updated documentation structure for AWS Partner Central Selling get-opportunity command, including reorganization of fields, addition of NationalSecurity documentation, enhanced customer details, revised lifecycle stages, and expanded project/marketing parameters.
Security assessment
Added explicit documentation for NationalSecurity field requiring additional privacy/security measures for government opportunities. This directly references security controls for sensitive projects.
Diff
diff --git a/cli/latest/reference/partnercentral-selling/get-opportunity.md b/cli/latest/reference/partnercentral-selling/get-opportunity.md index 8a9a3d0ae..8f90ad101 100644 --- a//cli/latest/reference/partnercentral-selling/get-opportunity.md +++ b//cli/latest/reference/partnercentral-selling/get-opportunity.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -202,4 +201,0 @@ Disable automatically prompt for CLI input parameters. -Arn -> (string) - -> The Amazon Resource Name (ARN) that uniquely identifies the opportunity. - @@ -210 +206 @@ Catalog -> (string) -CreatedDate -> (timestamp) +PrimaryNeedsFromAws -> (list) @@ -212 +208,24 @@ CreatedDate -> (timestamp) -> `DateTime` when the `Opportunity` was last created. +> Identifies the type of support the partner needs from Amazon Web Services. +> +> Valid values: +> +> * Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner’s proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks. +> * Cosell—Business Presentation: Request Amazon Web Services seller’s participation in a joint customer presentation. +> * Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner’s proposed solution. +> * Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals). +> * Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner’s questions about the proposed solution. +> * Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment. +> * Cosell—Deal Support: Request Amazon Web Services seller’s support to progress the opportunity (for example: joint customer call, strategic positioning). +> * Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support. +> + +> +> (string) + +NationalSecurity -> (string) + +> Indicates whether the `Opportunity` pertains to a national security project. This field must be set to `true` only when the customer’s industry is _Government_ . Additional privacy and security measures apply during the review and management process for opportunities marked as `NationalSecurity` . + +PartnerOpportunityIdentifier -> (string) + +> 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. @@ -221,0 +241,20 @@ Customer -> (structure) +>> Industry -> (string) +>> +>>> Specifies the industry the end `Customer` belongs to that’s associated with the `Opportunity` . It refers to the category or sector where the customer’s business operates. This is a required field. +>> +>> OtherIndustry -> (string) +>> +>>> Specifies the end `Customer` ‘s industry associated with the `Opportunity` , when the selected value in the `Industry` field is `Other` . +>> +>> CompanyName -> (string) +>> +>>> Specifies the end `Customer` ‘s company name associated with the `Opportunity` . +>> +>> WebsiteUrl -> (string) +>> +>>> Specifies the end customer’s company website URL associated with the `Opportunity` . This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security. +>> +>> AwsAccountId -> (string) +>> +>>> Specifies the `Customer` Amazon Web Services account ID associated with the `Opportunity` . +>> @@ -230,4 +268,0 @@ Customer -> (structure) ->>> CountryCode -> (string) ->>> ->>>> Specifies the end `Customer` ‘s country associated with the `Opportunity` . ->>> @@ -243,0 +279,4 @@ Customer -> (structure) +>>> CountryCode -> (string) +>>> +>>>> Specifies the end `Customer` ‘s country associated with the `Opportunity` . +>>> @@ -248,8 +286,0 @@ Customer -> (structure) ->> AwsAccountId -> (string) ->> ->>> Specifies the `Customer` Amazon Web Services account ID associated with the `Opportunity` . ->> ->> CompanyName -> (string) ->> ->>> Specifies the end `Customer` ‘s company name associated with the `Opportunity` . ->> @@ -259,12 +289,0 @@ Customer -> (structure) ->> ->> Industry -> (string) ->> ->>> Specifies the industry the end `Customer` belongs to that’s associated with the `Opportunity` . It refers to the category or sector where the customer’s business operates. This is a required field. ->> ->> OtherIndustry -> (string) ->> ->>> Specifies the end `Customer` ‘s industry associated with the `Opportunity` , when the selected value in the `Industry` field is `Other` . ->> ->> WebsiteUrl -> (string) ->> ->>> Specifies the end customer’s company website URL associated with the `Opportunity` . This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security. @@ -280,4 +298,0 @@ Customer -> (structure) ->>> BusinessTitle -> (string) ->>> ->>>> The partner contact’s title (job title or role) associated with the `Opportunity` . `BusinessTitle` supports either `PartnerAccountManager` or `OpportunityOwner` . ->>> @@ -295,0 +311,4 @@ Customer -> (structure) +>>> BusinessTitle -> (string) +>>> +>>>> The partner contact’s title (job title or role) associated with the `Opportunity` . `BusinessTitle` supports either `PartnerAccountManager` or `OpportunityOwner` . +>>> @@ -300,9 +319 @@ Customer -> (structure) -Id -> (string) - -> Read-only, system generated `Opportunity` unique identifier. - -LastModifiedDate -> (timestamp) - -> `DateTime` when the opportunity was last modified. - -LifeCycle -> (structure) +Project -> (structure) @@ -310 +321 @@ LifeCycle -> (structure) -> An object that contains lifecycle details for the `Opportunity` . +> An object that contains project details summary for the `Opportunity` . @@ -312 +323 @@ LifeCycle -> (structure) -> ClosedLostReason -> (string) +> DeliveryModels -> (list) @@ -314 +325 @@ LifeCycle -> (structure) ->> Specifies the reason code when an opportunity is marked as _Closed Lost_ . When you select an appropriate reason code, you communicate the context for closing the `Opportunity` , and aid in accurate reports and analysis of opportunity outcomes. The possible values are: +>> Specifies the deployment or consumption model for your solution or service in the `Opportunity` ‘s context. You can select multiple options. @@ -316,19 +327,8 @@ LifeCycle -> (structure) ->> * Customer Deficiency: The customer lacked necessary resources or capabilities. ->> * Delay/Cancellation of Project: The project was delayed or canceled. ->> * Legal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress. ->> * Lost to Competitor—Google: The opportunity was lost to Google. ->> * Lost to Competitor—Microsoft: The opportunity was lost to Microsoft. ->> * Lost to Competitor—SoftLayer: The opportunity was lost to SoftLayer. ->> * Lost to Competitor—VMWare: The opportunity was lost to VMWare. ->> * Lost to Competitor—Other: The opportunity was lost to a competitor not listed above. ->> * No Opportunity: There was no opportunity to pursue. ->> * On Premises Deployment: The customer chose an on-premises solution. ->> * Partner Gap: The partner lacked necessary resources or capabilities. ->> * Price: The price was not competitive or acceptable to the customer. ->> * Security/Compliance: Security or compliance issues prevented progress. ->> * Technical Limitations: Technical limitations prevented progress. ->> * Customer Experience: Issues related to the customer’s experience impacted the decision. ->> * Other: Any reason not covered by the other values. ->> * People/Relationship/Governance: Issues related to people, relationships, or governance. ->> * Product/Technology: Issues related to the product or technology. ->> * Financial/Commercial: Financial or commercial issues impacted the decision. +>> Options’ descriptions from the `Delivery Model` field are: +>> +>> * SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment. +>> * BYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer’s Amazon Web Services environment. +>> * Managed Services: The end customer’s Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support). +>> * Professional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning). +>> * Resell: Amazon Web Services accounts and billing management for your customers. +>> * Other: Delivery model not described above. @@ -336,0 +337,2 @@ LifeCycle -> (structure) +>> +>> (string) @@ -338,5 +340 @@ LifeCycle -> (structure) -> NextSteps -> (string) -> ->> Specifies the upcoming actions or tasks for the `Opportunity` . Use this field to communicate with Amazon Web Services about the next actions required for the `Opportunity` . -> -> NextStepsHistory -> (list) +> ExpectedCustomerSpend -> (list) @@ -344 +342 @@ LifeCycle -> (structure) ->> Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp. +>> Represents the estimated amount that the customer is expected to spend on AWS services related to the opportunity. This helps in evaluating the potential financial value of the opportunity for AWS. @@ -348 +346 @@ LifeCycle -> (structure) ->>> Read-only; shows the last 50 values and change dates for the `NextSteps` field. +>>> 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. @@ -350 +348 @@ LifeCycle -> (structure) ->>> Time -> (timestamp) +>>> Amount -> (string) @@ -352 +350 @@ LifeCycle -> (structure) ->>>> Indicates the step execution time. +>>>> Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns. @@ -354 +352 @@ LifeCycle -> (structure) ->>> Value -> (string) +>>> CurrencyCode -> (string) @@ -356 +354,13 @@ LifeCycle -> (structure) ->>>> Indicates the step’s execution details. +>>>> Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. +>>> +>>> Frequency -> (string) +>>> +>>>> 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. +>>> +>>> TargetCompany -> (string) +>>> +>>>> 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. @@ -358 +368 @@ LifeCycle -> (structure) -> ReviewComments -> (string) +> Title -> (string) @@ -360 +370 @@ LifeCycle -> (structure) ->> Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the `ReviewComments` . +>> Specifies the `Opportunity` ‘s title or name. @@ -362 +372 @@ LifeCycle -> (structure) -> ReviewStatus -> (string)