Signer

public struct Signer

Client object for interacting with AWS Signer service.

With code signing for IoT, you can sign code that you create for any IoT device that is supported by Amazon Web Services (AWS). Code signing is available through Amazon FreeRTOS and AWS IoT Device Management, and integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code signing certificate with ACM that is used to sign updates in Amazon FreeRTOS and AWS IoT Device Management. For general information about using code signing, see the Code Signing for IoT Developer Guide.

Member variables

Initialization

  • Initialize the Signer client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

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

    Declaration

    Swift

    @discardableResult
public func cancelSigningProfile(_ input: CancelSigningProfileRequest) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func describeSigningJob(_ input: DescribeSigningJobRequest) -> EventLoopFuture<DescribeSigningJobResponse>

  • Returns information on a specific signing platform.

    Declaration

    Swift

    public func getSigningPlatform(_ input: GetSigningPlatformRequest) -> EventLoopFuture<GetSigningPlatformResponse>

  • Returns information on a specific signing profile.

    Declaration

    Swift

    public func getSigningProfile(_ input: GetSigningProfileRequest) -> EventLoopFuture<GetSigningProfileResponse>

  • 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, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.

    Declaration

    Swift

    public func listSigningJobs(_ input: ListSigningJobsRequest) -> EventLoopFuture<ListSigningJobsResponse>

  • Lists all signing platforms available in code signing that match the request parameters. If additional jobs remain to be listed, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.

    Declaration

    Swift

    public func listSigningPlatforms(_ input: ListSigningPlatformsRequest) -> EventLoopFuture<ListSigningPlatformsResponse>

  • 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, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.

    Declaration

    Swift

    public func listSigningProfiles(_ input: ListSigningProfilesRequest) -> EventLoopFuture<ListSigningProfilesResponse>

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

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

  • Creates a signing profile. A signing profile is a code signing template that can be used to carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html

    Declaration

    Swift

    public func putSigningProfile(_ input: PutSigningProfileRequest) -> EventLoopFuture<PutSigningProfileResponse>

  • 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: You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the Amazon S3 Getting Started Guide. Your S3 source bucket must be version enabled. You must create an S3 destination bucket. Code signing uses your S3 destination bucket to write your signed code. You specify the name of the source and destination buckets when calling the StartSigningJob operation. You must also specify a request token that identifies your request to code signing. You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob. For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/

    Declaration

    Swift

    public func startSigningJob(_ input: StartSigningJobRequest) -> EventLoopFuture<StartSigningJobResponse>

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

    Declaration

    Swift

    public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>

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

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

Paginators

  • 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, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.

    Declaration

    Swift

    public func listSigningJobsPaginator(_ input: ListSigningJobsRequest, onPage: @escaping (ListSigningJobsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Lists all signing platforms available in code signing that match the request parameters. If additional jobs remain to be listed, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.

    Declaration

    Swift

    public func listSigningPlatformsPaginator(_ input: ListSigningPlatformsRequest, onPage: @escaping (ListSigningPlatformsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.

    Declaration

    Swift

    public func listSigningProfilesPaginator(_ input: ListSigningProfilesRequest, onPage: @escaping (ListSigningProfilesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum Category : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EncryptionAlgorithm : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum HashAlgorithm : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ImageFormat : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SigningProfileStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SigningStatus : String, CustomStringConvertible, Codable