Amazon Certificate Manager Certificate Manager Acme External Account Binding API

openapi: 3.2.0
info:
  title: AWS Certificate Manager Acme External Account Binding API
  version: '2015-12-08'
  description: Generated from AWS's published Smithy model for AWS Certificate Manager. 5 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://acm.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Acme External Account Binding
paths:
  /#CreateAcmeExternalAccountBinding:
    post:
      operationId: CreateAcmeExternalAccountBinding
      summary: Create Acme External Account Binding
      description: Creates an external account binding (EAB) for an ACME endpoint. An EAB provides credentials that authorize an ACME client to register an account with the endpoint. Each EAB is associated with an IAM role that controls what certificate operations the ACME client can perform.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateAcmeExternalAccountBindingResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ResourceNotFoundException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CertificateManager.CreateAcmeExternalAccountBinding
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateAcmeExternalAccountBindingRequest'
      tags:
      - Acme External Account Binding
  /#DeleteAcmeExternalAccountBinding:
    post:
      operationId: DeleteAcmeExternalAccountBinding
      summary: Delete Acme External Account Binding
      description: Deletes an external account binding. Previously fetched credentials for this binding will no longer be usable for account registration. A deleted binding cannot be recovered.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CertificateManager.DeleteAcmeExternalAccountBinding
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAcmeExternalAccountBindingRequest'
      tags:
      - Acme External Account Binding
  /#DescribeAcmeExternalAccountBinding:
    post:
      operationId: DescribeAcmeExternalAccountBinding
      summary: Describe Acme External Account Binding
      description: Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeAcmeExternalAccountBindingResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CertificateManager.DescribeAcmeExternalAccountBinding
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeAcmeExternalAccountBindingRequest'
      tags:
      - Acme External Account Binding
  /#ListAcmeExternalAccountBindings:
    post:
      operationId: ListAcmeExternalAccountBindings
      summary: List Acme External Account Bindings
      description: Retrieves a list of external account bindings for the specified ACME endpoint.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAcmeExternalAccountBindingsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CertificateManager.ListAcmeExternalAccountBindings
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAcmeExternalAccountBindingsRequest'
      tags:
      - Acme External Account Binding
  /#RevokeAcmeExternalAccountBinding:
    post:
      operationId: RevokeAcmeExternalAccountBinding
      summary: Revoke Acme External Account Binding
      description: Revokes an external account binding, preventing new ACME accounts from being registered using this binding. Existing ACME accounts that were previously registered using the binding are not affected and must be revoked separately.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CertificateManager.RevokeAcmeExternalAccountBinding
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/RevokeAcmeExternalAccountBindingRequest'
      tags:
      - Acme External Account Binding
components:
  schemas:
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the tag.
        Value:
          type: string
          description: The value of the tag.
      required:
      - Key
    DescribeAcmeExternalAccountBindingResponse:
      type: object
      properties:
        ExternalAccountBinding:
          $ref: '#/components/schemas/AcmeExternalAccountBinding'
    ListAcmeExternalAccountBindingsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: A token for pagination.
        MaxResults:
          type: integer
          description: The maximum number of results to return.
        AcmeEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ACME endpoint.
      required:
      - AcmeEndpointArn
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        throttlingReasons:
          type: array
          items:
            $ref: '#/components/schemas/ThrottlingReason'
          description: One or more reasons why the request was throttled.
    Expiration:
      type: object
      properties:
        Value:
          type: integer
          description: The numeric value of the expiration.
        Type:
          type: string
          enum:
          - MINUTES
          - HOURS
          - DAYS
          description: The time unit for the expiration value.
      required:
      - Value
      - Type
    ListAcmeExternalAccountBindingsResponse:
      type: object
      properties:
        ExternalAccountBindings:
          type: array
          items:
            $ref: '#/components/schemas/AcmeExternalAccountBindingSummary'
          description: The list of external account bindings.
        NextToken:
          type: string
          description: A token for pagination.
    RevokeAcmeExternalAccountBindingRequest:
      type: object
      properties:
        AcmeExternalAccountBindingArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ACME external account binding to revoke.
      required:
      - AcmeExternalAccountBindingArn
    CreateAcmeExternalAccountBindingResponse:
      type: object
      properties:
        ExternalAccountBinding:
          $ref: '#/components/schemas/AcmeExternalAccountBinding'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    CreateAcmeExternalAccountBindingRequest:
      type: object
      properties:
        IdempotencyToken:
          type: string
          description: A unique, case-sensitive identifier to ensure idempotency of the request.
        AcmeEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ACME endpoint.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role to associate with the external account binding.
        Expiration:
          $ref: '#/components/schemas/Expiration'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: One or more tags to associate with the external account binding.
      required:
      - AcmeEndpointArn
      - RoleArn
    AcmeExternalAccountBindingSummary:
      type: object
      properties:
        AcmeExternalAccountBindingArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ACME external account binding.
        AcmeEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ACME endpoint.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role associated with the external account binding.
        ExpiresAt:
          type: string
          description: The time at which the external account binding expires.
        RevokedAt:
          type: string
          description: The time at which the external account binding was revoked.
        LastUsedAt:
          type: string
          description: The time at which the external account binding was last used.
        CreatedAt:
          type: string
          description: The time at which the external account binding was created.
        UpdatedAt:
          type: string
          description: The time at which the external account binding was last updated.
    AcmeExternalAccountBinding:
      type: object
      properties:
        AcmeExternalAccountBindingArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ACME external account binding.
        AcmeEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ACME endpoint.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role associated with the external account binding.
        ExpiresAt:
          type: string
          description: The time at which the external account binding expires.
        RevokedAt:
          type: string
          description: The time at which the external account binding was revoked.
        LastUsedAt:
          type: string
          description: The time at which the external account binding was last used.
        CreatedAt:
          type: string
          description: The time at which the external account binding was created.
        UpdatedAt:
          type: string
          description: The time at which the external account binding was last updated.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    DescribeAcmeExternalAccountBindingRequest:
      type: object
      properties:
        AcmeExternalAccountBindingArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ACME external account binding.
      required:
      - AcmeExternalAccountBindingArn
    DeleteAcmeExternalAccountBindingRequest:
      type: object
      properties:
        AcmeExternalAccountBindingArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ACME external account binding to delete.
      required:
      - AcmeExternalAccountBindingArn
    ThrottlingReason:
      type: object
      properties:
        reason:
          type: string
          description: A description of why a request was throttled.
        resource:
          type: string
          description: The resource that causes the request to be throttled.
  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: acm
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/acm/service/2015-12-08/acm-2015-12-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)