disassociate_opportunity
async
¶
disassociate_opportunity(
catalog: CatalogIdentifier,
opportunity_identifier: OpportunityIdentifier,
related_entity_type: RelatedEntityType,
related_entity_identifier: str,
*,
config_overrides: Optional[AsyncPartnerCentralSellingClientConfig] = None,
) -> None
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.
Parameters:
-
catalog(CatalogIdentifier) –Specifies the catalog associated with the request. This field takes a string value from a predefined list:
AWSorSandbox. The catalog determines which environment the opportunity disassociation is made in. UseAWSto disassociate opportunities in the Amazon Web Services catalog, andSandboxfor testing in secure, isolated environments. -
opportunity_identifier(OpportunityIdentifier) –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.
-
related_entity_type(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 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.
-
related_entity_identifier(str) –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.
Raises:
-
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.
-
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.
-
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.
-
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.
-
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.
-
UnknownServiceError–The service returned an error code this client does not model.