EKS / Client / list_fargate_profiles
list_fargate_profiles#
- EKS.Client.list_fargate_profiles(**kwargs)#
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.list_fargate_profiles( clusterName='string', maxResults=123, nextToken='string' )
- Parameters:
clusterName (string) –
[REQUIRED]
The name of your cluster.
maxResults (integer) – The maximum number of results, returned in paginated output. You receive
maxResults
in a single page, along with anextToken
response element. You can see the remaining results of the initial request by sending another request with the returnednextToken
value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and anextToken
value, if applicable, are returned.nextToken (string) –
The
nextToken
value returned from a previous paginated 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. This value is null when there are no more results to return.Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
- Return type:
dict
- Returns:
Response Syntax
{ 'fargateProfileNames': [ 'string', ], 'nextToken': 'string' }
Response Structure
(dict) –
fargateProfileNames (list) –
A list of all of the Fargate profiles associated with the specified cluster.
(string) –
nextToken (string) –
The
nextToken
value returned from a previous paginated 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. This value is null when there are no more results to return.Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
Exceptions
EKS.Client.exceptions.InvalidParameterException
EKS.Client.exceptions.ResourceNotFoundException
EKS.Client.exceptions.ClientException
EKS.Client.exceptions.ServerException