Amazon Signer Signing Platforms API

openapi: 3.0.0
info:
  version: '2017-08-25'
  x-release: v4
  title: AWS Signer Revocations#signatureTimestamp&platformId&profileVersionArn&jobArn&certificateHashes Signing Platforms API
  description: <p>AWS Signer is a fully managed code signing service to help you ensure the trust and integrity of your code. </p> <p>AWS Signer supports the following applications:</p> <p>With code signing for AWS Lambda, you can sign <a href="http://docs.aws.amazon.com/lambda/latest/dg/">AWS Lambda</a> deployment packages. Integrated support is provided for <a href="http://docs.aws.amazon.com/AmazonS3/latest/gsg/">Amazon S3</a>, <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/">Amazon CloudWatch</a>, and <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/">AWS CloudTrail</a>. In order to sign code, you create a signing profile and then use Signer to sign Lambda zip files in S3. </p> <p>With code signing for IoT, you can sign code for any IoT device that is supported by AWS. IoT code signing is available for <a href="http://docs.aws.amazon.com/freertos/latest/userguide/">Amazon FreeRTOS</a> and <a href="http://docs.aws.amazon.com/iot/latest/developerguide/">AWS IoT Device Management</a>, and is integrated with <a href="http://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager (ACM)</a>. 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. </p> <p>With code signing for containers …(TBD)</p> <p>For more information about AWS Signer, see the <a href="https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html">AWS Signer Developer Guide</a>.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: signer
  x-aws-signingName: signer
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/signer-2017-08-25.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://signer.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The signer multi-region endpoint
- url: https://signer.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The signer multi-region endpoint
- url: http://signer.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The signer endpoint for China (Beijing) and China (Ningxia)
- url: https://signer.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The signer endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Signing Platforms
paths:
  /signing-platforms/{platformId}:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: GetSigningPlatform
      description: Returns information on a specific signing platform.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSigningPlatformResponse'
              examples:
                GetSigningPlatform200Example:
                  summary: Default GetSigningPlatform 200 response
                  x-microcks-default: true
                  value:
                    platformId: AWSLambda-SHA384-ECDSA
                    displayName: MySigningResource
                    partner: example-value
                    target: example-value
                    category: example-value
                    signingConfiguration: example-value
                    signingImageFormat: example-value
                    maxSizeInMB: example-value
                    revocationSupported: example-value
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                GetSigningPlatform480Example:
                  summary: Default GetSigningPlatform 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                GetSigningPlatform481Example:
                  summary: Default GetSigningPlatform 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
              examples:
                GetSigningPlatform482Example:
                  summary: Default GetSigningPlatform 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: InternalServiceErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
              examples:
                GetSigningPlatform483Example:
                  summary: Default GetSigningPlatform 483 response
                  x-microcks-default: true
                  value: example-value
      parameters:
      - name: platformId
        in: path
        required: true
        description: The ID of the target signing platform.
        schema:
          type: string
      summary: Amazon Get Signing Platform
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Signing Platforms
  /signing-platforms:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: ListSigningPlatforms
      description: Lists all signing platforms available in code signing that match the request parameters. If additional jobs remain to be listed, code signing returns a <code>nextToken</code> value. Use this value in subsequent calls to <code>ListSigningJobs</code> to fetch the remaining values. You can continue calling <code>ListSigningJobs</code> with your <code>maxResults</code> parameter and with new values that code signing returns in the <code>nextToken</code> parameter until all of your signing jobs have been returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSigningPlatformsResponse'
              examples:
                ListSigningPlatforms200Example:
                  summary: Default ListSigningPlatforms 200 response
                  x-microcks-default: true
                  value:
                    platforms: AWSLambda-SHA384-ECDSA
                    nextToken: example-value
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                ListSigningPlatforms480Example:
                  summary: Default ListSigningPlatforms 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                ListSigningPlatforms481Example:
                  summary: Default ListSigningPlatforms 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
              examples:
                ListSigningPlatforms482Example:
                  summary: Default ListSigningPlatforms 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: InternalServiceErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
              examples:
                ListSigningPlatforms483Example:
                  summary: Default ListSigningPlatforms 483 response
                  x-microcks-default: true
                  value: example-value
      parameters:
      - name: category
        in: query
        required: false
        description: The category type of a signing platform.
        schema:
          type: string
      - name: partner
        in: query
        required: false
        description: Any partner entities connected to a signing platform.
        schema:
          type: string
      - name: target
        in: query
        required: false
        description: The validation template that is used by the target signing platform.
        schema:
          type: string
      - name: maxResults
        in: query
        required: false
        description: The maximum number of results to be returned by this operation.
        schema:
          type: integer
          minimum: 1
          maximum: 25
      - name: nextToken
        in: query
        required: false
        description: 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 <code>nextToken</code> from the response that you just received.
        schema:
          type: string
      summary: Amazon List Signing Platforms
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Signing Platforms
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    HashAlgorithmOptions:
      type: object
      required:
      - allowedValues
      - defaultValue
      properties:
        allowedValues:
          allOf:
          - $ref: '#/components/schemas/HashAlgorithms'
          - description: The set of accepted hash algorithms allowed in a code signing job.
        defaultValue:
          allOf:
          - $ref: '#/components/schemas/HashAlgorithm'
          - description: The default hash algorithm that is used in a code signing job.
      description: The hash algorithms that are available to a code signing job.
    SigningImageFormat:
      type: object
      required:
      - supportedFormats
      - defaultFormat
      properties:
        supportedFormats:
          allOf:
          - $ref: '#/components/schemas/ImageFormats'
          - description: The supported formats of a code signing image.
        defaultFormat:
          allOf:
          - $ref: '#/components/schemas/ImageFormat'
          - description: The default format of a code signing image.
      description: The image format of a code signing platform or profile.
    EncryptionAlgorithms:
      type: array
      items:
        $ref: '#/components/schemas/EncryptionAlgorithm'
    ListSigningPlatformsResponse:
      type: object
      properties:
        platforms:
          allOf:
          - $ref: '#/components/schemas/SigningPlatforms'
          - description: A list of all platforms that match the request parameters.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Value for specifying the next set of paginated results to return.
    String:
      type: string
    InternalServiceErrorException: {}
    Category:
      type: string
      enum:
      - AWSIoT
    EncryptionAlgorithmOptions:
      type: object
      required:
      - allowedValues
      - defaultValue
      properties:
        allowedValues:
          allOf:
          - $ref: '#/components/schemas/EncryptionAlgorithms'
          - description: The set of accepted encryption algorithms that are allowed in a code signing job.
        defaultValue:
          allOf:
          - $ref: '#/components/schemas/EncryptionAlgorithm'
          - description: The default encryption algorithm that is used by a code signing job.
      description: The encryption algorithm options that are available to a code signing job.
    HashAlgorithms:
      type: array
      items:
        $ref: '#/components/schemas/HashAlgorithm'
    DisplayName:
      type: string
    SigningPlatform:
      type: object
      properties:
        platformId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The ID of a code signing platform.
        displayName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The display name of a code signing platform.
        partner:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Any partner entities linked to a code signing platform.
        target:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The types of targets that can be signed by a code signing platform.
        category:
          allOf:
          - $ref: '#/components/schemas/Category'
          - description: The category of a code signing platform.
        signingConfiguration:
          allOf:
          - $ref: '#/components/schemas/SigningConfiguration'
          - description: The configuration of a code signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.
        signingImageFormat:
          $ref: '#/components/schemas/SigningImageFormat'
        maxSizeInMB:
          allOf:
          - $ref: '#/components/schemas/MaxSizeInMB'
          - description: The maximum size (in MB) of code that can be signed by a code signing platform.
        revocationSupported:
          allOf:
          - $ref: '#/components/schemas/bool'
          - description: Indicates whether revocation is supported for the platform.
      description: Contains information about the signing configurations and parameters that are used to perform a code signing job.
    PlatformId:
      type: string
    AccessDeniedException: {}
    ImageFormat:
      type: string
      enum:
      - JSON
      - JSONEmbedded
      - JSONDetached
    ResourceNotFoundException: {}
    GetSigningPlatformResponse:
      type: object
      properties:
        platformId:
          allOf:
          - $ref: '#/components/schemas/PlatformId'
          - description: The ID of the target signing platform.
        displayName:
          allOf:
          - $ref: '#/components/schemas/DisplayName'
          - description: The display name of the target signing platform.
        partner:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A list of partner entities that use the target signing platform.
        target:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The validation template that is used by the target signing platform.
        category:
          allOf:
          - $ref: '#/components/schemas/Category'
          - description: The category type of the target signing platform.
        signingConfiguration:
          allOf:
          - $ref: '#/components/schemas/SigningConfiguration'
          - description: A list of configurations applied to the target platform at signing.
        signingImageFormat:
          allOf:
          - $ref: '#/components/schemas/SigningImageFormat'
          - description: The format of the target platform's signing image.
        maxSizeInMB:
          allOf:
          - $ref: '#/components/schemas/MaxSizeInMB'
          - description: The maximum size (in MB) of the payload that can be signed by the target platform.
        revocationSupported:
          allOf:
          - $ref: '#/components/schemas/bool'
          - description: A flag indicating whether signatures generated for the signing platform can be revoked.
    SigningPlatforms:
      type: array
      items:
        $ref: '#/components/schemas/SigningPlatform'
    ValidationException: {}
    HashAlgorithm:
      type: string
      enum:
      - SHA1
      - SHA256
    bool:
      type: boolean
    TooManyRequestsException: {}
    SigningConfiguration:
      type: object
      required:
      - encryptionAlgorithmOptions
      - hashAlgorithmOptions
      properties:
        encryptionAlgorithmOptions:
          allOf:
          - $ref: '#/components/schemas/EncryptionAlgorithmOptions'
          - description: The encryption algorithm options that are available for a code signing job.
        hashAlgorithmOptions:
          allOf:
          - $ref: '#/components/schemas/HashAlgorithmOptions'
          - description: The hash algorithm options that are available for a code signing job.
      description: The configuration of a code signing operation.
    MaxSizeInMB:
      type: integer
    ImageFormats:
      type: array
      items:
        $ref: '#/components/schemas/ImageFormat'
    EncryptionAlgorithm:
      type: string
      enum:
      - RSA
      - ECDSA
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/signer/
x-hasEquivalentPaths: true