ListFargateProfiles
Lists the Amazon Fargate profiles associated with the specified cluster in your Amazon account in the specified Region.
Request Syntax
GET /clusters/name
/fargate-profiles?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the Amazon EKS cluster that you would like to list Fargate profiles in.
Required: Yes
- maxResults
-
The maximum number of Fargate profile results returned by
ListFargateProfiles
in paginated output. When you use this parameter,ListFargateProfiles
returns onlymaxResults
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListFargateProfiles
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListFargateProfiles
returns up to 100 results and anextToken
value if applicable.Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The
nextToken
value returned from a previous paginatedListFargateProfiles
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"fargateProfileNames": [ "string" ],
"nextToken": "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.
- fargateProfileNames
-
A list of all of the Fargate profiles associated with the specified cluster.
Type: Array of strings
- nextToken
-
The
nextToken
value to include in a futureListFargateProfiles
request. When the results of aListFargateProfiles
request exceedmaxResults
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.Type: String
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 a user 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 with ListNodegroups. Amazon EKS clusters and node groups are 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 Amazon 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 Amazon Command Line
Interface (Amazon CLI)
Example
The following example lists the Fargate profiles in the
fargate
cluster.
Sample Request
GET /clusters/fargate/fargate-profiles 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: 20191120T210416Z
Authorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OK
Date: Wed, 20 Nov 2019 21:04:16 GMT
Content-Type: application/json
Content-Length: 91
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: DeeMiFxHvHcFd3g=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive
{
"fargateProfileNames": [
"default-with-infrastructure-label",
"monitoring"
],
"nextToken": null
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: