Table of Contents
signer.Client¶A low-level client representing AWS Signer
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.
import boto3
client = boto3.client('signer')
These are the available methods:
add_profile_permission()can_paginate()cancel_signing_profile()close()describe_signing_job()get_paginator()get_signing_platform()get_signing_profile()get_waiter()list_profile_permissions()list_signing_jobs()list_signing_platforms()list_signing_profiles()list_tags_for_resource()put_signing_profile()remove_profile_permission()revoke_signature()revoke_signing_profile()start_signing_job()tag_resource()untag_resource()add_profile_permission(**kwargs)¶Adds cross-account permissions to a signing profile.
See also: AWS API Documentation
Request Syntax
response = client.add_profile_permission(
profileName='string',
profileVersion='string',
action='string',
principal='string',
revisionId='string',
statementId='string'
)
[REQUIRED]
The human-readable name of the signing profile.
[REQUIRED]
The AWS Signer action permitted as part of cross-account permissions.
[REQUIRED]
The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.
[REQUIRED]
A unique identifier for the cross-account permission statement.
dict
Response Syntax
{
'revisionId': 'string'
}
Response Structure
(dict) --
revisionId (string) --
A unique identifier for the current profile revision.
Exceptions
signer.Client.exceptions.ValidationExceptionsigner.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.ServiceLimitExceededExceptionsigner.Client.exceptions.ConflictExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_signing_profile(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.cancel_signing_profile(
profileName='string'
)
[REQUIRED]
The name of the signing profile to be canceled.
Exceptions
signer.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionclose()¶Closes underlying endpoint connections.
describe_signing_job(**kwargs)¶Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_signing_job(
jobId='string'
)
[REQUIRED]
The ID of the signing job on input.
{
'jobId': 'string',
'source': {
's3': {
'bucketName': 'string',
'key': 'string',
'version': 'string'
}
},
'signingMaterial': {
'certificateArn': 'string'
},
'platformId': 'string',
'platformDisplayName': 'string',
'profileName': 'string',
'profileVersion': 'string',
'overrides': {
'signingConfiguration': {
'encryptionAlgorithm': 'RSA'|'ECDSA',
'hashAlgorithm': 'SHA1'|'SHA256'
},
'signingImageFormat': 'JSON'|'JSONEmbedded'|'JSONDetached'
},
'signingParameters': {
'string': 'string'
},
'createdAt': datetime(2015, 1, 1),
'completedAt': datetime(2015, 1, 1),
'signatureExpiresAt': datetime(2015, 1, 1),
'requestedBy': 'string',
'status': 'InProgress'|'Failed'|'Succeeded',
'statusReason': 'string',
'revocationRecord': {
'reason': 'string',
'revokedAt': datetime(2015, 1, 1),
'revokedBy': 'string'
},
'signedObject': {
's3': {
'bucketName': 'string',
'key': 'string'
}
},
'jobOwner': 'string',
'jobInvoker': 'string'
}
Response Structure
The ID of the signing job on output.
The object that contains the name of your S3 bucket or your raw code.
The S3Source object.
Name of the S3 bucket.
Key name of the bucket object that contains your unsigned code.
Version of your source image in your version enabled S3 bucket.
The Amazon Resource Name (ARN) of your code signing certificate.
The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
The microcontroller platform to which your signed code image will be distributed.
A human-readable name for the signing platform associated with the signing job.
The name of the profile that initiated the signing operation.
The version of the signing profile used to initiate the signing job.
A list of any overrides that were applied to the signing operation.
A signing configuration that overrides the default encryption or hash algorithm of a signing job.
A specified override of the default encryption algorithm that is used in a code signing job.
A specified override of the default hash algorithm that is used in a code signing job.
A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, JSONEmbedded or JSONDetached . (A third format value, JSON , is reserved for future use.) With JSONEmbedded , the signing image has the payload embedded in it. With JSONDetached , the payload is not be embedded in the signing image.
Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job.
Date and time that the signing job was created.
Date and time that the signing job was completed.
Thr expiration timestamp for the signature generated by the signing job.
The IAM principal that requested the signing job.
Status of the signing job.
String value that contains the status reason.
A revocation record if the signature generated by the signing job has been revoked. Contains a timestamp and the ID of the IAM entity that revoked the signature.
A caller-supplied reason for revocation.
The time of revocation.
The identity of the revoker.
Name of the S3 bucket where the signed code image is saved by code signing.
The S3SignedObject .
Name of the S3 bucket.
Key name that uniquely identifies a signed code image in your bucket.
The AWS account ID of the job owner.
The IAM entity that initiated the signing job.
Exceptions
signer.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_signing_platform(**kwargs)¶Returns information on a specific signing platform.
See also: AWS API Documentation
Request Syntax
response = client.get_signing_platform(
platformId='string'
)
[REQUIRED]
The ID of the target signing platform.
{
'platformId': 'string',
'displayName': 'string',
'partner': 'string',
'target': 'string',
'category': 'AWSIoT',
'signingConfiguration': {
'encryptionAlgorithmOptions': {
'allowedValues': [
'RSA'|'ECDSA',
],
'defaultValue': 'RSA'|'ECDSA'
},
'hashAlgorithmOptions': {
'allowedValues': [
'SHA1'|'SHA256',
],
'defaultValue': 'SHA1'|'SHA256'
}
},
'signingImageFormat': {
'supportedFormats': [
'JSON'|'JSONEmbedded'|'JSONDetached',
],
'defaultFormat': 'JSON'|'JSONEmbedded'|'JSONDetached'
},
'maxSizeInMB': 123,
'revocationSupported': True|False
}
Response Structure
The ID of the target signing platform.
The display name of the target signing platform.
A list of partner entities that use the target signing platform.
The validation template that is used by the target signing platform.
The category type of the target signing platform.
A list of configurations applied to the target platform at signing.
The encryption algorithm options that are available for a code signing job.
The set of accepted encryption algorithms that are allowed in a code signing job.
The default encryption algorithm that is used by a code signing job.
The hash algorithm options that are available for a code signing job.
The set of accepted hash algorithms allowed in a code signing job.
The default hash algorithm that is used in a code signing job.
The format of the target platform's signing image.
The supported formats of a code signing image.
The default format of a code signing image.
The maximum size (in MB) of the payload that can be signed by the target platform.
A flag indicating whether signatures generated for the signing platform can be revoked.
Exceptions
signer.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionget_signing_profile(**kwargs)¶Returns information on a specific signing profile.
See also: AWS API Documentation
Request Syntax
response = client.get_signing_profile(
profileName='string',
profileOwner='string'
)
[REQUIRED]
The name of the target signing profile.
dict
Response Syntax
{
'profileName': 'string',
'profileVersion': 'string',
'profileVersionArn': 'string',
'revocationRecord': {
'revocationEffectiveFrom': datetime(2015, 1, 1),
'revokedAt': datetime(2015, 1, 1),
'revokedBy': 'string'
},
'signingMaterial': {
'certificateArn': 'string'
},
'platformId': 'string',
'platformDisplayName': 'string',
'signatureValidityPeriod': {
'value': 123,
'type': 'DAYS'|'MONTHS'|'YEARS'
},
'overrides': {
'signingConfiguration': {
'encryptionAlgorithm': 'RSA'|'ECDSA',
'hashAlgorithm': 'SHA1'|'SHA256'
},
'signingImageFormat': 'JSON'|'JSONEmbedded'|'JSONDetached'
},
'signingParameters': {
'string': 'string'
},
'status': 'Active'|'Canceled'|'Revoked',
'statusReason': 'string',
'arn': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
profileName (string) --
The name of the target signing profile.
profileVersion (string) --
The current version of the signing profile.
profileVersionArn (string) --
The signing profile ARN, including the profile version.
revocationRecord (dict) --
Revocation information for a signing profile.
revocationEffectiveFrom (datetime) --
The time when revocation becomes effective.
revokedAt (datetime) --
The time when the signing profile was revoked.
revokedBy (string) --
The identity of the revoker.
signingMaterial (dict) --
The ARN of the certificate that the target profile uses for signing operations.
certificateArn (string) --
The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
platformId (string) --
The ID of the platform that is used by the target signing profile.
platformDisplayName (string) --
A human-readable name for the signing platform associated with the signing profile.
signatureValidityPeriod (dict) --
The validity period for a signing job.
value (integer) --
The numerical value of the time unit for signature validity.
type (string) --
The time unit for signature validity.
overrides (dict) --
A list of overrides applied by the target signing profile for signing operations.
signingConfiguration (dict) --
A signing configuration that overrides the default encryption or hash algorithm of a signing job.
encryptionAlgorithm (string) --
A specified override of the default encryption algorithm that is used in a code signing job.
hashAlgorithm (string) --
A specified override of the default hash algorithm that is used in a code signing job.
signingImageFormat (string) --
A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, JSONEmbedded or JSONDetached . (A third format value, JSON , is reserved for future use.) With JSONEmbedded , the signing image has the payload embedded in it. With JSONDetached , the payload is not be embedded in the signing image.
signingParameters (dict) --
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.
statusReason (string) --
Reason for the status of the target signing profile.
arn (string) --
The Amazon Resource Name (ARN) for the signing profile.
tags (dict) --
A list of tags associated with the signing profile.
Exceptions
signer.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_profile_permissions(**kwargs)¶Lists the cross-account permissions associated with a signing profile.
See also: AWS API Documentation
Request Syntax
response = client.list_profile_permissions(
profileName='string',
nextToken='string'
)
[REQUIRED]
Name of the signing profile containing the cross-account permissions.
dict
Response Syntax
{
'revisionId': 'string',
'policySizeBytes': 123,
'permissions': [
{
'action': 'string',
'principal': 'string',
'statementId': 'string',
'profileVersion': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
revisionId (string) --
The identifier for the current revision of profile permissions.
policySizeBytes (integer) --
Total size of the policy associated with the Signing Profile in bytes.
permissions (list) --
List of permissions associated with the Signing Profile.
(dict) --
A cross-account permission for a signing profile.
action (string) --
An AWS Signer action permitted as part of cross-account permissions.
principal (string) --
The AWS principal that has been granted a cross-account permission.
statementId (string) --
A unique identifier for a cross-account permission statement.
profileVersion (string) --
The signing profile version that a permission applies to.
nextToken (string) --
String for specifying the next set of paginated results.
Exceptions
signer.Client.exceptions.ValidationExceptionsigner.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionlist_signing_jobs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_signing_jobs(
status='InProgress'|'Failed'|'Succeeded',
platformId='string',
requestedBy='string',
maxResults=123,
nextToken='string',
isRevoked=True|False,
signatureExpiresBefore=datetime(2015, 1, 1),
signatureExpiresAfter=datetime(2015, 1, 1),
jobInvoker='string'
)
nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items.nextToken from the response that you just received.dict
Response Syntax
{
'jobs': [
{
'jobId': 'string',
'source': {
's3': {
'bucketName': 'string',
'key': 'string',
'version': 'string'
}
},
'signedObject': {
's3': {
'bucketName': 'string',
'key': 'string'
}
},
'signingMaterial': {
'certificateArn': 'string'
},
'createdAt': datetime(2015, 1, 1),
'status': 'InProgress'|'Failed'|'Succeeded',
'isRevoked': True|False,
'profileName': 'string',
'profileVersion': 'string',
'platformId': 'string',
'platformDisplayName': 'string',
'signatureExpiresAt': datetime(2015, 1, 1),
'jobOwner': 'string',
'jobInvoker': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobs (list) --
A list of your signing jobs.
(dict) --
Contains information about a signing job.
jobId (string) --
The ID of the signing job.
source (dict) --
A Source that contains information about a signing job's code image source.
s3 (dict) --
The S3Source object.
bucketName (string) --
Name of the S3 bucket.
key (string) --
Key name of the bucket object that contains your unsigned code.
version (string) --
Version of your source image in your version enabled S3 bucket.
signedObject (dict) --
A SignedObject structure that contains information about a signing job's signed code image.
s3 (dict) --
The S3SignedObject .
bucketName (string) --
Name of the S3 bucket.
key (string) --
Key name that uniquely identifies a signed code image in your bucket.
signingMaterial (dict) --
A SigningMaterial object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job.
certificateArn (string) --
The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
createdAt (datetime) --
The date and time that the signing job was created.
status (string) --
The status of the signing job.
isRevoked (boolean) --
Indicates whether the signing job is revoked.
profileName (string) --
The name of the signing profile that created a signing job.
profileVersion (string) --
The version of the signing profile that created a signing job.
platformId (string) --
The unique identifier for a signing platform.
platformDisplayName (string) --
The name of a signing platform.
signatureExpiresAt (datetime) --
The time when the signature of a signing job expires.
jobOwner (string) --
The AWS account ID of the job owner.
jobInvoker (string) --
The AWS account ID of the job invoker.
nextToken (string) --
String for specifying the next set of paginated results.
Exceptions
signer.Client.exceptions.ValidationExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionlist_signing_platforms(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_signing_platforms(
category='string',
partner='string',
target='string',
maxResults=123,
nextToken='string'
)
nextToken from the response that you just received.dict
Response Syntax
{
'platforms': [
{
'platformId': 'string',
'displayName': 'string',
'partner': 'string',
'target': 'string',
'category': 'AWSIoT',
'signingConfiguration': {
'encryptionAlgorithmOptions': {
'allowedValues': [
'RSA'|'ECDSA',
],
'defaultValue': 'RSA'|'ECDSA'
},
'hashAlgorithmOptions': {
'allowedValues': [
'SHA1'|'SHA256',
],
'defaultValue': 'SHA1'|'SHA256'
}
},
'signingImageFormat': {
'supportedFormats': [
'JSON'|'JSONEmbedded'|'JSONDetached',
],
'defaultFormat': 'JSON'|'JSONEmbedded'|'JSONDetached'
},
'maxSizeInMB': 123,
'revocationSupported': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
platforms (list) --
A list of all platforms that match the request parameters.
(dict) --
Contains information about the signing configurations and parameters that are used to perform a code signing job.
platformId (string) --
The ID of a code signing; platform.
displayName (string) --
The display name of a code signing platform.
partner (string) --
Any partner entities linked to a code signing platform.
target (string) --
The types of targets that can be signed by a code signing platform.
category (string) --
The category of a code signing platform.
signingConfiguration (dict) --
The configuration of a code signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.
encryptionAlgorithmOptions (dict) --
The encryption algorithm options that are available for a code signing job.
allowedValues (list) --
The set of accepted encryption algorithms that are allowed in a code signing job.
defaultValue (string) --
The default encryption algorithm that is used by a code signing job.
hashAlgorithmOptions (dict) --
The hash algorithm options that are available for a code signing job.
allowedValues (list) --
The set of accepted hash algorithms allowed in a code signing job.
defaultValue (string) --
The default hash algorithm that is used in a code signing job.
signingImageFormat (dict) --
The image format of a code signing platform or profile.
supportedFormats (list) --
The supported formats of a code signing image.
defaultFormat (string) --
The default format of a code signing image.
maxSizeInMB (integer) --
The maximum size (in MB) of code that can be signed by a code signing platform.
revocationSupported (boolean) --
Indicates whether revocation is supported for the platform.
nextToken (string) --
Value for specifying the next set of paginated results to return.
Exceptions
signer.Client.exceptions.ValidationExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionlist_signing_profiles(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_signing_profiles(
includeCanceled=True|False,
maxResults=123,
nextToken='string',
platformId='string',
statuses=[
'Active'|'Canceled'|'Revoked',
]
)
CANCELED .nextToken from the response that you just received.Filters results to return only signing jobs with statuses in the specified list.
dict
Response Syntax
{
'profiles': [
{
'profileName': 'string',
'profileVersion': 'string',
'profileVersionArn': 'string',
'signingMaterial': {
'certificateArn': 'string'
},
'signatureValidityPeriod': {
'value': 123,
'type': 'DAYS'|'MONTHS'|'YEARS'
},
'platformId': 'string',
'platformDisplayName': 'string',
'signingParameters': {
'string': 'string'
},
'status': 'Active'|'Canceled'|'Revoked',
'arn': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
profiles (list) --
A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true .
(dict) --
Contains information about the ACM certificates and code signing configuration parameters that can be used by a given code signing user.
profileName (string) --
The name of the signing profile.
profileVersion (string) --
The version of a signing profile.
profileVersionArn (string) --
The ARN of a signing profile, including the profile version.
signingMaterial (dict) --
The ACM certificate that is available for use by a signing profile.
certificateArn (string) --
The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
signatureValidityPeriod (dict) --
The validity period for a signing job created using this signing profile.
value (integer) --
The numerical value of the time unit for signature validity.
type (string) --
The time unit for signature validity.
platformId (string) --
The ID of a platform that is available for use by a signing profile.
platformDisplayName (string) --
The name of the signing platform.
signingParameters (dict) --
The parameters that are available for use by a code signing user.
status (string) --
The status of a code signing profile.
arn (string) --
The Amazon Resource Name (ARN) for the signing profile.
tags (dict) --
A list of tags associated with the signing profile.
nextToken (string) --
Value for specifying the next set of paginated results to return.
Exceptions
signer.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionReturns a list of the tags associated with a signing profile resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) for the signing profile.
{
'tags': {
'string': 'string'
}
}
Response Structure
A list of tags associated with the signing profile.
Exceptions
signer.Client.exceptions.InternalServiceErrorExceptionsigner.Client.exceptions.BadRequestExceptionsigner.Client.exceptions.NotFoundExceptionsigner.Client.exceptions.TooManyRequestsExceptionput_signing_profile(**kwargs)¶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
See also: AWS API Documentation
Request Syntax
response = client.put_signing_profile(
profileName='string',
signingMaterial={
'certificateArn': 'string'
},
signatureValidityPeriod={
'value': 123,
'type': 'DAYS'|'MONTHS'|'YEARS'
},
platformId='string',
overrides={
'signingConfiguration': {
'encryptionAlgorithm': 'RSA'|'ECDSA',
'hashAlgorithm': 'SHA1'|'SHA256'
},
'signingImageFormat': 'JSON'|'JSONEmbedded'|'JSONDetached'
},
signingParameters={
'string': 'string'
},
tags={
'string': 'string'
}
)
[REQUIRED]
The name of the signing profile to be created.
The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.
The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
The default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.
The numerical value of the time unit for signature validity.
The time unit for signature validity.
[REQUIRED]
The ID of the signing platform to be created.
A subfield of platform . This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm ).
A signing configuration that overrides the default encryption or hash algorithm of a signing job.
A specified override of the default encryption algorithm that is used in a code signing job.
A specified override of the default hash algorithm that is used in a code signing job.
A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, JSONEmbedded or JSONDetached . (A third format value, JSON , is reserved for future use.) With JSONEmbedded , the signing image has the payload embedded in it. With JSONDetached , the payload is not be embedded in the signing image.
Map of key-value pairs for signing. These can include any information that you want to use during signing.
Tags to be associated with the signing profile that is being created.
dict
Response Syntax
{
'arn': 'string',
'profileVersion': 'string',
'profileVersionArn': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the signing profile created.
profileVersion (string) --
The version of the signing profile being created.
profileVersionArn (string) --
The signing profile ARN, including the profile version.
Exceptions
signer.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.ValidationExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionremove_profile_permission(**kwargs)¶Removes cross-account permissions from a signing profile.
See also: AWS API Documentation
Request Syntax
response = client.remove_profile_permission(
profileName='string',
revisionId='string',
statementId='string'
)
[REQUIRED]
A human-readable name for the signing profile with permissions to be removed.
[REQUIRED]
An identifier for the current revision of the signing profile permissions.
[REQUIRED]
A unique identifier for the cross-account permissions statement.
dict
Response Syntax
{
'revisionId': 'string'
}
Response Structure
(dict) --
revisionId (string) --
An identifier for the current revision of the profile permissions.
Exceptions
signer.Client.exceptions.ValidationExceptionsigner.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.ConflictExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionrevoke_signature(**kwargs)¶Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.
See also: AWS API Documentation
Request Syntax
response = client.revoke_signature(
jobId='string',
jobOwner='string',
reason='string'
)
[REQUIRED]
ID of the signing job to be revoked.
[REQUIRED]
The reason for revoking the signing job.
None
Exceptions
signer.Client.exceptions.ValidationExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionrevoke_signing_profile(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.revoke_signing_profile(
profileName='string',
profileVersion='string',
reason='string',
effectiveTime=datetime(2015, 1, 1)
)
[REQUIRED]
The name of the signing profile to be revoked.
[REQUIRED]
The version of the signing profile to be revoked.
[REQUIRED]
The reason for revoking a signing profile.
[REQUIRED]
A timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.
None
Exceptions
signer.Client.exceptions.ValidationExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptionstart_signing_job(**kwargs)¶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:
StartSigningJob operation.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/
See also: AWS API Documentation
Request Syntax
response = client.start_signing_job(
source={
's3': {
'bucketName': 'string',
'key': 'string',
'version': 'string'
}
},
destination={
's3': {
'bucketName': 'string',
'prefix': 'string'
}
},
profileName='string',
clientRequestToken='string',
profileOwner='string'
)
[REQUIRED]
The S3 bucket that contains the object to sign or a BLOB that contains your raw code.
The S3Source object.
Name of the S3 bucket.
Key name of the bucket object that contains your unsigned code.
Version of your source image in your version enabled S3 bucket.
[REQUIRED]
The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.
The S3Destination object.
Name of the S3 bucket.
An Amazon S3 prefix that you can use to limit responses to those that begin with the specified prefix.
[REQUIRED]
The name of the signing profile.
[REQUIRED]
String that identifies the signing request. All calls after the first that use this token return the same response as the first call.
This field is autopopulated if not provided.
dict
Response Syntax
{
'jobId': 'string',
'jobOwner': 'string'
}
Response Structure
(dict) --
jobId (string) --
The ID of your signing job.
jobOwner (string) --
The AWS account ID of the signing job owner.
Exceptions
signer.Client.exceptions.ValidationExceptionsigner.Client.exceptions.ResourceNotFoundExceptionsigner.Client.exceptions.AccessDeniedExceptionsigner.Client.exceptions.ThrottlingExceptionsigner.Client.exceptions.TooManyRequestsExceptionsigner.Client.exceptions.InternalServiceErrorExceptiontag_resource(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) for the signing profile.
[REQUIRED]
One or more tags to be associated with the signing profile.
dict
Response Syntax
{}
Response Structure
Exceptions
signer.Client.exceptions.InternalServiceErrorExceptionsigner.Client.exceptions.BadRequestExceptionsigner.Client.exceptions.NotFoundExceptionsigner.Client.exceptions.TooManyRequestsExceptionuntag_resource(**kwargs)¶Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) for the signing profile.
[REQUIRED]
A list of tag keys to be removed from the signing profile.
dict
Response Syntax
{}
Response Structure
Exceptions
signer.Client.exceptions.InternalServiceErrorExceptionsigner.Client.exceptions.BadRequestExceptionsigner.Client.exceptions.NotFoundExceptionsigner.Client.exceptions.TooManyRequestsExceptionThe available paginators are:
signer.Paginator.ListSigningJobssigner.Paginator.ListSigningPlatformssigner.Paginator.ListSigningProfilessigner.Paginator.ListSigningJobs¶paginator = client.get_paginator('list_signing_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from signer.Client.list_signing_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
status='InProgress'|'Failed'|'Succeeded',
platformId='string',
requestedBy='string',
isRevoked=True|False,
signatureExpiresBefore=datetime(2015, 1, 1),
signatureExpiresAfter=datetime(2015, 1, 1),
jobInvoker='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'jobs': [
{
'jobId': 'string',
'source': {
's3': {
'bucketName': 'string',
'key': 'string',
'version': 'string'
}
},
'signedObject': {
's3': {
'bucketName': 'string',
'key': 'string'
}
},
'signingMaterial': {
'certificateArn': 'string'
},
'createdAt': datetime(2015, 1, 1),
'status': 'InProgress'|'Failed'|'Succeeded',
'isRevoked': True|False,
'profileName': 'string',
'profileVersion': 'string',
'platformId': 'string',
'platformDisplayName': 'string',
'signatureExpiresAt': datetime(2015, 1, 1),
'jobOwner': 'string',
'jobInvoker': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
jobs (list) --
A list of your signing jobs.
(dict) --
Contains information about a signing job.
jobId (string) --
The ID of the signing job.
source (dict) --
A Source that contains information about a signing job's code image source.
s3 (dict) --
The S3Source object.
bucketName (string) --
Name of the S3 bucket.
key (string) --
Key name of the bucket object that contains your unsigned code.
version (string) --
Version of your source image in your version enabled S3 bucket.
signedObject (dict) --
A SignedObject structure that contains information about a signing job's signed code image.
s3 (dict) --
The S3SignedObject .
bucketName (string) --
Name of the S3 bucket.
key (string) --
Key name that uniquely identifies a signed code image in your bucket.
signingMaterial (dict) --
A SigningMaterial object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job.
certificateArn (string) --
The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
createdAt (datetime) --
The date and time that the signing job was created.
status (string) --
The status of the signing job.
isRevoked (boolean) --
Indicates whether the signing job is revoked.
profileName (string) --
The name of the signing profile that created a signing job.
profileVersion (string) --
The version of the signing profile that created a signing job.
platformId (string) --
The unique identifier for a signing platform.
platformDisplayName (string) --
The name of a signing platform.
signatureExpiresAt (datetime) --
The time when the signature of a signing job expires.
jobOwner (string) --
The AWS account ID of the job owner.
jobInvoker (string) --
The AWS account ID of the job invoker.
NextToken (string) --
A token to resume pagination.
signer.Paginator.ListSigningPlatforms¶paginator = client.get_paginator('list_signing_platforms')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from signer.Client.list_signing_platforms().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
category='string',
partner='string',
target='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'platforms': [
{
'platformId': 'string',
'displayName': 'string',
'partner': 'string',
'target': 'string',
'category': 'AWSIoT',
'signingConfiguration': {
'encryptionAlgorithmOptions': {
'allowedValues': [
'RSA'|'ECDSA',
],
'defaultValue': 'RSA'|'ECDSA'
},
'hashAlgorithmOptions': {
'allowedValues': [
'SHA1'|'SHA256',
],
'defaultValue': 'SHA1'|'SHA256'
}
},
'signingImageFormat': {
'supportedFormats': [
'JSON'|'JSONEmbedded'|'JSONDetached',
],
'defaultFormat': 'JSON'|'JSONEmbedded'|'JSONDetached'
},
'maxSizeInMB': 123,
'revocationSupported': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
platforms (list) --
A list of all platforms that match the request parameters.
(dict) --
Contains information about the signing configurations and parameters that are used to perform a code signing job.
platformId (string) --
The ID of a code signing; platform.
displayName (string) --
The display name of a code signing platform.
partner (string) --
Any partner entities linked to a code signing platform.
target (string) --
The types of targets that can be signed by a code signing platform.
category (string) --
The category of a code signing platform.
signingConfiguration (dict) --
The configuration of a code signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.
encryptionAlgorithmOptions (dict) --
The encryption algorithm options that are available for a code signing job.
allowedValues (list) --
The set of accepted encryption algorithms that are allowed in a code signing job.
defaultValue (string) --
The default encryption algorithm that is used by a code signing job.
hashAlgorithmOptions (dict) --
The hash algorithm options that are available for a code signing job.
allowedValues (list) --
The set of accepted hash algorithms allowed in a code signing job.
defaultValue (string) --
The default hash algorithm that is used in a code signing job.
signingImageFormat (dict) --
The image format of a code signing platform or profile.
supportedFormats (list) --
The supported formats of a code signing image.
defaultFormat (string) --
The default format of a code signing image.
maxSizeInMB (integer) --
The maximum size (in MB) of code that can be signed by a code signing platform.
revocationSupported (boolean) --
Indicates whether revocation is supported for the platform.
NextToken (string) --
A token to resume pagination.
signer.Paginator.ListSigningProfiles¶paginator = client.get_paginator('list_signing_profiles')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from signer.Client.list_signing_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
includeCanceled=True|False,
platformId='string',
statuses=[
'Active'|'Canceled'|'Revoked',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
CANCELED .Filters results to return only signing jobs with statuses in the specified list.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'profiles': [
{
'profileName': 'string',
'profileVersion': 'string',
'profileVersionArn': 'string',
'signingMaterial': {
'certificateArn': 'string'
},
'signatureValidityPeriod': {
'value': 123,
'type': 'DAYS'|'MONTHS'|'YEARS'
},
'platformId': 'string',
'platformDisplayName': 'string',
'signingParameters': {
'string': 'string'
},
'status': 'Active'|'Canceled'|'Revoked',
'arn': 'string',
'tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
profiles (list) --
A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true .
(dict) --
Contains information about the ACM certificates and code signing configuration parameters that can be used by a given code signing user.
profileName (string) --
The name of the signing profile.
profileVersion (string) --
The version of a signing profile.
profileVersionArn (string) --
The ARN of a signing profile, including the profile version.
signingMaterial (dict) --
The ACM certificate that is available for use by a signing profile.
certificateArn (string) --
The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
signatureValidityPeriod (dict) --
The validity period for a signing job created using this signing profile.
value (integer) --
The numerical value of the time unit for signature validity.
type (string) --
The time unit for signature validity.
platformId (string) --
The ID of a platform that is available for use by a signing profile.
platformDisplayName (string) --
The name of the signing platform.
signingParameters (dict) --
The parameters that are available for use by a code signing user.
status (string) --
The status of a code signing profile.
arn (string) --
The Amazon Resource Name (ARN) for the signing profile.
tags (dict) --
A list of tags associated with the signing profile.
NextToken (string) --
A token to resume pagination.
The available waiters are:
signer.Waiter.SuccessfulSigningJob¶waiter = client.get_waiter('successful_signing_job')
wait(**kwargs)¶Polls signer.Client.describe_signing_job() every 20 seconds until a successful state is reached. An error is returned after 25 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
jobId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the signing job on input.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 20
The maximum number of attempts to be made. Default: 25
None