Request Syntax Request Parameters Response Elements Errors See Also

AssociateOpportunity

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 types of entities:

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

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

Solution: Use the ListSolutions operation.
AWS products: For the latest list of AWSproducts, see the AWS products list.
AWS Marketplace private offer: Use the Using the AWS 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 available. For more information, see ListEntities.

Request Syntax


{
   "Catalog": "string",
   "OpportunityIdentifier": "string",
   "RelatedEntityIdentifier": "string",
   "RelatedEntityType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Catalog

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 association is made in. Use AWS to associate opportunities in the AWS catalog, and Sandbox to test in a secure and isolated environment.

Type: String

Pattern: ^[a-zA-Z]+$

Required: Yes

OpportunityIdentifier

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.

Type: String

Pattern: ^O[0-9]{1,19}$

Required: Yes

RelatedEntityIdentifier

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

RelatedEntityType

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

Type: String

Valid Values: Solutions | AwsProducts | AwsMarketplaceOffers

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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.

HTTP Status Code: 400

InternalServerException

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.

HTTP Status Code: 500

ResourceNotFoundException

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.

HTTP Status Code: 400

ThrottlingException

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.

HTTP Status Code: 400

ValidationException

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.

HTTP Status Code: 400