SDK for PHP 3.x

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

AssociateOpportunity

$result = $client->associateOpportunity([/* ... */]);
$promise = $client->associateOpportunityAsync([/* ... */]);

Enables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types:

Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services.
Amazon Web Services Products: Amazon Web Services offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products.
Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, see Private offers in Amazon Web Services Marketplace.

To obtain identifiers for these entities, use the following methods:

Solution: Use the ListSolutions operation.
AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products.
Amazon Web Services Marketplace private offer: Use the Using the Amazon Web Services Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request returns the details of available private offers. For more information, see ListEntities.

Parameter Syntax

$result = $client->associateOpportunity([
    'Catalog' => '<string>', // REQUIRED
    'OpportunityIdentifier' => '<string>', // REQUIRED
    'RelatedEntityIdentifier' => '<string>', // REQUIRED
    'RelatedEntityType' => 'Solutions|AwsProducts|AwsMarketplaceOffers', // REQUIRED
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

OpportunityIdentifier

: Required: Yes
: Type: string

Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.

RelatedEntityIdentifier

: Required: Yes
: Type: string

Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.

RelatedEntityType

: Required: Yes
: Type: string

Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

CreateOpportunity

$result = $client->createOpportunity([/* ... */]);
$promise = $client->createOpportunityAsync([/* ... */]);

Creates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to Pending Submission.

To submit an opportunity, follow these steps:

To create the opportunity, use CreateOpportunity.
To associate a solution with the opportunity, use AssociateOpportunity.
To submit the opportunity, use StartEngagementFromOpportunityTask.

After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state.

There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

Parameter Syntax

$result = $client->createOpportunity([
    'Catalog' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Customer' => [
        'Account' => [
            'Address' => [
                'City' => '<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',
                'PostalCode' => '<string>',
                'StateOrRegion' => '<string>',
                'StreetAddress' => '<string>',
            ],
            'AwsAccountId' => '<string>',
            'CompanyName' => '<string>', // REQUIRED
            'Duns' => '<string>',
            'Industry' => 'Aerospace|Agriculture|Automotive|Computers and Electronics|Consumer Goods|Education|Energy - Oil and Gas|Energy - Power and Utilities|Financial Services|Gaming|Government|Healthcare|Hospitality|Life Sciences|Manufacturing|Marketing and Advertising|Media and Entertainment|Mining|Non-Profit Organization|Professional Services|Real Estate and Construction|Retail|Software and Internet|Telecommunications|Transportation and Logistics|Travel|Wholesale and Distribution|Other',
            'OtherIndustry' => '<string>',
            'WebsiteUrl' => '<string>',
        ],
        'Contacts' => [
            [
                'BusinessTitle' => '<string>',
                'Email' => '<string>',
                'FirstName' => '<string>',
                'LastName' => '<string>',
                'Phone' => '<string>',
            ],
            // ...
        ],
    ],
    'LifeCycle' => [
        'ClosedLostReason' => 'Customer Deficiency|Delay / Cancellation of Project|Legal / Tax / Regulatory|Lost to Competitor - Google|Lost to Competitor - Microsoft|Lost to Competitor - SoftLayer|Lost to Competitor - VMWare|Lost to Competitor - Other|No Opportunity|On Premises Deployment|Partner Gap|Price|Security / Compliance|Technical Limitations|Customer Experience|Other|People/Relationship/Governance|Product/Technology|Financial/Commercial',
        'NextSteps' => '<string>',
        'NextStepsHistory' => [
            [
                'Time' => <integer || string || DateTime>, // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ReviewComments' => '<string>',
        'ReviewStatus' => 'Pending Submission|Submitted|In review|Approved|Rejected|Action Required',
        'ReviewStatusReason' => '<string>',
        'Stage' => 'Prospect|Qualified|Technical Validation|Business Validation|Committed|Launched|Closed Lost',
        'TargetCloseDate' => '<string>',
    ],
    'Marketing' => [
        'AwsFundingUsed' => 'Yes|No',
        'CampaignName' => '<string>',
        'Channels' => ['<string>', ...],
        'Source' => 'Marketing Activity|None',
        'UseCases' => ['<string>', ...],
    ],
    'NationalSecurity' => 'Yes|No',
    'OpportunityTeam' => [
        [
            'BusinessTitle' => '<string>',
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
            'Phone' => '<string>',
        ],
        // ...
    ],
    'OpportunityType' => 'Net New Business|Flat Renewal|Expansion',
    'Origin' => 'AWS Referral|Partner Referral',
    'PartnerOpportunityIdentifier' => '<string>',
    'PrimaryNeedsFromAws' => ['<string>', ...],
    'Project' => [
        'AdditionalComments' => '<string>',
        'ApnPrograms' => ['<string>', ...],
        'CompetitorName' => 'Oracle Cloud|On-Prem|Co-location|Akamai|AliCloud|Google Cloud Platform|IBM Softlayer|Microsoft Azure|Other- Cost Optimization|No Competition|*Other',
        'CustomerBusinessProblem' => '<string>',
        'CustomerUseCase' => '<string>',
        'DeliveryModels' => ['<string>', ...],
        'ExpectedCustomerSpend' => [
            [
                'Amount' => '<string>', // REQUIRED
                'CurrencyCode' => 'USD|EUR|GBP|AUD|CAD|CNY|NZD|INR|JPY|CHF|SEK|AED|AFN|ALL|AMD|ANG|AOA|ARS|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CDF|CHE|CHW|CLF|CLP|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|FJD|FKP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|IQD|IRR|ISK|JMD|JOD|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USN|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XCD|XDR|XOF|XPF|XSU|XUA|YER|ZAR|ZMW|ZWL', // REQUIRED
                'Frequency' => 'Monthly', // REQUIRED
                'TargetCompany' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'OtherCompetitorNames' => '<string>',
        'OtherSolutionDescription' => '<string>',
        'RelatedOpportunityIdentifier' => '<string>',
        'SalesActivities' => ['<string>', ...],
        'Title' => '<string>',
    ],
    'SoftwareRevenue' => [
        'DeliveryModel' => 'Contract|Pay-as-you-go|Subscription',
        'EffectiveDate' => '<string>',
        'ExpirationDate' => '<string>',
        'Value' => [
            'Amount' => '<string>', // REQUIRED
            'CurrencyCode' => 'USD|EUR|GBP|AUD|CAD|CNY|NZD|INR|JPY|CHF|SEK|AED|AFN|ALL|AMD|ANG|AOA|ARS|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CDF|CHE|CHW|CLF|CLP|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|FJD|FKP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|IQD|IRR|ISK|JMD|JOD|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USN|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XCD|XDR|XOF|XPF|XSU|XUA|YER|ZAR|ZMW|ZWL', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

ClientToken

: Required: Yes
: Type: string

Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.

Default: None

Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: "Conflicting client token submitted for a new request body."

Customer

: Type: Customer structure

Specifies customer details associated with the Opportunity.

LifeCycle

: Type: LifeCycle structure

An object that contains lifecycle details for the Opportunity.

Marketing

: Type: Marketing structure

This object contains marketing details and is optional for an opportunity.

NationalSecurity

: Type: 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.

OpportunityTeam

: Type: Array of Contact structures

Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.

OpportunityType

: Type: string

Specifies the 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.

Origin

: Type: string

Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

PartnerOpportunityIdentifier

: Type: 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 to the partner.

This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.

PrimaryNeedsFromAws

: Type: Array of strings

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.
Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycles. This is also known as a for-visibility-only (FVO) opportunity.

Project

: Type: Project structure

An object that contains project details for the Opportunity.

SoftwareRevenue

: Type: SoftwareRevenue structure

Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.

Result Syntax

[
    'Id' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'PartnerOpportunityIdentifier' => '<string>',
]

Result Details

Members

Id

: Required: Yes
: Type: string

Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity actions, such as updates, associations, and submissions. It helps to ensure that each opportunity is accurately tracked and managed.

LastModifiedDate

: Type: timestamp (string|DateTime or anything parsable by strtotime)

DateTime when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.

PartnerOpportunityIdentifier

: Type: 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.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

DisassociateOpportunity

$result = $client->disassociateOpportunity([/* ... */]);
$promise = $client->disassociateOpportunityAsync([/* ... */]);

Allows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change.

Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.

Parameter Syntax

$result = $client->disassociateOpportunity([
    'Catalog' => '<string>', // REQUIRED
    'OpportunityIdentifier' => '<string>', // REQUIRED
    'RelatedEntityIdentifier' => '<string>', // REQUIRED
    'RelatedEntityType' => 'Solutions|AwsProducts|AwsMarketplaceOffers', // REQUIRED
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

OpportunityIdentifier

: Required: Yes
: Type: string

The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.

Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.

RelatedEntityIdentifier

: Required: Yes
: Type: string

The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.

For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.

Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.

RelatedEntityType

: Required: Yes
: Type: string

The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.

Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.

Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

GetAwsOpportunitySummary

$result = $client->getAwsOpportunitySummary([/* ... */]);
$promise = $client->getAwsOpportunitySummaryAsync([/* ... */]);

Retrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity sourced from AWS, such as lifecycle information, customer details, and involvement type. It is useful for tracking updates on the AWS opportunity corresponding to an opportunity in the partner's account.

Parameter Syntax

$result = $client->getAwsOpportunitySummary([
    'Catalog' => '<string>', // REQUIRED
    'RelatedOpportunityIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.

RelatedOpportunityIdentifier

: Required: Yes
: Type: string

The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.

Result Syntax

[
    'Catalog' => '<string>',
    'Customer' => [
        'Contacts' => [
            [
                'BusinessTitle' => '<string>',
                'Email' => '<string>',
                'FirstName' => '<string>',
                'LastName' => '<string>',
                'Phone' => '<string>',
            ],
            // ...
        ],
    ],
    'Insights' => [
        'EngagementScore' => 'High|Medium|Low',
        'NextBestActions' => '<string>',
    ],
    'InvolvementType' => 'For Visibility Only|Co-Sell',
    'InvolvementTypeChangeReason' => 'Expansion Opportunity|Change in Deal Information|Customer Requested|Technical Complexity|Risk Mitigation',
    'LifeCycle' => [
        'ClosedLostReason' => 'Administrative|Business Associate Agreement|Company Acquired/Dissolved|Competitive Offering|Customer Data Requirement|Customer Deficiency|Customer Experience|Delay / Cancellation of Project|Duplicate|Duplicate Opportunity|Executive Blocker|Failed Vetting|Feature Limitation|Financial/Commercial|Insufficient Amazon Value|Insufficient AWS Value|International Constraints|Legal / Tax / Regulatory|Legal Terms and Conditions|Lost to Competitor|Lost to Competitor - Google|Lost to Competitor - Microsoft|Lost to Competitor - Other|Lost to Competitor - Rackspace|Lost to Competitor - SoftLayer|Lost to Competitor - VMWare|No Customer Reference|No Integration Resources|No Opportunity|No Perceived Value of MP|No Response|Not Committed to AWS|No Update|On Premises Deployment|Other|Other (Details in Description)|Partner Gap|Past Due|People/Relationship/Governance|Platform Technology Limitation|Preference for Competitor|Price|Product/Technology|Product Not on AWS|Security / Compliance|Self-Service|Technical Limitations|Term Sheet Impasse',
        'NextSteps' => '<string>',
        'NextStepsHistory' => [
            [
                'Time' => <DateTime>,
                'Value' => '<string>',
            ],
            // ...
        ],
        'Stage' => 'Not Started|In Progress|Prospect|Engaged|Identified|Qualify|Research|Seller Engaged|Evaluating|Seller Registered|Term Sheet Negotiation|Contract Negotiation|Onboarding|Building Integration|Qualified|On-hold|Technical Validation|Business Validation|Committed|Launched|Deferred to Partner|Closed Lost|Completed|Closed Incomplete',
        'TargetCloseDate' => '<string>',
    ],
    'OpportunityTeam' => [
        [
            'BusinessTitle' => 'AWSSalesRep|AWSAccountOwner|WWPSPDM|PDM|PSM|ISVSM',
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
        ],
        // ...
    ],
    'Origin' => 'AWS Referral|Partner Referral',
    'Project' => [
        'ExpectedCustomerSpend' => [
            [
                'Amount' => '<string>',
                'CurrencyCode' => 'USD|EUR|GBP|AUD|CAD|CNY|NZD|INR|JPY|CHF|SEK|AED|AFN|ALL|AMD|ANG|AOA|ARS|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CDF|CHE|CHW|CLF|CLP|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|FJD|FKP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|IQD|IRR|ISK|JMD|JOD|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USN|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XCD|XDR|XOF|XPF|XSU|XUA|YER|ZAR|ZMW|ZWL',
                'Frequency' => 'Monthly',
                'TargetCompany' => '<string>',
            ],
            // ...
        ],
    ],
    'RelatedEntityIds' => [
        'AwsProducts' => ['<string>', ...],
        'Solutions' => ['<string>', ...],
    ],
    'RelatedOpportunityId' => '<string>',
    'Visibility' => 'Full|Limited',
]

Result Details

Members

Catalog

: Required: Yes
: Type: string

Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.

Customer

: Type: AwsOpportunityCustomer structure

Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other customer data. These details help partners understand the business context of the opportunity.

Insights

: Type: AwsOpportunityInsights structure

Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.

InvolvementType

: Type: string

Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support. This field helps partners understand the role AWS plays in advancing the opportunity.

InvolvementTypeChangeReason

: Type: string

Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.

LifeCycle

: Type: AwsOpportunityLifeCycle structure

Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.

OpportunityTeam

: Type: Array of AwsTeamMember structures

Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.

Origin

: Type: string

Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.

Project

: Type: AwsOpportunityProject structure

Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.

RelatedEntityIds

: Type: AwsOpportunityRelatedEntities structure

Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.

RelatedOpportunityId

: Type: string

Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.

Visibility

: Type: string

Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

GetEngagementInvitation

$result = $client->getEngagementInvitation([/* ... */]);
$promise = $client->getEngagementInvitationAsync([/* ... */]);

Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.

Parameter Syntax

$result = $client->getEngagementInvitation([
    'Catalog' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Specifies the catalog associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments.

Identifier

: Required: Yes
: Type: string

Specifies the unique identifier for the retrieved engagement invitation.

Result Syntax

[
    'Arn' => '<string>',
    'Catalog' => '<string>',
    'EngagementTitle' => '<string>',
    'ExpirationDate' => <DateTime>,
    'Id' => '<string>',
    'InvitationDate' => <DateTime>,
    'Payload' => [
        'OpportunityInvitation' => [
            'Customer' => [
                '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',
                'Industry' => 'Aerospace|Agriculture|Automotive|Computers and Electronics|Consumer Goods|Education|Energy - Oil and Gas|Energy - Power and Utilities|Financial Services|Gaming|Government|Healthcare|Hospitality|Life Sciences|Manufacturing|Marketing and Advertising|Media and Entertainment|Mining|Non-Profit Organization|Professional Services|Real Estate and Construction|Retail|Software and Internet|Telecommunications|Transportation and Logistics|Travel|Wholesale and Distribution|Other',
                'WebsiteUrl' => '<string>',
            ],
            'Project' => [
                'BusinessProblem' => '<string>',
                'ExpectedCustomerSpend' => [
                    [
                        'Amount' => '<string>',
                        'CurrencyCode' => 'USD|EUR|GBP|AUD|CAD|CNY|NZD|INR|JPY|CHF|SEK|AED|AFN|ALL|AMD|ANG|AOA|ARS|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CDF|CHE|CHW|CLF|CLP|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|FJD|FKP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|IQD|IRR|ISK|JMD|JOD|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USN|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XCD|XDR|XOF|XPF|XSU|XUA|YER|ZAR|ZMW|ZWL',
                        'Frequency' => 'Monthly',
                        'TargetCompany' => '<string>',
                    ],
                    // ...
                ],
                'TargetCompletionDate' => '<string>',
                'Title' => '<string>',
            ],
            'ReceiverResponsibilities' => ['<string>', ...],
            'SenderContacts' => [
                [
                    'BusinessTitle' => '<string>',
                    'Email' => '<string>',
                    'FirstName' => '<string>',
                    'LastName' => '<string>',
                    'Phone' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'PayloadType' => 'OpportunityInvitation',
    'Receiver' => [
        'Account' => [
            'Alias' => '<string>',
            'AwsAccountId' => '<string>',
        ],
    ],
    'RejectionReason' => '<string>',
    'SenderAwsAccountId' => '<string>',
    'SenderCompanyName' => '<string>',
    'Status' => 'ACCEPTED|PENDING|REJECTED|EXPIRED',
]

Result Details

Members

Arn

: Type: string

The Amazon Resource Name (ARN) that identifies the engagement invitation.

Catalog

: Required: Yes
: Type: 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.

EngagementTitle

: Type: string

The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.

ExpirationDate

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Indicates the date on which the engagement invitation will expire if not accepted by the partner.

Id

: Required: Yes
: Type: string

Unique identifier assigned to the engagement invitation being retrieved.

InvitationDate

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the engagement invitation was sent to the partner.

Payload

: Type: Payload structure

Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.

PayloadType

: Type: string

The type of payload contained in the engagement invitation, indicating what data or context the payload covers.

Receiver

: Type: Receiver structure

Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

RejectionReason

: Type: string

If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

SenderAwsAccountId

: Type: string

Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

SenderCompanyName

: Type: string

The name of the AWS organization or team that sent the engagement invitation.

Status

: Type: string

The current status of the engagement invitation.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

GetOpportunity

$result = $client->getOpportunity([/* ... */]);
$promise = $client->getOpportunityAsync([/* ... */]);

Fetches the Opportunity record from Partner Central by a given Identifier.

Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.

Parameter Syntax

$result = $client->getOpportunity([
    'Catalog' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure, isolated testing environment.

Identifier

: Required: Yes
: Type: string

Read-only, system generated Opportunity unique identifier.

Result Syntax

[
    'Catalog' => '<string>',
    'CreatedDate' => <DateTime>,
    'Customer' => [
        'Account' => [
            'Address' => [
                'City' => '<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',
                'PostalCode' => '<string>',
                'StateOrRegion' => '<string>',
                'StreetAddress' => '<string>',
            ],
            'AwsAccountId' => '<string>',
            'CompanyName' => '<string>',
            'Duns' => '<string>',
            'Industry' => 'Aerospace|Agriculture|Automotive|Computers and Electronics|Consumer Goods|Education|Energy - Oil and Gas|Energy - Power and Utilities|Financial Services|Gaming|Government|Healthcare|Hospitality|Life Sciences|Manufacturing|Marketing and Advertising|Media and Entertainment|Mining|Non-Profit Organization|Professional Services|Real Estate and Construction|Retail|Software and Internet|Telecommunications|Transportation and Logistics|Travel|Wholesale and Distribution|Other',
            'OtherIndustry' => '<string>',
            'WebsiteUrl' => '<string>',
        ],
        'Contacts' => [
            [
                'BusinessTitle' => '<string>',
                'Email' => '<string>',
                'FirstName' => '<string>',
                'LastName' => '<string>',
                'Phone' => '<string>',
            ],
            // ...
        ],
    ],
    'Id' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'LifeCycle' => [
        'ClosedLostReason' => 'Customer Deficiency|Delay / Cancellation of Project|Legal / Tax / Regulatory|Lost to Competitor - Google|Lost to Competitor - Microsoft|Lost to Competitor - SoftLayer|Lost to Competitor - VMWare|Lost to Competitor - Other|No Opportunity|On Premises Deployment|Partner Gap|Price|Security / Compliance|Technical Limitations|Customer Experience|Other|People/Relationship/Governance|Product/Technology|Financial/Commercial',
        'NextSteps' => '<string>',
        'NextStepsHistory' => [
            [
                'Time' => <DateTime>,
                'Value' => '<string>',
            ],
            // ...
        ],
        'ReviewComments' => '<string>',
        'ReviewStatus' => 'Pending Submission|Submitted|In review|Approved|Rejected|Action Required',
        'ReviewStatusReason' => '<string>',
        'Stage' => 'Prospect|Qualified|Technical Validation|Business Validation|Committed|Launched|Closed Lost',
        'TargetCloseDate' => '<string>',
    ],
    'Marketing' => [
        'AwsFundingUsed' => 'Yes|No',
        'CampaignName' => '<string>',
        'Channels' => ['<string>', ...],
        'Source' => 'Marketing Activity|None',
        'UseCases' => ['<string>', ...],
    ],
    'NationalSecurity' => 'Yes|No',
    'OpportunityTeam' => [
        [
            'BusinessTitle' => '<string>',
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
            'Phone' => '<string>',
        ],
        // ...
    ],
    'OpportunityType' => 'Net New Business|Flat Renewal|Expansion',
    'PartnerOpportunityIdentifier' => '<string>',
    'PrimaryNeedsFromAws' => ['<string>', ...],
    'Project' => [
        'AdditionalComments' => '<string>',
        'ApnPrograms' => ['<string>', ...],
        'CompetitorName' => 'Oracle Cloud|On-Prem|Co-location|Akamai|AliCloud|Google Cloud Platform|IBM Softlayer|Microsoft Azure|Other- Cost Optimization|No Competition|*Other',
        'CustomerBusinessProblem' => '<string>',
        'CustomerUseCase' => '<string>',
        'DeliveryModels' => ['<string>', ...],
        'ExpectedCustomerSpend' => [
            [
                'Amount' => '<string>',
                'CurrencyCode' => 'USD|EUR|GBP|AUD|CAD|CNY|NZD|INR|JPY|CHF|SEK|AED|AFN|ALL|AMD|ANG|AOA|ARS|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CDF|CHE|CHW|CLF|CLP|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|FJD|FKP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|IQD|IRR|ISK|JMD|JOD|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USN|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XCD|XDR|XOF|XPF|XSU|XUA|YER|ZAR|ZMW|ZWL',
                'Frequency' => 'Monthly',
                'TargetCompany' => '<string>',
            ],
            // ...
        ],
        'OtherCompetitorNames' => '<string>',
        'OtherSolutionDescription' => '<string>',
        'RelatedOpportunityIdentifier' => '<string>',
        'SalesActivities' => ['<string>', ...],
        'Title' => '<string>',
    ],
    'RelatedEntityIdentifiers' => [
        'AwsMarketplaceOffers' => ['<string>', ...],
        'AwsProducts' => ['<string>', ...],
        'Solutions' => ['<string>', ...],
    ],
    'SoftwareRevenue' => [
        'DeliveryModel' => 'Contract|Pay-as-you-go|Subscription',
        'EffectiveDate' => '<string>',
        'ExpirationDate' => '<string>',
        'Value' => [
            'Amount' => '<string>',
            'CurrencyCode' => 'USD|EUR|GBP|AUD|CAD|CNY|NZD|INR|JPY|CHF|SEK|AED|AFN|ALL|AMD|ANG|AOA|ARS|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CDF|CHE|CHW|CLF|CLP|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|FJD|FKP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|IQD|IRR|ISK|JMD|JOD|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USN|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XCD|XDR|XOF|XPF|XSU|XUA|YER|ZAR|ZMW|ZWL',
        ],
    ],
]

Result Details

Members

Catalog

: Required: Yes
: Type: string

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

CreatedDate

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

DateTime when the Opportunity was last created.

Customer

: Type: Customer structure

Specifies details of the customer associated with the Opportunity.

Id

: Required: Yes
: Type: string

Read-only, system generated Opportunity unique identifier.

LastModifiedDate

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

DateTime when the opportunity was last modified.

LifeCycle

: Type: LifeCycle structure

An object that contains lifecycle details for the Opportunity.

Marketing

: Type: Marketing structure

An object that contains marketing details for the Opportunity.

NationalSecurity

: Type: string

OpportunityTeam

: Type: Array of Contact structures

Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.

OpportunityType

: Type: string

Specifies the opportunity type as 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, which helps to ensure service continuity.
Expansion opportunity: Represents an opportunity to expand the scope of a customer's contract or subscription, either by adding new services or increasing the volume of existing services.

PartnerOpportunityIdentifier

: Type: 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.

PrimaryNeedsFromAws

: Type: Array of strings

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.
Do Not Need Support from Amazon Web Services Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.

Project

: Type: Project structure

An object that contains project details summary for the Opportunity.

RelatedEntityIdentifiers

: Required: Yes
: Type: RelatedEntityIdentifiers structure

Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

SoftwareRevenue

: Type: SoftwareRevenue structure

Specifies details of a customer's procurement terms. Required only for partners in eligible programs.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

ListEngagementInvitations

$result = $client->listEngagementInvitations([/* ... */]);
$promise = $client->listEngagementInvitationsAsync([/* ... */]);

Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.

Parameter Syntax

$result = $client->listEngagementInvitations([
    'Catalog' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ParticipantType' => 'RECEIVER', // REQUIRED
    'PayloadType' => ['<string>', ...],
    'Sort' => [
        'SortBy' => 'InvitationDate', // REQUIRED
        'SortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
    ],
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.

MaxResults

: Type: int

Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.

NextToken

: Type: string

A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.

ParticipantType

: Required: Yes
: Type: string

Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.

PayloadType

: Type: Array of strings

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.

Sort

: Type: OpportunityEngagementInvitationSort 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.

Result Syntax

[
    'EngagementInvitationSummaries' => [
        [
            'Arn' => '<string>',
            'Catalog' => '<string>',
            'EngagementTitle' => '<string>',
            'ExpirationDate' => <DateTime>,
            'Id' => '<string>',
            'InvitationDate' => <DateTime>,
            'PayloadType' => 'OpportunityInvitation',
            'Receiver' => [
                'Account' => [
                    'Alias' => '<string>',
                    'AwsAccountId' => '<string>',
                ],
            ],
            'SenderAwsAccountId' => '<string>',
            'SenderCompanyName' => '<string>',
            'Status' => 'ACCEPTED|PENDING|REJECTED|EXPIRED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

EngagementInvitationSummaries

: Type: Array of EngagementInvitationSummary structures

An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.

NextToken

: Type: string

A pagination token returned when there are more results available than can be returned in a single call. Use this token to retrieve additional pages of engagement invitation summaries.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

ListOpportunities

$result = $client->listOpportunities([/* ... */]);
$promise = $client->listOpportunitiesAsync([/* ... */]);

This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action.

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.

We recommend the following approach:

Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system.
When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.
Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

Parameter Syntax

$result = $client->listOpportunities([
    'Catalog' => '<string>', // REQUIRED
    'CustomerCompanyName' => ['<string>', ...],
    'Identifier' => ['<string>', ...],
    'LastModifiedDate' => [
        'AfterLastModifiedDate' => <integer || string || DateTime>,
        'BeforeLastModifiedDate' => <integer || string || DateTime>,
    ],
    'LifeCycleReviewStatus' => ['<string>', ...],
    'LifeCycleStage' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Sort' => [
        'SortBy' => 'LastModifiedDate|Identifier|CustomerCompanyName', // REQUIRED
        'SortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
    ],
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

CustomerCompanyName

: Type: Array of strings

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.

Identifier

: Type: Array of strings

Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.

LastModifiedDate

: Type: LastModifiedDate structure

Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.

LifeCycleReviewStatus

: Type: Array of strings

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.

LifeCycleStage

: Type: Array of strings

Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.

MaxResults

: Type: int

Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.

Default: 20

NextToken

: Type: 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.

Sort

: Type: OpportunitySort structure

An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.

Result Syntax

[
    'NextToken' => '<string>',
    'OpportunitySummaries' => [
        [
            'Catalog' => '<string>',
            'CreatedDate' => <DateTime>,
            'Customer' => [
                'Account' => [
                    'Address' => [
                        'City' => '<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',
                        'PostalCode' => '<string>',
                        'StateOrRegion' => '<string>',
                    ],
                    'CompanyName' => '<string>',
                    'Industry' => 'Aerospace|Agriculture|Automotive|Computers and Electronics|Consumer Goods|Education|Energy - Oil and Gas|Energy - Power and Utilities|Financial Services|Gaming|Government|Healthcare|Hospitality|Life Sciences|Manufacturing|Marketing and Advertising|Media and Entertainment|Mining|Non-Profit Organization|Professional Services|Real Estate and Construction|Retail|Software and Internet|Telecommunications|Transportation and Logistics|Travel|Wholesale and Distribution|Other',
                    'OtherIndustry' => '<string>',
                    'WebsiteUrl' => '<string>',
                ],
            ],
            'Id' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'LifeCycle' => [
                'ClosedLostReason' => 'Customer Deficiency|Delay / Cancellation of Project|Legal / Tax / Regulatory|Lost to Competitor - Google|Lost to Competitor - Microsoft|Lost to Competitor - SoftLayer|Lost to Competitor - VMWare|Lost to Competitor - Other|No Opportunity|On Premises Deployment|Partner Gap|Price|Security / Compliance|Technical Limitations|Customer Experience|Other|People/Relationship/Governance|Product/Technology|Financial/Commercial',
                'NextSteps' => '<string>',
                'ReviewComments' => '<string>',
                'ReviewStatus' => 'Pending Submission|Submitted|In review|Approved|Rejected|Action Required',
                'ReviewStatusReason' => '<string>',
                'Stage' => 'Prospect|Qualified|Technical Validation|Business Validation|Committed|Launched|Closed Lost',
                'TargetCloseDate' => '<string>',
            ],
            'OpportunityType' => 'Net New Business|Flat Renewal|Expansion',
            'PartnerOpportunityIdentifier' => '<string>',
            'Project' => [
                'DeliveryModels' => ['<string>', ...],
                'ExpectedCustomerSpend' => [
                    [
                        'Amount' => '<string>',
                        'CurrencyCode' => 'USD|EUR|GBP|AUD|CAD|CNY|NZD|INR|JPY|CHF|SEK|AED|AFN|ALL|AMD|ANG|AOA|ARS|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CDF|CHE|CHW|CLF|CLP|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|FJD|FKP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|IQD|IRR|ISK|JMD|JOD|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USN|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XCD|XDR|XOF|XPF|XSU|XUA|YER|ZAR|ZMW|ZWL',
                        'Frequency' => 'Monthly',
                        'TargetCompany' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: 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.

OpportunitySummaries

: Required: Yes
: Type: Array of OpportunitySummary structures

An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

ListSolutions

$result = $client->listSolutions([/* ... */]);
$promise = $client->listSolutionsAsync([/* ... */]);

Retrieves a list of Partner Solutions that the partner registered on Partner Central. This API is used to generate a list of solutions that an end user selects from for association with an opportunity.

Parameter Syntax

$result = $client->listSolutions([
    'Catalog' => '<string>', // REQUIRED
    'Category' => ['<string>', ...],
    'Identifier' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Sort' => [
        'SortBy' => 'Identifier|Name|Status|Category|CreatedDate', // REQUIRED
        'SortOrder' => 'ASCENDING|DESCENDING', // REQUIRED
    ],
    'Status' => ['<string>', ...],
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the solutions are listed in. Use AWS to list solutions in the Amazon Web Services catalog, and Sandbox to list solutions in a secure and isolated testing environment.

Category

: Type: Array of strings

Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as Software, Consulting, or Managed Services.

Identifier

: Type: Array of strings

Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.

MaxResults

: Type: int

The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.

Default: 20

NextToken

: Type: 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.

Sort

: Type: SolutionSort structure

Object that configures sorting done on the response. Default Sort.SortBy is Identifier.

Status

: Type: Array of strings

Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.

Result Syntax

[
    'NextToken' => '<string>',
    'SolutionSummaries' => [
        [
            'Catalog' => '<string>',
            'Category' => '<string>',
            'CreatedDate' => <DateTime>,
            'Id' => '<string>',
            'Name' => '<string>',
            'Status' => 'Active|Inactive|Draft',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: 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.

SolutionSummaries

: Required: Yes
: Type: Array of SolutionBase structures

An array with minimal details for solutions matching the request criteria.

Errors

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

RejectEngagementInvitation

$result = $client->rejectEngagementInvitation([/* ... */]);
$promise = $client->rejectEngagementInvitationAsync([/* ... */]);

This action rejects an EngagementInvitation that AWS shared. Rejecting an invitation indicates that the partner doesn't want to pursue the opportunity, and all related data will become inaccessible thereafter.

Parameter Syntax

$result = $client->rejectEngagementInvitation([
    'Catalog' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
    'RejectionReason' => '<string>',
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

This is the catalog that's associated with the engagement invitation. Acceptable values are AWS or Sandbox, and these values determine the environment in which the opportunity is managed.

Identifier

: Required: Yes
: Type: string

This is the unique identifier of the rejected EngagementInvitation. Providing the correct identifier helps to ensure that the intended invitation is rejected.

RejectionReason

: Type: string

This describes the reason for rejecting the engagement invitation, which helps AWS track usage patterns. Acceptable values include the following:

Customer problem unclear: The customer's problem isn't understood.
Next steps unclear: The next steps required to proceed aren't understood.
Unable to support: The partner is unable to provide support due to resource or capability constraints.
Duplicate of partner referral: The opportunity is a duplicate of an existing referral.
Other: Any reason not covered by other values.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

StartEngagementByAcceptingInvitationTask

$result = $client->startEngagementByAcceptingInvitationTask([/* ... */]);
$promise = $client->startEngagementByAcceptingInvitationTaskAsync([/* ... */]);

This action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves the following steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS opportunity, and copying details for tracking. When completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.

Parameter Syntax

$result = $client->startEngagementByAcceptingInvitationTask([
    'Catalog' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.

ClientToken

: Required: Yes
: Type: string

A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.

Identifier

: Required: Yes
: Type: string

Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.

Result Syntax

[
    'EngagementInvitationId' => '<string>',
    'Message' => '<string>',
    'OpportunityId' => '<string>',
    'ReasonCode' => 'InvitationAccessDenied|EngagementAccessDenied|OpportunityAccessDenied|ResourceSnapshotJobAccessDenied|EngagementValidationFailed|OpportunitySubmissionFailed|EngagementInvitationConflict|InternalError|OpportunityValidationFailed|OpportunityConflict|ResourceSnapshotAccessDenied',
    'StartTime' => <DateTime>,
    'TaskArn' => '<string>',
    'TaskId' => '<string>',
    'TaskStatus' => 'IN_PROGRESS|COMPLETE|FAILED',
]

Result Details

Members

EngagementInvitationId

: Type: string

Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.

Message

: Type: string

If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

OpportunityId

: Type: string

Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.

ReasonCode

: Type: string

Indicates the reason for task failure using an enumerated code.

StartTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

TaskArn

: Type: string

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

TaskId

: Type: string

The unique identifier of the task, used to track the task’s progress.

TaskStatus

: Type: string

Indicates the current status of the task.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

ServiceQuotaExceededException:

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

StartEngagementFromOpportunityTask

$result = $client->startEngagementFromOpportunityTask([/* ... */]);
$promise = $client->startEngagementFromOpportunityTaskAsync([/* ... */]);

This action initiates the engagement process from an existing opportunity by accepting the engagement invitation and creating a corresponding opportunity in the partner’s system. Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion.

Parameter Syntax

$result = $client->startEngagementFromOpportunityTask([
    'AwsSubmission' => [ // REQUIRED
        'InvolvementType' => 'For Visibility Only|Co-Sell', // REQUIRED
        'Visibility' => 'Full|Limited',
    ],
    'Catalog' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

AwsSubmission

: Required: Yes
: Type: AwsSubmission structure

Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.

Catalog

: Required: Yes
: Type: string

Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.

ClientToken

: Required: Yes
: Type: string

A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.

Identifier

: Required: Yes
: Type: string

The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.

Result Syntax

[
    'Message' => '<string>',
    'OpportunityId' => '<string>',
    'ReasonCode' => 'InvitationAccessDenied|EngagementAccessDenied|OpportunityAccessDenied|ResourceSnapshotJobAccessDenied|EngagementValidationFailed|OpportunitySubmissionFailed|EngagementInvitationConflict|InternalError|OpportunityValidationFailed|OpportunityConflict|ResourceSnapshotAccessDenied',
    'StartTime' => <DateTime>,
    'TaskArn' => '<string>',
    'TaskId' => '<string>',
    'TaskStatus' => 'IN_PROGRESS|COMPLETE|FAILED',
]

Result Details

Members

Message

: Type: string

If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

OpportunityId

: Type: string

Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.

ReasonCode

: Type: string

Indicates the reason for task failure using an enumerated code.

StartTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

TaskArn

: Type: string

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

TaskId

: Type: string

The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.

TaskStatus

: Type: string

Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

ServiceQuotaExceededException:

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

UpdateOpportunity

$result = $client->updateOpportunity([/* ... */]);
$promise = $client->updateOpportunityAsync([/* ... */]);

Updates the Opportunity record identified by a given Identifier. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate.

When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to null. The best practice is to always perform a GetOpportunity to retrieve the latest values, then send the complete payload with the updated values to be changed.

Parameter Syntax

$result = $client->updateOpportunity([
    'Catalog' => '<string>', // REQUIRED
    'Customer' => [
        'Account' => [
            'Address' => [
                'City' => '<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',
                'PostalCode' => '<string>',
                'StateOrRegion' => '<string>',
                'StreetAddress' => '<string>',
            ],
            'AwsAccountId' => '<string>',
            'CompanyName' => '<string>', // REQUIRED
            'Duns' => '<string>',
            'Industry' => 'Aerospace|Agriculture|Automotive|Computers and Electronics|Consumer Goods|Education|Energy - Oil and Gas|Energy - Power and Utilities|Financial Services|Gaming|Government|Healthcare|Hospitality|Life Sciences|Manufacturing|Marketing and Advertising|Media and Entertainment|Mining|Non-Profit Organization|Professional Services|Real Estate and Construction|Retail|Software and Internet|Telecommunications|Transportation and Logistics|Travel|Wholesale and Distribution|Other',
            'OtherIndustry' => '<string>',
            'WebsiteUrl' => '<string>',
        ],
        'Contacts' => [
            [
                'BusinessTitle' => '<string>',
                'Email' => '<string>',
                'FirstName' => '<string>',
                'LastName' => '<string>',
                'Phone' => '<string>',
            ],
            // ...
        ],
    ],
    'Identifier' => '<string>', // REQUIRED
    'LastModifiedDate' => <integer || string || DateTime>, // REQUIRED
    'LifeCycle' => [
        'ClosedLostReason' => 'Customer Deficiency|Delay / Cancellation of Project|Legal / Tax / Regulatory|Lost to Competitor - Google|Lost to Competitor - Microsoft|Lost to Competitor - SoftLayer|Lost to Competitor - VMWare|Lost to Competitor - Other|No Opportunity|On Premises Deployment|Partner Gap|Price|Security / Compliance|Technical Limitations|Customer Experience|Other|People/Relationship/Governance|Product/Technology|Financial/Commercial',
        'NextSteps' => '<string>',
        'NextStepsHistory' => [
            [
                'Time' => <integer || string || DateTime>, // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ReviewComments' => '<string>',
        'ReviewStatus' => 'Pending Submission|Submitted|In review|Approved|Rejected|Action Required',
        'ReviewStatusReason' => '<string>',
        'Stage' => 'Prospect|Qualified|Technical Validation|Business Validation|Committed|Launched|Closed Lost',
        'TargetCloseDate' => '<string>',
    ],
    'Marketing' => [
        'AwsFundingUsed' => 'Yes|No',
        'CampaignName' => '<string>',
        'Channels' => ['<string>', ...],
        'Source' => 'Marketing Activity|None',
        'UseCases' => ['<string>', ...],
    ],
    'NationalSecurity' => 'Yes|No',
    'OpportunityType' => 'Net New Business|Flat Renewal|Expansion',
    'PartnerOpportunityIdentifier' => '<string>',
    'PrimaryNeedsFromAws' => ['<string>', ...],
    'Project' => [
        'AdditionalComments' => '<string>',
        'ApnPrograms' => ['<string>', ...],
        'CompetitorName' => 'Oracle Cloud|On-Prem|Co-location|Akamai|AliCloud|Google Cloud Platform|IBM Softlayer|Microsoft Azure|Other- Cost Optimization|No Competition|*Other',
        'CustomerBusinessProblem' => '<string>',
        'CustomerUseCase' => '<string>',
        'DeliveryModels' => ['<string>', ...],
        'ExpectedCustomerSpend' => [
            [
                'Amount' => '<string>', // REQUIRED
                'CurrencyCode' => 'USD|EUR|GBP|AUD|CAD|CNY|NZD|INR|JPY|CHF|SEK|AED|AFN|ALL|AMD|ANG|AOA|ARS|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CDF|CHE|CHW|CLF|CLP|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|FJD|FKP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|IQD|IRR|ISK|JMD|JOD|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USN|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XCD|XDR|XOF|XPF|XSU|XUA|YER|ZAR|ZMW|ZWL', // REQUIRED
                'Frequency' => 'Monthly', // REQUIRED
                'TargetCompany' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'OtherCompetitorNames' => '<string>',
        'OtherSolutionDescription' => '<string>',
        'RelatedOpportunityIdentifier' => '<string>',
        'SalesActivities' => ['<string>', ...],
        'Title' => '<string>',
    ],
    'SoftwareRevenue' => [
        'DeliveryModel' => 'Contract|Pay-as-you-go|Subscription',
        'EffectiveDate' => '<string>',
        'ExpirationDate' => '<string>',
        'Value' => [
            'Amount' => '<string>', // REQUIRED
            'CurrencyCode' => 'USD|EUR|GBP|AUD|CAD|CNY|NZD|INR|JPY|CHF|SEK|AED|AFN|ALL|AMD|ANG|AOA|ARS|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CDF|CHE|CHW|CLF|CLP|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|FJD|FKP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|IQD|IRR|ISK|JMD|JOD|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USN|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XCD|XDR|XOF|XPF|XSU|XUA|YER|ZAR|ZMW|ZWL', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is updated in. Use AWS to update real opportunities in the production environment, and Sandbox for testing in secure, isolated environments. When you use the Sandbox catalog, it allows you to simulate and validate your interactions with Amazon Web Services services without affecting live data or operations.

Customer

: Type: Customer structure

Specifies details of the customer associated with the Opportunity.

Identifier

: Required: Yes
: Type: string

Read-only, system generated Opportunity unique identifier.

LastModifiedDate

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

DateTime when the opportunity was last modified.

LifeCycle

: Type: LifeCycle structure

An object that contains lifecycle details for the Opportunity.

Marketing

: Type: Marketing structure

An object that contains marketing details for the Opportunity.

NationalSecurity

: Type: string

Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national-security-related opportunities, validation and compliance rules may apply, impacting the opportunity's visibility and processing.

OpportunityType

: Type: string

Specifies the 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.

PartnerOpportunityIdentifier

: Type: 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.

PrimaryNeedsFromAws

: Type: Array of strings

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 AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).
Cosell—Technical Consultation: Connection 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 RFx support from Amazon Web Services.
Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.

Project

: Type: Project structure

An object that contains project details summary for the Opportunity.

SoftwareRevenue

: Type: SoftwareRevenue structure

Specifies details of a customer's procurement terms. Required only for partners in eligible programs.

Result Syntax

[
    'Id' => '<string>',
    'LastModifiedDate' => <DateTime>,
]

Result Details

Members

Id

: Required: Yes
: Type: string

Read-only, system generated Opportunity unique identifier.

LastModifiedDate

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

DateTime when the opportunity was last modified.

Errors

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.