Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
The token for the next page of results.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return in a single call. Valid range is 1 to 100.
-
support_permit_statuses
(Optional[SupportPermitStatuses], default:
None
)
–
Filters the results by support permit status. Valid values: ACTIVE, INACTIVE, DELETING.
Raises:
Source code in docs_src/capo_supportauthz/_services/support_auth_z.py
| def list_support_permits(
self,
*,
config_overrides: Optional[SupportAuthZClientConfig] = None,
next_token: Optional["capo_supportauthz.types.next_token.NextToken"] = None,
max_results: Optional["capo_supportauthz.types.max_results.MaxResults"] = None,
support_permit_statuses: Optional[
"capo_supportauthz.types.support_permit_statuses.SupportPermitStatuses"
] = None,
) -> "capo_supportauthz.types.list_support_permits_output.ListSupportPermitsOutput":
"""<p>Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.</p>
Args:
next_token: <p>The token for the next page of results.</p>
max_results: <p>The maximum number of results to return in a single call. Valid range is 1 to 100.</p>
support_permit_statuses: <p>Filters the results by support permit status. Valid values: ACTIVE, INACTIVE, DELETING.</p>
Raises:
capo_supportauthz.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this operation.</p>
capo_supportauthz.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred. Try again later.</p>
capo_supportauthz.errors.throttling_exception.ThrottlingException: <p>The request rate exceeded the allowed limit. Try again later.</p>
capo_supportauthz.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
capo_supportauthz.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_supportauthz.types.list_support_permits_input.ListSupportPermitsInput]",
) -> OperationResponse[
"capo_supportauthz.types.list_support_permits_output.ListSupportPermitsOutput"
]:
import capo_supportauthz._operations.support_auth_z.list_support_permits
output, http_response = (
capo_supportauthz._operations.support_auth_z.list_support_permits.list_support_permits(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSupportPermits")
)
input_: capo_supportauthz.types.list_support_permits_input.ListSupportPermitsInput = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if support_permit_statuses is not None:
input_["support_permit_statuses"] = support_permit_statuses
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|