Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.
Parameters:
-
include_canceled
(Optional[bool], default:
None
)
–
Designates whether to include profiles with the status of CANCELED.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of profiles to be returned.
-
next_token
(Optional[NextToken], default:
None
)
–
Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.
-
platform_id
(Optional[PlatformId], default:
None
)
–
Filters results to return only signing jobs initiated for a specified signing platform.
-
statuses
(Optional[Statuses], default:
None
)
–
Filters results to return only signing jobs with statuses in the specified list.
Raises:
Source code in docs_src/capo_signer/_services/signer.py
| def list_signing_profiles(
self,
*,
config_overrides: Optional[signerClientConfig] = None,
include_canceled: Optional["capo_signer.types.bool.bool"] = None,
max_results: Optional["capo_signer.types.max_results.MaxResults"] = None,
next_token: Optional["capo_signer.types.next_token.NextToken"] = None,
platform_id: Optional["capo_signer.types.platform_id.PlatformId"] = None,
statuses: Optional["capo_signer.types.statuses.Statuses"] = None,
) -> "capo_signer.types.list_signing_profiles_response.ListSigningProfilesResponse":
"""<p>Lists all available signing profiles in your AWS account. Returns only profiles with an <code>ACTIVE</code> status unless the <code>includeCanceled</code> request field is set to <code>true</code>. If additional jobs remain to be listed, AWS Signer returns a <code>nextToken</code> value. Use this value in subsequent calls to <code>ListSigningJobs</code> to fetch the remaining values. You can continue calling <code>ListSigningJobs</code> with your <code>maxResults</code> parameter and with new values that Signer returns in the <code>nextToken</code> parameter until all of your signing jobs have been returned.</p>
Args:
include_canceled: <p>Designates whether to include profiles with the status of <code>CANCELED</code>.</p>
max_results: <p>The maximum number of profiles to be returned.</p>
next_token: <p>Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of <code>nextToken</code> from the response that you just received.</p>
platform_id: <p>Filters results to return only signing jobs initiated for a specified signing platform.</p>
statuses: <p>Filters results to return only signing jobs with statuses in the specified list.</p>
Raises:
capo_signer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_signer.errors.internal_service_error_exception.InternalServiceErrorException: <p>An internal error occurred.</p>
capo_signer.errors.too_many_requests_exception.TooManyRequestsException: <p>The allowed number of job-signing requests has been exceeded.</p> <p>This error supersedes the error <code>ThrottlingException</code>.</p>
capo_signer.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_signer.types.list_signing_profiles_request.ListSigningProfilesRequest]",
) -> OperationResponse[
"capo_signer.types.list_signing_profiles_response.ListSigningProfilesResponse"
]:
import capo_signer._operations.wallaby_service.list_signing_profiles
output, http_response = (
capo_signer._operations.wallaby_service.list_signing_profiles.list_signing_profiles(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSigningProfiles")
)
input_: capo_signer.types.list_signing_profiles_request.ListSigningProfilesRequest = {}
if include_canceled is not None:
input_["include_canceled"] = include_canceled
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if platform_id is not None:
input_["platform_id"] = platform_id
if statuses is not None:
input_["statuses"] = statuses
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|