Displays the full description of the subscription.
Parameters:
-
max_results
(Optional[ListEksAnywhereSubscriptionsRequestMaxResults], default:
None
)
–
The maximum number of cluster results returned by ListEksAnywhereSubscriptions in paginated output. When you use this parameter, ListEksAnywhereSubscriptions 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 ListEksAnywhereSubscriptions request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListEksAnywhereSubscriptions returns up to 10 results and a nextToken value if applicable.
-
next_token
(Optional[String], default:
None
)
–
The nextToken value returned from a previous paginated ListEksAnywhereSubscriptions 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.
-
include_status
(Optional[EksAnywhereSubscriptionStatusValues], default:
None
)
–
An array of subscription statuses to filter on.
Raises:
-
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.
-
InvalidParameterException
–
The specified parameter is invalid. Review the available parameters for the API request.
-
ServerException
–
These errors are usually caused by a server-side issue.
-
ServiceUnavailableException
–
The service is unavailable. Back off and retry the operation.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_eks/_services/async_eks.py
| async def list_eks_anywhere_subscriptions(
self,
*,
config_overrides: Optional[AsyncEKSClientConfig] = None,
max_results: Optional[
"capo_eks.types.list_eks_anywhere_subscriptions_request_max_results.ListEksAnywhereSubscriptionsRequestMaxResults"
] = None,
next_token: Optional["capo_eks.types.string.String"] = None,
include_status: Optional[
"capo_eks.types.eks_anywhere_subscription_status_values.EksAnywhereSubscriptionStatusValues"
] = None,
) -> "capo_eks.types.list_eks_anywhere_subscriptions_response.ListEksAnywhereSubscriptionsResponse":
"""<p>Displays the full description of the subscription.</p>
Args:
max_results: <p>The maximum number of cluster results returned by ListEksAnywhereSubscriptions in paginated output. When you use this parameter, ListEksAnywhereSubscriptions 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 ListEksAnywhereSubscriptions request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListEksAnywhereSubscriptions returns up to 10 results and a nextToken value if applicable.</p>
next_token: <p>The <code>nextToken</code> value returned from a previous paginated <code>ListEksAnywhereSubscriptions</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>
include_status: <p>An array of subscription statuses to filter on.</p>
Raises:
capo_eks.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html">IAM principal</a> that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.</p>
capo_eks.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
capo_eks.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
capo_eks.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is unavailable. Back off and retry the operation.</p>
capo_eks.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_eks.types.list_eks_anywhere_subscriptions_request.ListEksAnywhereSubscriptionsRequest]",
) -> AsyncOperationResponse[
"capo_eks.types.list_eks_anywhere_subscriptions_response.ListEksAnywhereSubscriptionsResponse"
]:
import capo_eks._operations.aws_wesley_frontend.list_eks_anywhere_subscriptions
(
output,
http_response,
) = await capo_eks._operations.aws_wesley_frontend.list_eks_anywhere_subscriptions.async_list_eks_anywhere_subscriptions(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListEksAnywhereSubscriptions")
)
input_: capo_eks.types.list_eks_anywhere_subscriptions_request.ListEksAnywhereSubscriptionsRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if include_status is not None:
input_["include_status"] = include_status
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|