Amazon MSK Tags API
The Tags API from Amazon MSK — 2 operation(s) for tags.
Documentation
Documentation
https://docs.aws.amazon.com/msk/
GettingStarted
https://aws.amazon.com/msk/getting-started/
OpenAPI Specification
openapi: 3.0.0
info:
version: 2018-11-14
x-release: v4
title: Managed Streaming for Kafka Clusters Tags API
description: "\n <p>The operations for managing an Amazon MSK cluster.</p>"
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
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: kafka
x-aws-signingName: kafka
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/kafka-2018-11-14.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://kafka.{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 Kafka multi-region endpoint
- url: https://kafka.{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 Kafka multi-region endpoint
- url: http://kafka.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Kafka endpoint for China (Beijing) and China (Ningxia)
- url: https://kafka.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Kafka endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Tags
paths:
/v1/tags/{resourceArn}:
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: ListTagsForResource
description: "\n <p>Returns a list of the tags associated with the specified resource.</p>"
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceResponse'
examples:
ListTagsForResource200Example:
summary: Default ListTagsForResource 200 response
x-microcks-default: true
value:
Tags: example-value
'480':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
ListTagsForResource480Example:
summary: Default ListTagsForResource 480 response
x-microcks-default: true
value: {}
'481':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
ListTagsForResource481Example:
summary: Default ListTagsForResource 481 response
x-microcks-default: true
value: {}
'482':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListTagsForResource482Example:
summary: Default ListTagsForResource 482 response
x-microcks-default: true
value: {}
parameters:
- name: resourceArn
in: path
required: true
description: "\n <p>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</p>"
schema:
type: string
summary: Amazon MSK List Tags for Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Tags
post:
operationId: TagResource
description: "\n <p>Adds tags to the specified MSK resource.</p>"
responses:
'204':
description: Success
'480':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
TagResource480Example:
summary: Default TagResource 480 response
x-microcks-default: true
value: {}
'481':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
TagResource481Example:
summary: Default TagResource 481 response
x-microcks-default: true
value: {}
'482':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
TagResource482Example:
summary: Default TagResource 482 response
x-microcks-default: true
value: {}
parameters:
- name: resourceArn
in: path
required: true
description: "\n <p>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</p>"
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- tags
properties:
tags:
description: "\n <p>The key-value pair for the resource tag.</p>"
type: object
additionalProperties:
$ref: '#/components/schemas/__string'
summary: Amazon MSK Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Tags
/v1/tags/{resourceArn}#tagKeys:
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'
delete:
operationId: UntagResource
description: "\n <p>Removes the tags associated with the keys that are provided in the query.</p>"
responses:
'204':
description: Success
'480':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
UntagResource480Example:
summary: Default UntagResource 480 response
x-microcks-default: true
value: {}
'481':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
UntagResource481Example:
summary: Default UntagResource 481 response
x-microcks-default: true
value: {}
'482':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
UntagResource482Example:
summary: Default UntagResource 482 response
x-microcks-default: true
value: {}
parameters:
- name: resourceArn
in: path
required: true
description: "\n <p>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</p>"
schema:
type: string
- name: tagKeys
in: query
required: true
description: "\n <p>Tag keys must be unique for a given cluster. In addition, the following restrictions apply:</p>\n <ul>\n <li>\n <p>Each tag key must be unique. If you add a tag with a key that's already in\n use, your new tag overwrites the existing key-value pair. </p>\n </li>\n <li>\n <p>You can't start a tag key with aws: because this prefix is reserved for use\n by AWS. AWS creates tags that begin with this prefix on your behalf, but\n you can't edit or delete them.</p>\n </li>\n <li>\n <p>Tag keys must be between 1 and 128 Unicode characters in length.</p>\n </li>\n <li>\n <p>Tag keys must consist of the following characters: Unicode letters, digits,\n white space, and the following special characters: _ . / = + -\n @.</p>\n </li>\n </ul>"
schema:
type: array
items:
$ref: '#/components/schemas/__string'
summary: Amazon MSK Untag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Tags
components:
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
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-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
schemas:
NotFoundException: {}
__mapOf__string:
type: object
additionalProperties:
$ref: '#/components/schemas/__string'
BadRequestException: {}
__string:
type: string
ListTagsForResourceResponse:
type: object
properties:
Tags:
allOf:
- $ref: '#/components/schemas/__mapOf__string'
- xml:
name: tags
description: "\n <p>The key-value pair for the resource tag.</p>"
InternalServerErrorException: {}
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/kafka/
x-hasEquivalentPaths: true