DeleteFargateProfile
Deletes an AWS Fargate profile.
When you delete a Fargate profile, any Pod
running on
Fargate that was created with the profile is deleted. If the
Pod
matches another Fargate profile, then it is
scheduled on Fargate with that profile. If it no longer matches any
Fargate profiles, then it's not scheduled on Fargate
and may remain in a pending state.
Only one Fargate profile in a cluster can be in the
DELETING
status at a time. You must wait for a Fargate
profile to finish deleting before you can delete any other profiles in that
cluster.
Request Syntax
DELETE /clusters/name
/fargate-profiles/fargateProfileName
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of your cluster.
Required: Yes
- fargateProfileName
-
The name of the Fargate profile to delete.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"fargateProfile": {
"clusterName": "string",
"createdAt": number,
"fargateProfileArn": "string",
"fargateProfileName": "string",
"health": {
"issues": [
{
"code": "string",
"message": "string",
"resourceIds": [ "string" ]
}
]
},
"podExecutionRoleArn": "string",
"selectors": [
{
"labels": {
"string" : "string"
},
"namespace": "string"
}
],
"status": "string",
"subnets": [ "string" ],
"tags": {
"string" : "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.
- fargateProfile
-
The deleted Fargate profile.
Type: FargateProfile object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource could not be found. You can view your available clusters with
ListClusters
. You can view your available managed node groups withListNodegroups
. Amazon EKS clusters and node groups are AWS Region specific.HTTP Status Code: 404
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
Examples
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 Amazon EKS General
Reference.
You need to learn how to sign HTTP requests only if you intend to manually
create them. When you use the AWS Command Line
Interface (AWS CLI)
Example
The following example deletes a Fargate profile called
compute-label
in the fargate
cluster.
Sample Request
DELETE /clusters/fargate/fargate-profiles/compute-label HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.284 Python/3.7.5 Darwin/18.7.0 botocore/1.13.20
X-Amz-Date: 20191120T203729Z
Authorization: AUTHPARAMS
Content-Length: 0
Sample Response
HTTP/1.1 200 OK
Date: Wed, 20 Nov 2019 20:37:30 GMT
Content-Type: application/json
Content-Length: 610
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: DeaRjFWPvHcFcXw=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive
{
"fargateProfile": {
"fargateProfileName": "compute-label",
"fargateProfileArn": "arn:aws:eks:us-west-2:012345678910:fargateprofile/fargate/compute-label/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"clusterName": "fargate",
"createdAt": 1574206849.791,
"podExecutionRoleArn": "arn:aws:iam::012345678910:role/AmazonEKSPodExecutionRole",
"subnets": [
"subnet-xxxxxxxxxxxxxxxxx",
"subnet-yyyyyyyyyyyyyyyyy"
],
"selectors": [
{
"namespace": "kube-system",
"labels": {
"compute": "fargate"
}
}
],
"status": "DELETING",
"tags": {}
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: