View a markdown version of this page

DeleteExperimentDefinition - AWS AppConfig

DeleteExperimentDefinition

Deletes an experiment definition. You can archive the definition to hide it from the active list while preserving it for future reference, or permanently delete it along with all associated run history.

Request Syntax

DELETE /applications/ApplicationIdentifier/experimentdefinitions/ExperimentDefinitionIdentifier?delete_type=DeleteType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationIdentifier

The application ID or name.

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

Required: Yes

DeleteType

The type of deletion to perform. Valid values include archive (hide but preserve) and permanent (delete permanently).

Valid Values: ARCHIVE | DESTROY

ExperimentDefinitionIdentifier

The experiment definition ID or name.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 204

Response Elements

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

Errors

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

BadRequestException

The input fails to satisfy the constraints specified by an AWS service.

Details

Detailed information about the input that failed to satisfy the constraints specified by a call.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

InternalServerException

There was an internal failure in the AWS AppConfig service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of DeleteExperimentDefinition.

Sample Request

DELETE /applications/abc1234/experimentdefinitions/bsxyd7k HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com User-Agent: aws-cli X-Amz-Date: 20210916T175455Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0

Sample Response

HTTP/1.1 204 No Content

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: