Amazon Redshift Redshift Tag API

The Redshift Tag API from Amazon Redshift — 4 operation(s) for redshift tag.

GitHub OpenAPI

Operations 4

POST /?Action=CreateTags Create Tags #
POST /?Action=DeleteTags Delete Tags #
POST /?Action=DescribeTags Describe Tags #
POST /#ListTagsForResource List Tags For Resource #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-redshift:amazon-redshift-tag-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-redshift-tag-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Redshift Tag API
  version: '2012-12-01'
  description: Generated from AWS's published Smithy model for Amazon Redshift. 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://redshift.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /?Action=CreateTags:
    post:
      operationId: CreateTags
      summary: Create Tags
      description: Adds tags to a cluster. A resource can have up to 50 tags. If you try to create more than 50 tags for a
        resource, you will receive an error and the attempt will fail. If you specify a key that already exists for the resource,
        the value for that key will be updated with the new value.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '400':
          description: InvalidClusterStateFault; InvalidTagFault; TagLimitExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidClusterStateFault'
        '404':
          description: ResourceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTags
                  Version:
                    type: string
                    const: '2012-12-01'
              - $ref: '#/components/schemas/CreateTagsMessage'
      tags:
      - Tag
  /?Action=DeleteTags:
    post:
      operationId: DeleteTags
      summary: Delete Tags
      description: Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the
        tag or tags.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '400':
          description: InvalidTagFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidTagFault'
        '404':
          description: ResourceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTags
                  Version:
                    type: string
                    const: '2012-12-01'
              - $ref: '#/components/schemas/DeleteTagsMessage'
      tags:
      - Tag
  /?Action=DescribeTags:
    post:
      operationId: DescribeTags
      summary: Describe Tags
      description: 'Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can
        return all tags for a given type of resource, such as clusters, snapshots, and so on. The following are limitations
        for DescribeTags: You cannot specify an ARN and a resource-type value together in the same request. You cannot use
        the MaxRecords and Marker parameters together with the ARN parameter. The MaxRecords parameter can be a range from
        10 to 50 results to return in a request. If you specify both tag keys and tag values in the same request, Amazon Redshift
        returns all resources that match any combination of the specified keys and values. For example, if you have owner
        and environment for tag keys, and admin and test for tag values, all resources that have any combination of those
        values are returned. If both tag keys and values are omitted from the request, resources are returned regardless of
        whether they have tag keys or values associated with them.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TaggedResourceListMessage'
        '400':
          description: InvalidTagFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidTagFault'
        '404':
          description: ResourceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeTags
                  Version:
                    type: string
                    const: '2012-12-01'
              - $ref: '#/components/schemas/DescribeTagsMessage'
      tags:
      - Tag
  /#ListTagsForResource:
    post:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Lists the tags assigned to a resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RedshiftServerless.ListTagsForResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTagsForResourceRequest'
      tags:
      - Tag
      servers:
      - url: https://redshift-serverless.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_redshift_serverless: []
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: redshift
    sigv4_redshift_serverless:
      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: redshift-serverless
  schemas:
    CreateTagsMessage:
      type: object
      properties:
        ResourceName:
          type: string
          description: The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with
            the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters
            are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin"
            "Key"="environment","Value"="test" "Key"="version","Value"="1.0".
      required:
      - ResourceName
      - Tags
    DeleteTagsMessage:
      type: object
      properties:
        ResourceName:
          type: string
          description: The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
        TagKeys:
          type: array
          items:
            type: string
          description: The tag key that you want to delete.
      required:
      - ResourceName
      - TagKeys
    DescribeTagsMessage:
      type: object
      properties:
        ResourceName:
          type: string
          description: The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
        ResourceType:
          type: string
          description: 'The type of resource with which you want to view tags. Valid resource types are: Cluster CIDR/IP EC2
            security group Snapshot Cluster security group Subnet group HSM connection HSM certificate Parameter group Snapshot
            copy grant Integration (zero-ETL integration or S3 event integration) To describe the tags associated with an
            integration, don''t specify ResourceType, instead specify the ResourceName of the integration. For more information
            about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects,
            Resources, and Principals in the Amazon Redshi'
        MaxRecords:
          type: integer
          description: The maximum number or response records to return in each call. If the number of remaining response
            records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can
            retrieve the next set of records by retrying the command with the returned marker value.
        Marker:
          type: string
          description: A value that indicates the starting point for the next set of response records in a subsequent request.
            If a value is returned in a response, you can retrieve the next set of records by providing this returned marker
            value in the marker parameter and retrying the command. If the marker field is empty, all response records have
            been retrieved for the request.
        TagKeys:
          type: array
          items:
            type: string
          description: A tag key or keys for which you want to return all matching resources that are associated with the
            specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment.
            If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that
            have either or both of these tag keys associated with them.
        TagValues:
          type: array
          items:
            type: string
          description: A tag value or values for which you want to return all matching resources that are associated with
            the specified value or values. For example, suppose that you have resources tagged with values called admin and
            test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources
            that have either or both of these tag values associated with them.
    InvalidClusterStateFault:
      type: object
      properties:
        message:
          type: string
    InvalidTagFault:
      type: object
      properties:
        message:
          type: string
    ListTagsForResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource to list tags for.
      required:
      - resourceArn
    ListTagsForResourceResponse:
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/RedshiftServerlessTag'
          description: A map of the key-value pairs assigned to the resource.
    RedshiftServerlessInternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    RedshiftServerlessResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The name of the resource that could not be found.
      required:
      - message
    RedshiftServerlessTag:
      type: object
      properties:
        key:
          type: string
          description: The key to use in the tag.
        value:
          type: string
          description: The value of the tag.
      required:
      - key
      - value
    RedshiftServerlessValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundFault:
      type: object
      properties:
        message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key, or name, for the resource tag.
        Value:
          type: string
          description: The value for the resource tag.
    TaggedResource:
      type: object
      properties:
        Tag:
          $ref: '#/components/schemas/Tag'
        ResourceName:
          type: string
          description: 'The Amazon Resource Name (ARN) with which the tag is associated, for example: arn:aws:redshift:us-east-2:123456789:cluster:t1.'
        ResourceType:
          type: string
          description: 'The type of resource with which the tag is associated. Valid resource types are: Cluster CIDR/IP EC2
            security group Snapshot Cluster security group Subnet group HSM connection HSM certificate Parameter group For
            more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift
            Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.'
    TaggedResourceListMessage:
      type: object
      properties:
        TaggedResources:
          type: array
          items:
            $ref: '#/components/schemas/TaggedResource'
          description: A list of tags with their associated resources.
        Marker:
          type: string
          description: A value that indicates the starting point for the next set of response records in a subsequent request.
            If a value is returned in a response, you can retrieve the next set of records by providing this returned marker
            value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have
            been retrieved for the request.
    ThrottlingException:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/redshift/service/2012-12-01/redshift-2012-12-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/redshift/service/2012-12-01/redshift-2012-12-01.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/redshift-serverless/service/2021-04-21/redshift-serverless-2021-04-21.json