Class: AWS.Signer

var params = {
  profileName: 'STRING_VALUE' /* required */
};
signer.cancelSigningProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • profileName — (String)

    The name of the signing profile to be canceled.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  jobId: 'STRING_VALUE' /* required */
};
signer.describeSigningJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobId — (String)

    The ID of the signing job on input.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • jobId — (String)

      The ID of the signing job on output.

    • source — (map)

      The object that contains the name of your S3 bucket or your raw code.

      • s3 — (map)

        The S3Source object.

        • bucketName — required — (String)

          Name of the S3 bucket.

        • key — required — (String)

          Key name of the bucket object that contains your unsigned code.

        • version — required — (String)

          Version of your source image in your version enabled S3 bucket.

    • signingMaterial — (map)

      The Amazon Resource Name (ARN) of your code signing certificate.

      • certificateArn — required — (String)

        The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

    • platformId — (String)

      The microcontroller platform to which your signed code image will be distributed.

    • platformDisplayName — (String)

      A human-readable name for the signing platform associated with the signing job.

    • profileName — (String)

      The name of the profile that initiated the signing operation.

    • profileVersion — (String)

      The version of the signing profile used to initiate the signing job.

    • overrides — (map)

      A list of any overrides that were applied to the signing operation.

      • signingConfiguration — (map)

        A signing configuration that overrides the default encryption or hash algorithm of a signing job.

        • encryptionAlgorithm — (String)

          A specified override of the default encryption algorithm that is used in a code-signing job.

          Possible values include:
          • "RSA"
          • "ECDSA"
        • hashAlgorithm — (String)

          A specified override of the default hash algorithm that is used in a code-signing job.

          Possible values include:
          • "SHA1"
          • "SHA256"
      • signingImageFormat — (String)

        A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, JSONEmbedded or JSONDetached. (A third format value, JSON, is reserved for future use.) With JSONEmbedded, the signing image has the payload embedded in it. With JSONDetached, the payload is not be embedded in the signing image.

        Possible values include:
        • "JSON"
        • "JSONEmbedded"
        • "JSONDetached"
    • signingParameters — (map<String>)

      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 — (Date)

      Date and time that the signing job was created.

    • completedAt — (Date)

      Date and time that the signing job was completed.

    • signatureExpiresAt — (Date)

      Thr expiration timestamp for the signature generated by the signing job.

    • requestedBy — (String)

      The IAM principal that requested the signing job.

    • status — (String)

      Status of the signing job.

      Possible values include:
      • "InProgress"
      • "Failed"
      • "Succeeded"
    • statusReason — (String)

      String value that contains the status reason.

    • revocationRecord — (map)

      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.

      • reason — (String)

        A caller-supplied reason for revocation.

      • revokedAt — (Date)

        The time of revocation.

      • revokedBy — (String)

        The identity of the revoker.

    • signedObject — (map)

      Name of the S3 bucket where the signed code image is saved by AWS Signer.

      • s3 — (map)

        The S3SignedObject.

        • bucketName — (String)

          Name of the S3 bucket.

        • key — (String)

          Key name that uniquely identifies a signed code image in your bucket.

    • jobOwner — (String)

      The AWS account ID of the job owner.

    • jobInvoker — (String)

      The IAM entity that initiated the signing job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• successfulSigningJob

var params = {
  certificateHashes: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  jobArn: 'STRING_VALUE', /* required */
  platformId: 'STRING_VALUE', /* required */
  profileVersionArn: 'STRING_VALUE', /* required */
  signatureTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
};
signer.getRevocationStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • signatureTimestamp — (Date)

    The timestamp of the signature that validates the profile or job.

  • platformId — (String)

    The ID of a signing platform.

  • profileVersionArn — (String)

    The version of a signing profile.

  • jobArn — (String)

    The ARN of a signing job.

  • certificateHashes — (Array<String>)

    A list of composite signed hashes that identify certificates.

    A certificate identifier consists of a subject certificate TBS hash (signed by the parent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root certificates are defined as their own CA.

    The following example shows how to calculate a hash for this parameter using OpenSSL commands:

    openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs

    openssl sha384 < childCert.tbs -binary > childCertTbsHash

    openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs

    openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p childCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >> certificateHash.hex

    cat certificateHash.hex | tr -d '\n'

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • revokedEntities — (Array<String>)

      A list of revoked entities (including zero or more of the signing profile ARN, signing job ARN, and certificate hashes) supplied as input to the API.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  platformId: 'STRING_VALUE' /* required */
};
signer.getSigningPlatform(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • platformId — (String)

    The ID of the target signing platform.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • platformId — (String)

      The ID of the target signing platform.

    • displayName — (String)

      The display name of the target signing platform.

    • partner — (String)

      A list of partner entities that use the target signing platform.

    • target — (String)

      The validation template that is used by the target signing platform.

    • category — (String)

      The category type of the target signing platform.

      Possible values include:
      • "AWSIoT"
    • signingConfiguration — (map)

      A list of configurations applied to the target platform at signing.

      • encryptionAlgorithmOptions — required — (map)

        The encryption algorithm options that are available for a code-signing job.

        • allowedValues — required — (Array<String>)

          The set of accepted encryption algorithms that are allowed in a code-signing job.

        • defaultValue — required — (String)

          The default encryption algorithm that is used by a code-signing job.

          Possible values include:
          • "RSA"
          • "ECDSA"
      • hashAlgorithmOptions — required — (map)

        The hash algorithm options that are available for a code-signing job.

        • allowedValues — required — (Array<String>)

          The set of accepted hash algorithms allowed in a code-signing job.

        • defaultValue — required — (String)

          The default hash algorithm that is used in a code-signing job.

          Possible values include:
          • "SHA1"
          • "SHA256"
    • signingImageFormat — (map)

      The format of the target platform's signing image.

      • supportedFormats — required — (Array<String>)

        The supported formats of a signing image.

      • defaultFormat — required — (String)

        The default format of a signing image.

        Possible values include:
        • "JSON"
        • "JSONEmbedded"
        • "JSONDetached"
    • maxSizeInMB — (Integer)

      The maximum size (in MB) of the payload that can be signed by the target platform.

    • revocationSupported — (Boolean)

      A flag indicating whether signatures generated for the signing platform can be revoked.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  profileName: 'STRING_VALUE', /* required */
  profileOwner: 'STRING_VALUE'
};
signer.getSigningProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • profileName — (String)

    The name of the target signing profile.

  • profileOwner — (String)

    The AWS account ID of the profile owner.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • profileName — (String)

      The name of the target signing profile.

    • profileVersion — (String)

      The current version of the signing profile.

    • profileVersionArn — (String)

      The signing profile ARN, including the profile version.

    • revocationRecord — (map)

      Revocation information for a signing profile.

      • revocationEffectiveFrom — (Date)

        The time when revocation becomes effective.

      • revokedAt — (Date)

        The time when the signing profile was revoked.

      • revokedBy — (String)

        The identity of the revoker.

    • signingMaterial — (map)

      The ARN of the certificate that the target profile uses for signing operations.

      • certificateArn — required — (String)

        The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

    • platformId — (String)

      The ID of the platform that is used by the target signing profile.

    • platformDisplayName — (String)

      A human-readable name for the signing platform associated with the signing profile.

    • signatureValidityPeriod — (map)

      The validity period for a signing job.

      • value — (Integer)

        The numerical value of the time unit for signature validity.

      • type — (String)

        The time unit for signature validity.

        Possible values include:
        • "DAYS"
        • "MONTHS"
        • "YEARS"
    • overrides — (map)

      A list of overrides applied by the target signing profile for signing operations.

      • signingConfiguration — (map)

        A signing configuration that overrides the default encryption or hash algorithm of a signing job.

        • encryptionAlgorithm — (String)

          A specified override of the default encryption algorithm that is used in a code-signing job.

          Possible values include:
          • "RSA"
          • "ECDSA"
        • hashAlgorithm — (String)

          A specified override of the default hash algorithm that is used in a code-signing job.

          Possible values include:
          • "SHA1"
          • "SHA256"
      • signingImageFormat — (String)

        A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, JSONEmbedded or