Skip to content

Bedrock AgentCore  >  Operations  >  delete_recommendation

delete_recommendation

Operation

delete_recommendation async 

delete_recommendation(input: DeleteRecommendationInput, plugins: list[Plugin] | None = None) -> DeleteRecommendationOutput

Deletes a recommendation and its associated results.

Parameters:

Name Type Description Default
input DeleteRecommendationInput

An instance of DeleteRecommendationInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeleteRecommendationOutput

An instance of DeleteRecommendationOutput.

Input

DeleteRecommendationInput dataclass

Dataclass for DeleteRecommendationInput structure.

Attributes

recommendation_id class-attribute instance-attribute 
recommendation_id: str | None = None

The unique identifier of the recommendation to delete.

Output

DeleteRecommendationOutput dataclass

Dataclass for DeleteRecommendationOutput structure.

Attributes

recommendation_id instance-attribute 
recommendation_id: str

The unique identifier of the deleted recommendation.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status instance-attribute 
status: str

The status of the recommendation deletion operation.