Amazon IoT Core Certificates By Ca API

openapi: 3.1.0
info:
  title: AWS IoT Certificates By Ca API
  version: '2015-05-28'
  description: Generated from AWS's published Smithy model for AWS IoT. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://iot.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /certificates-by-ca/{caCertificateId}:
    get:
      operationId: ListCertificatesByCA
      summary: List Certificates By CA
      description: List the device certificates signed by the specified CA certificate. Requires permission to access the
        ListCertificatesByCA action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCertificatesByCAResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCertificatesByCARequest'
      tags:
      - Certificates By Ca
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: iot
  schemas:
    Certificate:
      type: object
      properties:
        certificateArn:
          type: string
          description: The ARN of the certificate.
        certificateId:
          type: string
          description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - REVOKED
          - PENDING_TRANSFER
          - REGISTER_INACTIVE
          - PENDING_ACTIVATION
          description: The status of the certificate. The status value REGISTER_INACTIVE is deprecated and should not be used.
        certificateMode:
          type: string
          enum:
          - DEFAULT
          - SNI_ONLY
          description: 'The mode of the certificate. DEFAULT: A certificate in DEFAULT mode is either generated by Amazon
            Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates
            in DEFAULT mode aren''t required to send the Server Name Indication (SNI) extension when connecting to Amazon
            Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you
            use the SNI extension when connecting to Amazon Web Services IoT Core. SNI_ONLY: A certificate in SNI_ONLY mode
            is registered without an issuer CA. Devices with'
        creationDate:
          type: string
          format: date-time
          description: The date and time the certificate was created.
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    ListCertificatesByCARequest:
      type: object
      properties:
        caCertificateId:
          type: string
          description: The ID of the CA certificate. This operation will list all registered device certificate that were
            signed by this CA certificate.
        pageSize:
          type: integer
          description: The result page size.
        marker:
          type: string
          description: The marker for the next set of results.
        ascendingOrder:
          type: boolean
          description: Specifies the order for results. If True, the results are returned in ascending order, based on the
            creation date.
      required:
      - caCertificateId
    ListCertificatesByCAResponse:
      type: object
      properties:
        certificates:
          type: array
          items:
            $ref: '#/components/schemas/Certificate'
          description: The device certificates signed by the specified CA certificate.
        nextMarker:
          type: string
          description: The marker for the next set of results, or null if there are no additional results.
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/iot/service/2015-05-28/iot-2015-05-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)