AWS Redshift #Action=EnableLogging API
The #Action=EnableLogging API from AWS Redshift — 1 operation(s) for #action=enablelogging.
OpenAPI Specification
openapi: 3.0.0
info:
version: '2019-12-20'
x-release: v4
title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=EnableLogging 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=EnableLogging'
paths:
/#Action=EnableLogging:
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: EnableLogging
operationId: GET_EnableLogging
description: Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/LoggingStatus'
'480':
description: ClusterNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'481':
description: BucketNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/BucketNotFoundFault'
'482':
description: InsufficientS3BucketPolicyFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InsufficientS3BucketPolicyFault'
'483':
description: InvalidS3KeyPrefixFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidS3KeyPrefixFault'
'484':
description: InvalidS3BucketNameFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidS3BucketNameFault'
'485':
description: InvalidClusterStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterStateFault'
parameters:
- name: ClusterIdentifier
in: query
required: true
description: '<p>The identifier of the cluster on which logging is to be started.</p> <p>Example: <code>examplecluster</code> </p>'
schema:
type: string
maxLength: 2147483647
- name: BucketName
in: query
required: false
description: <p>The name of an existing S3 bucket where the log files are to be stored.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the same region as the cluster</p> </li> <li> <p>The cluster must have read bucket and put object permissions</p> </li> </ul>
schema:
type: string
maxLength: 2147483647
- name: S3KeyPrefix
in: query
required: false
description: '<p>The prefix applied to the log file names.</p> <p>Constraints:</p> <ul> <li> <p>Cannot exceed 512 characters</p> </li> <li> <p>Cannot contain spaces( ), double quotes ("), single quotes (''), a backslash (\), or control characters. The hexadecimal codes for invalid characters are: </p> <ul> <li> <p>x00 to x20</p> </li> <li> <p>x22</p> </li> <li> <p>x27</p> </li> <li> <p>x5c</p> </li> <li> <p>x7f or larger</p> </li> </ul> </li> </ul>'
schema:
type: string
maxLength: 2147483647
- name: LogDestinationType
in: query
required: false
description: The log destination type. An enum with possible values of <code>s3</code> and <code>cloudwatch</code>.
schema:
type: string
enum:
- s3
- cloudwatch
- name: LogExports
in: query
required: false
description: The collection of exported log types. Possible values are <code>connectionlog</code>, <code>useractivitylog</code>, and <code>userlog</code>.
schema:
type: array
items:
$ref: '#/components/schemas/String'
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableLogging
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - G E T_ Enable Logging
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=EnableLogging'
post:
x-aws-operation-name: EnableLogging
operationId: POST_EnableLogging
description: Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/LoggingStatus'
'480':
description: ClusterNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'481':
description: BucketNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/BucketNotFoundFault'
'482':
description: InsufficientS3BucketPolicyFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InsufficientS3BucketPolicyFault'
'483':
description: InvalidS3KeyPrefixFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidS3KeyPrefixFault'
'484':
description: InvalidS3BucketNameFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidS3BucketNameFault'
'485':
description: InvalidClusterStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterStateFault'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableLoggingMessage'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableLogging
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - P O S T_ Enable Logging
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=EnableLogging'
components:
parameters:
X-Amz-Credential:
name: X-Amz-Credential
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-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
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
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-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
schemas:
TStamp:
type: string
format: date-time
String:
type: string
maxLength: 2147483647
LogTypeList:
type: array
items:
$ref: '#/components/schemas/String'
InvalidS3KeyPrefixFault: {}
InsufficientS3BucketPolicyFault: {}
EnableLoggingMessage:
type: object
required:
- ClusterIdentifier
title: EnableLoggingMessage
properties:
ClusterIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The identifier of the cluster on which logging is to be started.</p> <p>Example: <code>examplecluster</code> </p>'
BucketName:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The name of an existing S3 bucket where the log files are to be stored.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the same region as the cluster</p> </li> <li> <p>The cluster must have read bucket and put object permissions</p> </li> </ul>
S3KeyPrefix:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The prefix applied to the log file names.</p> <p>Constraints:</p> <ul> <li> <p>Cannot exceed 512 characters</p> </li> <li> <p>Cannot contain spaces( ), double quotes ("), single quotes (''), a backslash (\), or control characters. The hexadecimal codes for invalid characters are: </p> <ul> <li> <p>x00 to x20</p> </li> <li> <p>x22</p> </li> <li> <p>x27</p> </li> <li> <p>x5c</p> </li> <li> <p>x7f or larger</p> </li> </ul> </li> </ul>'
LogDestinationType:
allOf:
- $ref: '#/components/schemas/LogDestinationType'
- description: The log destination type. An enum with possible values of <code>s3</code> and <code>cloudwatch</code>.
LogExports:
allOf:
- $ref: '#/components/schemas/LogTypeList'
- description: The collection of exported log types. Possible values are <code>connectionlog</code>, <code>useractivitylog</code>, and <code>userlog</code>.
description: <p/>
LogDestinationType:
type: string
enum:
- s3
- cloudwatch
InvalidClusterStateFault: {}
BucketNotFoundFault: {}
Boolean:
type: boolean
InvalidS3BucketNameFault: {}
ClusterNotFoundFault: {}
LoggingStatus:
type: object
properties:
LoggingEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: ' <code>true</code> if logging is on, <code>false</code> if logging is off.'
BucketName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the S3 bucket where the log files are stored.
S3KeyPrefix:
allOf:
- $ref: '#/components/schemas/String'
- description: The prefix applied to the log file names.
LastSuccessfulDeliveryTime:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The last time that logs were delivered.
LastFailureTime:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The last time when logs failed to be delivered.
LastFailureMessage:
allOf:
- $ref: '#/components/schemas/String'
- description: The message indicating that logs failed to be delivered.
LogDestinationType:
allOf:
- $ref: '#/components/schemas/LogDestinationType'
- description: The log destination type. An enum with possible values of <code>s3</code> and <code>cloudwatch</code>.
LogExports:
allOf:
- $ref: '#/components/schemas/LogTypeList'
- description: The collection of exported log types. Possible values are <code>connectionlog</code>, <code>useractivitylog</code>, and <code>userlog</code>.
description: Describes the status of logging for a cluster.
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