ListSigningProfiles
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.
Request Syntax
GET /signing-profiles?includeCanceled=includeCanceled
&maxResults=maxResults
&nextToken=nextToken
&platformId=platformId
&statuses=statuses
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- includeCanceled
-
Designates whether to include profiles with the status of
CANCELED
. - maxResults
-
The maximum number of profiles to be returned.
Valid Range: Minimum value of 1. Maximum value of 25.
- nextToken
-
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. - platformId
-
Filters results to return only signing jobs initiated for a specified signing platform.
- statuses
-
Filters results to return only signing jobs with statuses in the specified list.
Valid Values:
Active | Canceled | Revoked
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"profiles": [
{
"arn": "string",
"platformDisplayName": "string",
"platformId": "string",
"profileName": "string",
"profileVersion": "string",
"profileVersionArn": "string",
"signatureValidityPeriod": {
"type": "string",
"value": number
},
"signingMaterial": {
"certificateArn": "string"
},
"signingParameters": {
"string" : "string"
},
"status": "string",
"tags": {
"string" : "string"
}
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
Value for specifying the next set of paginated results to return.
Type: String
- profiles
-
A list of profiles that are available in the AWS account. This includes profiles with the status of
CANCELED
if theincludeCanceled
parameter is set totrue
.Type: Array of SigningProfile objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServiceErrorException
-
An internal error occurred.
HTTP Status Code: 500
- TooManyRequestsException
-
The allowed number of job-signing requests has been exceeded.
This error supersedes the error
ThrottlingException
.HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: