Amazon Certificate Manager Certificate Manager Tag API

openapi: 3.2.0
info:
  title: AWS Certificate Manager Tag API
  version: '2015-12-08'
  description: Generated from AWS's published Smithy model for AWS Certificate Manager. 4 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: Tag
paths:
  /#AddTagsToCertificate:
    post:
      operationId: AddTagsToCertificate
      summary: Add Tags To Certificate
      description: Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. This action applies only to the certificate resource type. For all other ACM resource types, use TagResource instead. You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates. To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidArnException; InvalidParameterException; InvalidTagException; ResourceNotFoundException; TagPolicyException; ThrottlingException; TooManyTagsException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArnException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CertificateManager.AddTagsToCertificate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AddTagsToCertificateRequest'
      tags:
      - Tag
  /#ListTagsForCertificate:
    post:
      operationId: ListTagsForCertificate
      summary: List Tags For Certificate
      description: Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action. This action applies only to the certificate resource type. For all other ACM resource types, use ListTagsForResource instead.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTagsForCertificateResponse'
        '400':
          description: InvalidArnException; ResourceNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArnException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CertificateManager.ListTagsForCertificate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTagsForCertificateRequest'
      tags:
      - Tag
  /#ListTagsForResource:
    post:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Lists the tags associated with an ACM resource. Use this action for all ACM resource types except the certificate resource type. For certificate resources, use ListTagsForCertificate instead. To add one or more tags, use the TagResource action. To remove one or more tags, use the UntagResource action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
        '400':
          description: ResourceNotFoundException; 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.ListTagsForResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTagsForResourceRequest'
      tags:
      - Tag
  /#RemoveTagsFromCertificate:
    post:
      operationId: RemoveTagsFromCertificate
      summary: Remove Tags From Certificate
      description: Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. This action applies only to the certificate resource type. For all other ACM resource types, use UntagResource instead. To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidArnException; InvalidParameterException; InvalidTagException; ResourceNotFoundException; TagPolicyException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArnException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CertificateManager.RemoveTagsFromCertificate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/RemoveTagsFromCertificateRequest'
      tags:
      - Tag
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
    RemoveTagsFromCertificateRequest:
      type: object
      properties:
        CertificateArn:
          type: string
          description: 'String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs).'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key-value pair that defines the tag to remove.
      required:
      - CertificateArn
      - Tags
    AddTagsToCertificateRequest:
      type: object
      properties:
        CertificateArn:
          type: string
          description: 'String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs).'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key-value pair that defines the tag. The tag value is optional.
      required:
      - CertificateArn
      - Tags
    InvalidArnException:
      type: object
      properties:
        message:
          type: string
    ListTagsForCertificateRequest:
      type: object
      properties:
        CertificateArn:
          type: string
          description: 'String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs).'
      required:
      - CertificateArn
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ListTagsForResourceResponse:
      type: object
      properties:
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the resource.
    ListTagsForResourceRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The ARN of the ACM resource for which to list tags.
      required:
      - ResourceArn
    ListTagsForCertificateResponse:
      type: object
      properties:
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key-value pairs that define the applied tags.
  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)