signer/aws.sdk.kotlin.services.signer

Package-level declarations

Types

SignerClient

interface SignerClient : SdkClient

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

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

addProfilePermission

inline suspend fun SignerClient.addProfilePermission(crossinline block: AddProfilePermissionRequest.Builder.() -> Unit): AddProfilePermissionResponse

Adds cross-account permissions to a signing profile.

cancelSigningProfile

inline suspend fun SignerClient.cancelSigningProfile(crossinline block: CancelSigningProfileRequest.Builder.() -> Unit): CancelSigningProfileResponse

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.

describeSigningJob

inline suspend fun SignerClient.describeSigningJob(crossinline block: DescribeSigningJobRequest.Builder.() -> Unit): DescribeSigningJobResponse

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

getRevocationStatus

inline suspend fun SignerClient.getRevocationStatus(crossinline block: GetRevocationStatusRequest.Builder.() -> Unit): GetRevocationStatusResponse

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

getSigningPlatform

inline suspend fun SignerClient.getSigningPlatform(crossinline block: GetSigningPlatformRequest.Builder.() -> Unit): GetSigningPlatformResponse

Returns information on a specific signing platform.

getSigningProfile

inline suspend fun SignerClient.getSigningProfile(crossinline block: GetSigningProfileRequest.Builder.() -> Unit): GetSigningProfileResponse

Returns information on a specific signing profile.

listProfilePermissions

inline suspend fun SignerClient.listProfilePermissions(crossinline block: ListProfilePermissionsRequest.Builder.() -> Unit): ListProfilePermissionsResponse

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

listSigningJobs

inline suspend fun SignerClient.listSigningJobs(crossinline block: ListSigningJobsRequest.Builder.() -> Unit): 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.

listSigningPlatforms

inline suspend fun SignerClient.listSigningPlatforms(crossinline block: ListSigningPlatformsRequest.Builder.() -> Unit): 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.

listSigningProfiles

inline suspend fun SignerClient.listSigningProfiles(crossinline block: ListSigningProfilesRequest.Builder.() -> Unit): 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.

listTagsForResource

inline suspend fun SignerClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

putSigningProfile

inline suspend fun SignerClient.putSigningProfile(crossinline block: PutSigningProfileRequest.Builder.() -> Unit): PutSigningProfileResponse

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

removeProfilePermission

inline suspend fun SignerClient.removeProfilePermission(crossinline block: RemoveProfilePermissionRequest.Builder.() -> Unit): RemoveProfilePermissionResponse

Removes cross-account permissions from a signing profile.

revokeSignature

inline suspend fun SignerClient.revokeSignature(crossinline block: RevokeSignatureRequest.Builder.() -> Unit): RevokeSignatureResponse

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

revokeSigningProfile

inline suspend fun SignerClient.revokeSigningProfile(crossinline block: RevokeSigningProfileRequest.Builder.() -> Unit): RevokeSigningProfileResponse

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.

signPayload

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

Signs a binary payload and returns a signature envelope.

startSigningJob

inline suspend fun SignerClient.startSigningJob(crossinline block: StartSigningJobRequest.Builder.() -> Unit): StartSigningJobResponse

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:

tagResource

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.

untagResource

inline suspend fun SignerClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

withConfig

fun SignerClient.withConfig(block: SignerClient.Config.Builder.() -> Unit): SignerClient

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.