Menu
Amazon EC2 Container Service
API Reference (API Version 2014-11-13)

DeleteAttributes

Deletes one or more custom attributes from an Amazon ECS resource.

Request Syntax

Copy
{ "attributes": [ { "name": "string", "targetId": "string", "targetType": "string", "value": "string" } ], "cluster": "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.

attributes

The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.

Type: Array of Attribute objects

Required: Yes

cluster

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

Type: String

Required: No

Response Syntax

Copy
{ "attributes": [ { "name": "string", "targetId": "string", "targetType": "string", "value": "string" } ] }

Response Elements

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

The following data is returned in JSON format by the service.

attributes

A list of attribute objects that were successfully deleted from your resource.

Type: Array of Attribute objects

Errors

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

ClusterNotFoundException

The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

HTTP Status Code: 400

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400

TargetNotFoundException

The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.

HTTP Status Code: 400

Example

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example deletes an attribute with the name stack from a container instance.

Sample Request

Copy
POST / HTTP/1.1 Host: madison.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 169 X-Amz-Target: AmazonEC2ContainerServiceV20141113.DeleteAttributes X-Amz-Date: 20161222T193851Z User-Agent: aws-cli/1.11.30 Python/2.7.12 Darwin/16.3.0 botocore/1.4.87 Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "cluster": "default", "attributes": [ { "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", "name": "stack" } ] }

Sample Response

Copy
HTTP/1.1 200 OK Server: Server Date: Thu, 22 Dec 2016 19:38:51 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 158 Connection: keep-alive x-amzn-RequestId: 445193ca-c87e-11e6-86db-1bd3d9928caf { "attributes": [ { "name": "stack", "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", "value": "production" } ] }

See Also

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