signing_profiles

Creates, updates, deletes, gets or lists a signing_profiles resource.

Overview

Name	signing_profiles
Type	Resource
Id	aws.signer.signing_profiles

Fields

The following fields are returned by SELECT queries:

get_signing_profile

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the signing profile.
overrides	object	A list of overrides applied by the target signing profile for signing operations.
platform_display_name	string	A human-readable name for the signing platform associated with the signing profile.
platform_id	string	The ID of the platform that is used by the target signing profile.
profile_name	string	The name of the target signing profile. (pattern: <code>^[a-zA-Z0-9_]{2,}</code>)
profile_version	string	The current version of the signing profile. (pattern: <code>^[a-zA-Z0-9]{10}$</code>)
profile_version_arn	string	The signing profile ARN, including the profile version.
revocation_record	object	Revocation information for a signing profile.
signature_validity_period	object	The validity period for a signing job.
signing_material	object	The ARN of the certificate that the target profile uses for signing operations.
signing_parameters	object	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. (Active, Canceled, Revoked)
status_reason	string	Reason for the status of the target signing profile.
tags	object	A list of tags associated with the signing profile.

list_signing_profiles

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the signing profile.
platform_display_name	string	The name of the signing platform.
platform_id	string	The ID of a platform that is available for use by a signing profile.
profile_name	string	The name of the signing profile. (pattern: <code>^[a-zA-Z0-9_]{2,}</code>)
profile_version	string	The version of a signing profile. (pattern: <code>^[a-zA-Z0-9]{10}$</code>)
profile_version_arn	string	The ARN of a signing profile, including the profile version.
signature_validity_period	object	The validity period for a signing job.
signing_material	object	The ACM certificate that is used to sign your code.
signing_parameters	object	The parameters that are available for use by a Signer user.
status	string	The status of a signing profile. (Active, Canceled, Revoked)
tags	object	A list of tags associated with the signing profile.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_signing_profile	select	profile_name, region	profileOwner	Returns information on a specific signing profile.
list_signing_profiles	select	region	includeCanceled, maxResults, nextToken, platformId, statuses	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.
revoke_signing_profile	update	profile_name, region, profileVersion, reason, effectiveTime		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. A revoked profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs. See Data Retention for more information on scheduled deletion of a revoked signing profile.
put_signing_profile	replace	profile_name, region, platformId		Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
profile_name	string	The name of the signing profile to be created.
region	string	AWS region (default: us-east-1)
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.
profileOwner	string	The AWS account ID of the profile owner.
statuses	array	Filters results to return only signing jobs with statuses in the specified list.

SELECT examples

get_signing_profile

Returns information on a specific signing profile.

SELECT
arn,
overrides,
platform_display_name,
platform_id,
profile_name,
profile_version,
profile_version_arn,
revocation_record,
signature_validity_period,
signing_material,
signing_parameters,
status,
status_reason,
tags
FROM aws.signer.signing_profiles
WHERE profile_name = '{{ profile_name }}' -- required
AND region = '{{ region }}' -- required
AND profileOwner = '{{ profileOwner }}'
;

list_signing_profiles

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.

SELECT
arn,
platform_display_name,
platform_id,
profile_name,
profile_version,
profile_version_arn,
signature_validity_period,
signing_material,
signing_parameters,
status,
tags
FROM aws.signer.signing_profiles
WHERE region = '{{ region }}' -- required
AND includeCanceled = '{{ includeCanceled }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND platformId = '{{ platformId }}'
AND statuses = '{{ statuses }}'
;

UPDATE examples

revoke_signing_profile

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. A revoked profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs. See Data Retention for more information on scheduled deletion of a revoked signing profile.

UPDATE aws.signer.signing_profiles
SET 
profileVersion = '{{ profileVersion }}',
reason = '{{ reason }}',
effectiveTime = '{{ effectiveTime }}'
WHERE 
profile_name = '{{ profile_name }}' --required
AND region = '{{ region }}' --required
AND profileVersion = '{{ profileVersion }}' --required
AND reason = '{{ reason }}' --required
AND effectiveTime = '{{ effectiveTime }}' --required;

REPLACE examples

put_signing_profile

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

REPLACE aws.signer.signing_profiles
SET 
signingMaterial = '{{ signingMaterial }}',
signatureValidityPeriod = '{{ signatureValidityPeriod }}',
platformId = '{{ platformId }}',
overrides = '{{ overrides }}',
signingParameters = '{{ signingParameters }}',
tags = '{{ tags }}'
WHERE 
profile_name = '{{ profile_name }}' --required
AND region = '{{ region }}' --required
AND platformId = '{{ platformId }}' --required
RETURNING
arn,
profile_version,
profile_version_arn;