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 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 the Amazon EKS cluster that you would like to list Fargate profiles in.

• maxResults (integer) -- The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.
• nextToken (string) -- The nextToken value returned from a previous paginated ListFargateProfiles request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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 to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles request exceed maxResults , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

• EKS.Client.exceptions.InvalidParameterException
• EKS.Client.exceptions.ResourceNotFoundException
• EKS.Client.exceptions.ClientException
• EKS.Client.exceptions.ServerException