Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . signer ]

put-signing-profile¶

Description¶

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

Synopsis¶

  put-signing-profile
--profile-name <value>
[--signing-material <value>]
[--signature-validity-period <value>]
--platform-id <value>
[--overrides <value>]
[--signing-parameters <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--profile-name (string)

The name of the signing profile to be created.

--signing-material (structure)

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

certificateArn -> (string)

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

Shorthand Syntax:

certificateArn=string

JSON Syntax:

{
  "certificateArn": "string"
}

--signature-validity-period (structure)

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.

Shorthand Syntax:

value=integer,type=string

JSON Syntax:

{
  "value": integer,
  "type": "DAYS"|"MONTHS"|"YEARS"
}

--platform-id (string)

The ID of the signing platform to be created.

--overrides (structure)

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 -> (structure)

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.

Shorthand Syntax:

signingConfiguration={encryptionAlgorithm=string,hashAlgorithm=string},signingImageFormat=string

JSON Syntax:

{
  "signingConfiguration": {
    "encryptionAlgorithm": "RSA"|"ECDSA",
    "hashAlgorithm": "SHA1"|"SHA256"
  },
  "signingImageFormat": "JSON"|"JSONEmbedded"|"JSONDetached"
}

--signing-parameters (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a signing profile

The following put-signing-profile example creates a signing profile using the specified certificate and platform.

aws signer put-signing-profile \
    --profile-name MyProfile6 \
    --signing-material certificateArn=arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc \
    --platform AmazonFreeRTOS-TI-CC3220SF

Output:

{
    "arn": "arn:aws:signer:us-west-2:123456789012:/signing-profiles/MyProfile6"
}

Output¶

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.

Table Of Contents

Feedback

User Guide

Note:

put-signing-profile¶

Description¶

Synopsis¶

Options¶

Global Options¶

Examples¶

Note

Output¶