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 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>)

      A map of key-value pairs for signing operations that is attached to the target signing profile.

    • status — (String)

      The status of the target signing profile.

      Possible values include:
      • "Active"
      • "Canceled"
      • "Revoked"
    • statusReason — (String)

      Reason for the status of the target signing profile.

    • arn — (String)

      The Amazon Resource Name (ARN) for the signing profile.

    • tags — (map<String>)

      A list of tags associated with the signing profile.

Returns:

• (AWS.Request) —

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

var params = {
  profileName: 'STRING_VALUE', /* required */
  nextToken: 'STRING_VALUE'
};
signer.listProfilePermissions(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)

    Name of the signing profile containing the cross-account permissions.

  • nextToken — (String)

    String for specifying the next set of paginated results.

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:

    • revisionId — (String)

      The identifier for the current revision of profile permissions.

    • policySizeBytes — (Integer)

      Total size of the policy associated with the Signing Profile in bytes.

    • permissions — (Array<map>)

      List of permissions associated with the Signing Profile.

      • action — (String)

        An AWS Signer action permitted as part of cross-account permissions.

      • principal — (String)

        The AWS principal that has been granted a cross-account permission.

      • statementId — (String)

        A unique identifier for a cross-account permission statement.

      • profileVersion — (String)

        The signing profile version that a permission applies to.

    • nextToken — (String)

      String for specifying the next set of paginated results.

Returns:

• (AWS.Request) —

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

var params = {
  isRevoked: true || false,
  jobInvoker: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  platformId: 'STRING_VALUE',
  requestedBy: 'STRING_VALUE',
  signatureExpiresAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  signatureExpiresBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  status: InProgress | Failed | Succeeded
};
signer.listSigningJobs(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: {}) —
  • status — (String)

    A status value with which to filter your results.

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

    The ID of microcontroller platform that you specified for the distribution of your code image.

  • requestedBy — (String)

    The IAM principal that requested the signing job.

  • maxResults — (Integer)

    Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items.

  • nextToken — (String)

    String 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.

  • isRevoked — (Boolean)

    Filters results to return only signing jobs with revoked signatures.

  • signatureExpiresBefore — (Date)

    Filters results to return only signing jobs with signatures expiring before a specified timestamp.

  • signatureExpiresAfter — (Date)

    Filters results to return only signing jobs with signatures expiring after a specified timestamp.

  • jobInvoker — (String)

    Filters results to return only signing jobs initiated by a specified IAM entity.

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:

    • jobs — (Array<map>)

      A list of your signing jobs.

      • jobId — (String)

        The ID of the signing job.

      • source — (map)

        A Source that contains information about a signing job's code image source.

        • 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.

      • signedObject — (map)

        A SignedObject structure that contains information about a signing job's signed code image.

        • 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.

      • signingMaterial — (map)

        A SigningMaterial object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job.

        • certificateArn — required — (String)

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

      • createdAt — (Date)

        The date and time that the signing job was created.

      • status — (String)

        The status of the signing job.

        Possible values include:
        • "InProgress"
        • "Failed"
        • "Succeeded"
      • isRevoked — (Boolean)

        Indicates whether the signing job is revoked.

      • profileName — (String)

        The name of the signing profile that created a signing job.

      • profileVersion — (String)

        The version of the signing profile that created a signing job.

      • platformId — (String)

        The unique identifier for a signing platform.

      • platformDisplayName — (String)

        The name of a signing platform.

      • signatureExpiresAt — (Date)

        The time when the signature of a signing job expires.

      • jobOwner — (String)

        The AWS account ID of the job owner.

      • jobInvoker — (String)

        The AWS account ID of the job invoker.

    • nextToken — (String)

      String for specifying the next set of paginated results.

Returns:

• (AWS.Request) —

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

var params = {
  category: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  partner: 'STRING_VALUE',
  target: 'STRING_VALUE'
};
signer.listSigningPlatforms(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: {}) —
  • category — (String)

    The category type of a signing platform.

  • partner — (String)

    Any partner entities connected to a signing platform.

  • target — (String)

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

  • maxResults — (Integer)

    The maximum number of results to be returned by this operation.

  • nextToken — (String)

    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.

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:

    • platforms — (Array<map>)

      A list of all platforms that match the request parameters.

      • platformId — (String)

        The ID of a signing platform.

      • displayName — (String)

        The display name of a signing platform.

      • partner — (String)

        Any partner entities linked to a signing platform.

      • target — (String)

        The types of targets that can be signed by a signing platform.

      • category — (String)

        The category of a signing platform.

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

        The configuration of a signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.

        • 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 image format of a AWS Signer platform or profile.

        • 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 code that can be signed by a signing platform.

      • revocationSupported — (Boolean)

        Indicates whether revocation is supported for the platform.

    • nextToken — (String)

      Value for specifying the next set of paginated results to return.

Returns:

• (AWS.Request) —

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

var params = {
  includeCanceled: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  platformId: 'STRING_VALUE',
  statuses: [
    Active | Canceled | Revoked,
    /* more items */
  ]
};
signer.listSigningProfiles(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: {}) —
  • includeCanceled — (Boolean)

    Designates whether to include profiles with the status of CANCELED.

  • maxResults — (Integer)

    The maximum number of profiles to be returned.

  • nextToken — (String)

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

    Filters results to return only signing jobs initiated for a specified signing platform.

  • statuses — (Array<String>)

    Filters results to return only signing jobs with statuses in the specified list.

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:

    • profiles — (Array<map>)

      A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true.

      • profileName — (String)

        The name of the signing profile.

      • profileVersion — (String)

        The version of a signing profile.

      • profileVersionArn — (String)

        The ARN of a signing profile, including the profile version.

      • signingMaterial — (map)

        The ACM certificate that is available for use by a signing profile.

        • certificateArn — required — (String)

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

      • signatureValidityPeriod — (map)

        The validity period for a signing job created using this signing profile.

        • 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"
      • platformId — (String)

        The ID of a platform that is available for use by a signing profile.

      • platformDisplayName — (String)

        The name of the signing platform.

      • signingParameters — (map<String>)

        The parameters that are available for use by a Signer user.

      • status — (String)

        The status of a signing profile.

        Possible values include:
        • "Active"
        • "Canceled"
        • "Revoked"
      • arn — (String)

        The Amazon Resource Name (ARN) for the signing profile.

      • tags — (map<String>)

        A list of tags associated with the signing profile.

    • nextToken — (String)

      Value for specifying the next set of paginated results to return.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
signer.listTagsForResource(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: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) for the signing profile.

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:

    • tags — (map<String>)

      A list of tags associated with the signing profile.

Returns:

• (AWS.Request) —

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

var params = {
  platformId: 'STRING_VALUE', /* required */
  profileName: 'STRING_VALUE', /* required */
  overrides: {
    signingConfiguration: {
      encryptionAlgorithm: RSA | ECDSA,
      hashAlgorithm: SHA1 | SHA256
    },
    signingImageFormat: JSON | JSONEmbedded | JSONDetached
  },
  signatureValidityPeriod: {
    type: DAYS | MONTHS | YEARS,
    value: 'NUMBER_VALUE'
  },
  signingMaterial: {
    certificateArn: 'STRING_VALUE' /* required */
  },
  signingParameters: {
    '<SigningParameterKey>': 'STRING_VALUE',
    /* '<SigningParameterKey>': ... */
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
signer.putSigningProfile(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 created.

  • signingMaterial — (map)

    The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.

    • certificateArn — required — (String)

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

  • signatureValidityPeriod — (map)

    The default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.

    • 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"
  • platformId — (String)

    The ID of the signing platform to be created.

  • overrides — (map)

    A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm).

    • 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 key-value pairs for signing. These can include any information that you want to use during signing.

  • tags — (map<String>)

    Tags to be associated with the signing profile that is being created.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the signing profile created.

    • profileVersion — (String)

      The version of the signing profile being created.

    • profileVersionArn — (String)

      The signing profile ARN, including the profile version.

Returns:

• (AWS.Request) —

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

var params = {
  profileName: 'STRING_VALUE', /* required */
  revisionId: 'STRING_VALUE', /* required */
  statementId: 'STRING_VALUE' /* required */
};
signer.removeProfilePermission(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)

    A human-readable name for the signing profile with permissions to be removed.

  • revisionId — (String)

    An identifier for the current revision of the signing profile permissions.

  • statementId — (String)

    A unique identifier for the cross-account permissions statement.

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:

    • revisionId — (String)

      An identifier for the current revision of the profile permissions.

Returns:

• (AWS.Request) —

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

var params = {
  jobId: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE', /* required */
  jobOwner: 'STRING_VALUE'
};
signer.revokeSignature(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)

    ID of the signing job to be revoked.

  • jobOwner — (String)

    AWS account ID of the job owner.

  • reason — (String)

    The reason for revoking the signing job.

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 = {
  effectiveTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  profileName: 'STRING_VALUE', /* required */
  profileVersion: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE' /* required */
};
signer.revokeSigningProfile(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 revoked.

  • profileVersion — (String)

    The version of the signing profile to be revoked.

  • reason — (String)

    The reason for revoking a signing profile.

  • effectiveTime — (Date)

    A timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.

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 = {
  payload: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  payloadFormat: 'STRING_VALUE', /* required */
  profileName: 'STRING_VALUE', /* required */
  profileOwner: 'STRING_VALUE'
};
signer.signPayload(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.

  • profileOwner — (String)

    The AWS account ID of the profile owner.

  • payload — (Buffer, Typed Array, Blob, String)

    Specifies the object digest (hash) to sign.

  • payloadFormat — (String)

    Payload content type. The single valid type is application/vnd.cncf.notary.payload.v1+json.

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)

      Unique identifier of the signing job.

    • jobOwner — (String)

      The AWS account ID of the job owner.

    • metadata — (map<String>)

      Information including the signing profile ARN and the signing job ID.

    • signature — (Buffer(Node.js), Typed Array(Browser))

      A cryptographic signature.

Returns:

• (AWS.Request) —

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

var params = {
  clientRequestToken: 'STRING_VALUE', /* required */
  destination: { /* required */
    s3: {
      bucketName: 'STRING_VALUE',
      prefix: 'STRING_VALUE'
    }
  },
  profileName: 'STRING_VALUE', /* required */
  source: { /* required */
    s3: {
      bucketName: 'STRING_VALUE', /* required */
      key: 'STRING_VALUE', /* required */
      version: 'STRING_VALUE' /* required */
    }
  },
  profileOwner: 'STRING_VALUE'
};
signer.startSigningJob(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: {}) —
  • source — (map)

    The S3 bucket that contains the object to sign or a BLOB that contains 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.

  • destination — (map)

    The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.

    • s3 — (map)

      The S3Destination object.

      • bucketName — (String)

        Name of the S3 bucket.

      • prefix — (String)

        An S3 prefix that you can use to limit responses to those that begin with the specified prefix.

  • profileName — (String)

    The name of the signing profile.

  • clientRequestToken — (String)

    String that identifies the signing request. All calls after the first that use this token return the same response as the first call.

    If a token is not provided, the SDK will use a version 4 UUID.
  • profileOwner — (String)

    The AWS account ID of the signing 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:

    • jobId — (String)

      The ID of your signing job.

    • jobOwner — (String)

      The AWS account ID of the signing job owner.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
signer.tagResource(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: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) for the signing profile.

  • tags — (map<String>)

    One or more tags to be associated with the signing profile.

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 = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
signer.untagResource(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: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) for the signing profile.

  • tagKeys — (Array<String>)

    A list of tag keys to be removed from the signing profile.

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.waitFor('successfulSigningJob', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• successfulSigningJob