Amazon Signer · Schema
DescribeSigningJobResponse
DescribeSigningJobResponse schema from AWS Signer API
Code SigningIoTLambdaSecurity
Properties
| Name | Type | Description |
|---|---|---|
| jobId | object | |
| source | object | |
| signingMaterial | object | |
| platformId | object | |
| platformDisplayName | object | |
| profileName | object | |
| profileVersion | object | |
| overrides | object | |
| signingParameters | object | |
| createdAt | object | |
| completedAt | object | |
| signatureExpiresAt | object | |
| requestedBy | object | |
| status | object | |
| statusReason | object | |
| revocationRecord | object | |
| signedObject | object | |
| jobOwner | object | |
| jobInvoker | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-signer/refs/heads/main/json-schema/amazon-signer-describe-signing-job-response-schema.json",
"title": "DescribeSigningJobResponse",
"description": "DescribeSigningJobResponse schema from AWS Signer API",
"type": "object",
"properties": {
"jobId": {
"allOf": [
{
"type": "string"
},
{
"description": "The ID of the signing job on output."
}
]
},
"source": {
"allOf": [
{
"type": "object",
"properties": {
"s3": {
"allOf": [
{
"$ref": "#/components/schemas/S3Source"
},
{
"description": "The <code>S3Source</code> object."
}
]
}
},
"description": "An <code>S3Source</code> object that contains information about the S3 bucket where you saved your unsigned code."
},
{
"description": "The object that contains the name of your S3 bucket or your raw code."
}
]
},
"signingMaterial": {
"allOf": [
{
"type": "object",
"required": [
"certificateArn"
],
"properties": {
"certificateArn": {
"allOf": [
{
"$ref": "#/components/schemas/CertificateArn"
},
{
"description": "The Amazon Resource Name (ARN) of the certificates that is used to sign your code."
}
]
}
},
"description": "The ACM certificate that is used to sign your code."
},
{
"description": "The Amazon Resource Name (ARN) of your code signing certificate."
}
]
},
"platformId": {
"allOf": [
{
"type": "string"
},
{
"description": "The microcontroller platform to which your signed code image will be distributed."
}
]
},
"platformDisplayName": {
"allOf": [
{
"type": "string"
},
{
"description": "A human-readable name for the signing platform associated with the signing job."
}
]
},
"profileName": {
"allOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9_]{2,}",
"minLength": 2,
"maxLength": 64
},
{
"description": "The name of the profile that initiated the signing operation."
}
]
},
"profileVersion": {
"allOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9]{10}$",
"minLength": 10,
"maxLength": 10
},
{
"description": "The version of the signing profile used to initiate the signing job."
}
]
},
"overrides": {
"allOf": [
{
"type": "object",
"properties": {
"signingConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/SigningConfigurationOverrides"
},
{
"description": "A signing configuration that overrides the default encryption or hash algorithm of a signing job."
}
]
},
"signingImageFormat": {
"allOf": [
{
"$ref": "#/components/schemas/ImageFormat"
},
{
"description": "A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, <code>JSONEmbedded</code> or <code>JSONDetached</code>. (A third format value, <code>JSON</code>, is reserved for future use.) With <code>JSONEmbedded</code>, the signing image has the payload embedded in it. With <code>JSONDetached</code>, the payload is not be embedded in the signing image."
}
]
}
},
"description": "Any overrides that are applied to the signing configuration of a code signing platform."
},
{
"description": "A list of any overrides that were applied to the signing operation."
}
]
},
"signingParameters": {
"allOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SigningParameterValue"
}
},
{
"description": "Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job. "
}
]
},
"createdAt": {
"allOf": [
{
"type": "string",
"format": "date-time"
},
{
"description": "Date and time that the signing job was created."
}
]
},
"completedAt": {
"allOf": [
{
"type": "string",
"format": "date-time"
},
{
"description": "Date and time that the signing job was completed."
}
]
},
"signatureExpiresAt": {
"allOf": [
{
"type": "string",
"format": "date-time"
},
{
"description": "Thr expiration timestamp for the signature generated by the signing job."
}
]
},
"requestedBy": {
"allOf": [
{
"type": "string"
},
{
"description": "The IAM principal that requested the signing job."
}
]
},
"status": {
"allOf": [
{
"type": "string",
"enum": [
"InProgress",
"Failed",
"Succeeded"
]
},
{
"description": "Status of the signing job."
}
]
},
"statusReason": {
"allOf": [
{
"type": "string"
},
{
"description": "String value that contains the status reason."
}
]
},
"revocationRecord": {
"allOf": [
{
"type": "object",
"properties": {
"reason": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "A caller-supplied reason for revocation."
}
]
},
"revokedAt": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The time of revocation."
}
]
},
"revokedBy": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The identity of the revoker."
}
]
}
},
"description": "Revocation information for a signing job."
},
{
"description": "A revocation record if the signature generated by the signing job has been revoked. Contains a timestamp and the ID of the IAM entity that revoked the signature."
}
]
},
"signedObject": {
"allOf": [
{
"type": "object",
"properties": {
"s3": {
"allOf": [
{
"$ref": "#/components/schemas/S3SignedObject"
},
{
"description": "The <code>S3SignedObject</code>."
}
]
}
},
"description": "Points to an <code>S3SignedObject</code> object that contains information about your signed code image."
},
{
"description": "Name of the S3 bucket where the signed code image is saved by code signing."
}
]
},
"jobOwner": {
"allOf": [
{
"type": "string",
"pattern": "^[0-9]{12}$",
"minLength": 12,
"maxLength": 12
},
{
"description": "The AWS account ID of the job owner."
}
]
},
"jobInvoker": {
"allOf": [
{
"type": "string",
"pattern": "^[0-9]{12}$",
"minLength": 12,
"maxLength": 12
},
{
"description": "The IAM entity that initiated the signing job."
}
]
}
}
}