| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.EKS.ListFargateProfiles
Description
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
This operation returns paginated results.
Synopsis
- data ListFargateProfiles = ListFargateProfiles' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- clusterName :: Text
- newListFargateProfiles :: Text -> ListFargateProfiles
- listFargateProfiles_nextToken :: Lens' ListFargateProfiles (Maybe Text)
- listFargateProfiles_maxResults :: Lens' ListFargateProfiles (Maybe Natural)
- listFargateProfiles_clusterName :: Lens' ListFargateProfiles Text
- data ListFargateProfilesResponse = ListFargateProfilesResponse' {
- nextToken :: Maybe Text
- fargateProfileNames :: Maybe [Text]
- httpStatus :: Int
- newListFargateProfilesResponse :: Int -> ListFargateProfilesResponse
- listFargateProfilesResponse_nextToken :: Lens' ListFargateProfilesResponse (Maybe Text)
- listFargateProfilesResponse_fargateProfileNames :: Lens' ListFargateProfilesResponse (Maybe [Text])
- listFargateProfilesResponse_httpStatus :: Lens' ListFargateProfilesResponse Int
Creating a Request
data ListFargateProfiles Source #
See: newListFargateProfiles smart constructor.
Constructors
| ListFargateProfiles' | |
Fields
| |
Instances
newListFargateProfiles Source #
Arguments
| :: Text | |
| -> ListFargateProfiles |
Create a value of ListFargateProfiles with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListFargateProfiles', listFargateProfiles_nextToken - 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.
$sel:maxResults:ListFargateProfiles', listFargateProfiles_maxResults - 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.
$sel:clusterName:ListFargateProfiles', listFargateProfiles_clusterName - The name of the Amazon EKS cluster that you would like to list Fargate
profiles in.
Request Lenses
listFargateProfiles_nextToken :: Lens' ListFargateProfiles (Maybe Text) Source #
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.
listFargateProfiles_maxResults :: Lens' ListFargateProfiles (Maybe Natural) Source #
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.
listFargateProfiles_clusterName :: Lens' ListFargateProfiles Text Source #
The name of the Amazon EKS cluster that you would like to list Fargate profiles in.
Destructuring the Response
data ListFargateProfilesResponse Source #
See: newListFargateProfilesResponse smart constructor.
Constructors
| ListFargateProfilesResponse' | |
Fields
| |
Instances
newListFargateProfilesResponse Source #
Create a value of ListFargateProfilesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListFargateProfiles', listFargateProfilesResponse_nextToken - 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.
$sel:fargateProfileNames:ListFargateProfilesResponse', listFargateProfilesResponse_fargateProfileNames - A list of all of the Fargate profiles associated with the specified
cluster.
$sel:httpStatus:ListFargateProfilesResponse', listFargateProfilesResponse_httpStatus - The response's http status code.
Response Lenses
listFargateProfilesResponse_nextToken :: Lens' ListFargateProfilesResponse (Maybe Text) Source #
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.
listFargateProfilesResponse_fargateProfileNames :: Lens' ListFargateProfilesResponse (Maybe [Text]) Source #
A list of all of the Fargate profiles associated with the specified cluster.
listFargateProfilesResponse_httpStatus :: Lens' ListFargateProfilesResponse Int Source #
The response's http status code.