signer / Client / put_signing_profile

put_signing_profile#

signer.Client.put_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.

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'
    }
)
Parameters:

  • profileName (string) –

    [REQUIRED]

    The name of the signing profile to be created.

  • signingMaterial (dict) –

    The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.

    • certificateArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

  • signatureValidityPeriod (dict) –

    The default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.

    • value (integer) –

      The numerical value of the time unit for signature validity.

    • type (string) –

      The time unit for signature validity.

  • platformId (string) –

    [REQUIRED]

    The ID of the signing platform to be created.

  • overrides (dict) –

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

    • 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) –

    Map of key-value pairs for signing. These can include any information that you want to use during signing.

    • (string) –

      • (string) –

  • tags (dict) –

    Tags to be associated with the signing profile that is being created.

    • (string) –

      • (string) –

Return type:

dict

Returns:

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