SignerClient

AWS Signer is a fully managed code-signing service to help you ensure the trust and integrity of your code.

Signer supports the following applications:

With code signing for AWS Lambda, you can sign AWS Lambda deployment packages. Integrated support is provided for Amazon S3, Amazon CloudWatch, and AWS CloudTrail. In order to sign code, you create a signing profile and then use Signer to sign Lambda zip files in S3.

With code signing for IoT, you can sign code for any IoT device that is supported by AWS. IoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code-signing certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management.

With Signer and the Notation CLI from the Notary
 Project, you can sign container images stored in a container registry such as Amazon Elastic Container Registry (ECR). The signatures are stored in the registry alongside the images, where they are available for verifying image authenticity and integrity.

For more information about Signer, see the AWS Signer Developer Guide.

Properties

Link copied to clipboard
abstract override val config: SignerClient.Config

SignerClient's configuration

Functions

Link copied to clipboard

Adds cross-account permissions to a signing profile.

Link copied to clipboard

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

Link copied to clipboard

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

Link copied to clipboard

Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.

Link copied to clipboard

Returns information on a specific signing platform.

Link copied to clipboard

Returns information on a specific signing profile.

Link copied to clipboard

Lists the cross-account permissions associated with a signing profile.

Link copied to clipboard
abstract suspend fun listSigningJobs(input: ListSigningJobsRequest = ListSigningJobsRequest { }): ListSigningJobsResponse

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. 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.

Link copied to clipboard
abstract suspend fun listSigningPlatforms(input: ListSigningPlatformsRequest = ListSigningPlatformsRequest { }): ListSigningPlatformsResponse

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, 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.

Link copied to clipboard
abstract suspend fun listSigningProfiles(input: ListSigningProfilesRequest = ListSigningProfilesRequest { }): ListSigningProfilesResponse

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.

Link copied to clipboard

Returns a list of the tags associated with a signing profile resource.

Link copied to clipboard

Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.

Link copied to clipboard

Removes cross-account permissions from a signing profile.

Link copied to clipboard

Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.

Link copied to clipboard

Changes the state of a signing profile to REVOKED. This indicates that signatures generated using the signing profile after an effective start date are no longer valid.

Link copied to clipboard
abstract suspend fun signPayload(input: SignPayloadRequest): SignPayloadResponse

Signs a binary payload and returns a signature envelope.

Link copied to clipboard

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair.

Link copied to clipboard

Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.

Inherited functions

Link copied to clipboard

Adds cross-account permissions to a signing profile.

Link copied to clipboard

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

Link copied to clipboard

Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.

Link copied to clipboard

Returns information on a specific signing platform.

Link copied to clipboard

Returns information on a specific signing profile.

Link copied to clipboard

Lists the cross-account permissions associated with a signing profile.

Link copied to clipboard

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. 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.

Link copied to clipboard

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, 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.

Link copied to clipboard

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.

Link copied to clipboard

Returns a list of the tags associated with a signing profile resource.

Link copied to clipboard

Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.

Link copied to clipboard

Removes cross-account permissions from a signing profile.

Link copied to clipboard

Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.

Link copied to clipboard

Changes the state of a signing profile to REVOKED. This indicates that signatures generated using the signing profile after an effective start date are no longer valid.

Link copied to clipboard
inline suspend fun SignerClient.signPayload(crossinline block: SignPayloadRequest.Builder.() -> Unit): SignPayloadResponse

Signs a binary payload and returns a signature envelope.

Link copied to clipboard

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

Link copied to clipboard
inline suspend fun SignerClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair.

Link copied to clipboard

Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.