AWS.Signer (aws-elixir v0.8.0) View Source

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

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

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

Link to this section Summary

Functions

Adds cross-account permissions to a signing profile.

Changes the state of an ACTIVE signing profile to CANCELED.

Returns information about a specific code signing job.

Returns information on a specific signing platform.

Returns information on a specific signing profile.

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

Lists all signing platforms available in code signing that match the request parameters.

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

Removes cross-account permissions from a signing profile.

Changes the state of a signing job to REVOKED.

Changes the state of a signing profile to REVOKED.

Initiates a signing job to be performed on the code provided.

Adds one or more tags to a signing profile.

Removes one or more tags from a signing profile.

Link to this section Functions

Link to this function

add_profile_permission(client, profile_name, input, options \\ [])

View Source

Adds cross-account permissions to a signing profile.

Link to this function

cancel_signing_profile(client, profile_name, input, options \\ [])

View Source

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 to this function

describe_signing_job(client, job_id, options \\ [])

View Source

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 to this function

get_signing_platform(client, platform_id, options \\ [])

View Source

Returns information on a specific signing platform.

Link to this function

get_signing_profile(client, profile_name, profile_owner \\ nil, options \\ [])

View Source

Returns information on a specific signing profile.

Link to this function

list_profile_permissions(client, profile_name, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_signing_jobs(client, is_revoked \\ nil, job_invoker \\ nil, max_results \\ nil, next_token \\ nil, platform_id \\ nil, requested_by \\ nil, signature_expires_after \\ nil, signature_expires_before \\ nil, status \\ nil, options \\ [])

View Source

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.

Link to this function

list_signing_platforms(client, category \\ nil, max_results \\ nil, next_token \\ nil, partner \\ nil, target \\ nil, options \\ [])

View Source

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.

Link to this function

list_signing_profiles(client, include_canceled \\ nil, max_results \\ nil, next_token \\ nil, platform_id \\ nil, statuses \\ nil, options \\ [])

View Source

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.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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

Link to this function

put_signing_profile(client, profile_name, input, options \\ [])

View Source

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

Link to this function

remove_profile_permission(client, profile_name, statement_id, input, options \\ [])

View Source

Removes cross-account permissions from a signing profile.

Link to this function

revoke_signature(client, job_id, input, options \\ [])

View Source

Changes the state of a signing job to REVOKED.

This indicates that the signature is no longer valid.

Link to this function

revoke_signing_profile(client, profile_name, input, options \\ [])

View Source

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 to this function

start_signing_job(client, input, options \\ [])

View Source

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/

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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 to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes one or more tags from a signing profile.

To remove the tags, specify a list of tag keys.