[ aws . signer ]

list-signing-profiles

Description

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

See ‘aws help’ for descriptions of global parameters.

list-signing-profiles is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: profiles

Synopsis

  list-signing-profiles
[--include-canceled | --no-include-canceled]
[--platform-id <value>]
[--statuses <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--include-canceled | --no-include-canceled (boolean)

Designates whether to include profiles with the status of CANCELED .

--platform-id (string)

Filters results to return only signing jobs initiated for a specified signing platform.

--statuses (list)

Filters results to return only signing jobs with statuses in the specified list.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  Active
  Canceled
  Revoked

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

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 list all signing profiles

The following list-signing-profiles example displays details about all signing profiles for the account.

aws signer list-signing-profiles

Output:

{
    "profiles": [
        {
            "platformId": "AmazonFreeRTOS-TI-CC3220SF",
            "profileName": "MyProfile4",
            "status": "Active",
            "signingMaterial": {
                "certificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc"
            }
        },
        {
            "platformId": "AWSIoTDeviceManagement-SHA256-ECDSA",
            "profileName": "MyProfile5",
            "status": "Active",
            "signingMaterial": {
                "certificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc"
            }
        }
    ]
}

Output

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 .

(structure)

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

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

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

The parameters that are available for use by a code signing user.

key -> (string)

value -> (string)

status -> (string)

The status of a code signing profile.

arn -> (string)

The Amazon Resource Name (ARN) for the signing profile.

tags -> (map)

A list of tags associated with the signing profile.

key -> (string)

value -> (string)

nextToken -> (string)

Value for specifying the next set of paginated results to return.