Request Syntax Request Parameters Response Elements Errors See Also

DisassociateOpportunity

Allows you to remove an existing association between an Opportunity and related entities such as a Partner Solution, AWS product, or an AWS 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 related entity that's required.

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

Type: String

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

Required: Yes

OpportunityIdentifier

The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier is crucial to ensure the correct opportunity is updated, especially in environments with numerous opportunities.

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

Type: String

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

Required: Yes

RelatedEntityIdentifier

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 AWS Marketplace.

For AWS Marketplace entities, use the AWS Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see AWS MarketplaceUsing the AWS 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.

Type: String

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

Required: Yes

RelatedEntityType

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 and ensures that the right connections are removed.

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

Validation: Provide a valid entity type to ensure successful disassociation. Invalid or incorrect entity types result in an error.

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