AWS Redshift #Action=DescribeEventCategories API
The #Action=DescribeEventCategories API from AWS Redshift — 1 operation(s) for #action=describeeventcategories.
The #Action=DescribeEventCategories API from AWS Redshift — 1 operation(s) for #action=describeeventcategories.
openapi: 3.0.0
info:
version: '2019-12-20'
x-release: v4
title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=DescribeEventCategories API'
description: <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </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: redshift-data
x-aws-signingName: redshift-data
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/redshift-data-2019-12-20.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://redshift-data.{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 Redshift Data API Service multi-region endpoint
- url: https://redshift-data.{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 Redshift Data API Service multi-region endpoint
- url: http://redshift-data.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
- url: https://redshift-data.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=DescribeEventCategories'
paths:
/#Action=DescribeEventCategories:
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:
x-aws-operation-name: DescribeEventCategories
operationId: GET_DescribeEventCategories
description: Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html">Amazon Redshift Event Notifications</a>.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/EventCategoriesMessage'
parameters:
- name: SourceType
in: query
required: false
description: '<p>The source type, such as cluster or parameter group, to which the described event categories apply.</p> <p>Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.</p>'
schema:
type: string
maxLength: 2147483647
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeEventCategories
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - G E T_ Describe Event Categories
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribeEventCategories'
post:
x-aws-operation-name: DescribeEventCategories
operationId: POST_DescribeEventCategories
description: Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html">Amazon Redshift Event Notifications</a>.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/EventCategoriesMessage'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeEventCategoriesMessage'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeEventCategories
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - P O S T_ Describe Event Categories
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribeEventCategories'
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-Signature:
name: X-Amz-Signature
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-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
schemas:
EventCategoriesList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: EventCategory
EventInfoMap:
type: object
properties:
EventId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of an Amazon Redshift event.
EventCategories:
allOf:
- $ref: '#/components/schemas/EventCategoriesList'
- description: The category of an Amazon Redshift event.
EventDescription:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of an Amazon Redshift event.
Severity:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The severity of the event.</p> <p>Values: ERROR, INFO</p>'
description: Describes event information.
EventInfoMapList:
type: array
items:
allOf:
- $ref: '#/components/schemas/EventInfoMap'
- xml:
name: EventInfoMap
DescribeEventCategoriesMessage:
type: object
title: DescribeEventCategoriesMessage
properties:
SourceType:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The source type, such as cluster or parameter group, to which the described event categories apply.</p> <p>Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.</p>'
description: <p/>
EventCategoriesMapList:
type: array
items:
allOf:
- $ref: '#/components/schemas/EventCategoriesMap'
- xml:
name: EventCategoriesMap
String:
type: string
maxLength: 2147483647
EventCategoriesMessage:
type: object
properties:
EventCategoriesMapList:
allOf:
- $ref: '#/components/schemas/EventCategoriesMapList'
- description: A list of event categories descriptions.
description: <p/>
EventCategoriesMap:
type: object
properties:
SourceType:
allOf:
- $ref: '#/components/schemas/String'
- description: The source type, such as cluster or cluster-snapshot, that the returned categories belong to.
Events:
allOf:
- $ref: '#/components/schemas/EventInfoMapList'
- description: The events in the event category.
description: Describes event categories.
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/redshift-data/
x-hasEquivalentPaths: true