Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Redshift #Action=CreateScheduledAction API

The #Action=CreateScheduledAction API from AWS Redshift — 1 operation(s) for #action=createscheduledaction.

AWS Redshift #Action=CreateScheduledAction API is one of 130 APIs that AWS Redshift publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #Action=CreateScheduledAction. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 2019-12-20.

Requests are made against 4 base URLs: http://redshift-data.{region}.amazonaws.com, https://redshift-data.{region}.amazonaws.com, http://redshift-data.{region}.amazonaws.com.cn, https://redshift-data.{region}.amazonaws.com.cn.

2 operations 1 paths 18 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2019-12-20
Base URL
https://redshift.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Redshift #Action=CreateScheduledAction API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

#Action=CreateScheduledAction 2
GET
/#Action=CreateScheduledAction
Amazon Redshift - G E T Create Scheduled Action
GET_CreateScheduledAction 17 params → 200480481482483484485
POST
/#Action=CreateScheduledAction
Amazon Redshift - P O S T Create Scheduled Action
POST_CreateScheduledAction 9 params body → 200480481482483484485

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ScheduledAction (9 properties), CreateScheduledActionMessage (8 properties), ResizeClusterMessage (7 properties), ScheduledActionType (3 properties). Each schema is shown below with its type and property counts.

BooleanOptional
boolean
TStamp
string
String
string
UnauthorizedOperation
CreateScheduledActionMessage
object
8 properties 4 required
ResumeClusterMessage
object
Describes a resume cluster operation. For example, a scheduled action to run the ResumeCluster API operation.
1 property 1 required
ScheduledActionAlreadyExistsFault
ScheduledAction
object
Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API oper…
9 properties
ScheduledActionState
string
PauseClusterMessage
object
Describes a pause cluster operation. For example, a scheduled action to run the PauseCluster API operation.
1 property 1 required
ResizeClusterMessage
object
Describes a resize cluster operation. For example, a scheduled action to run the ResizeCluster API operation.
7 properties 1 required
ScheduledActionType
object
The action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler.
3 properties
InvalidScheduledActionFault
InvalidScheduleFault
ScheduledActionTypeUnsupportedFault
IntegerOptional
integer
ScheduledActionTimeList
array
ScheduledActionQuotaExceededFault

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-redshift-action-createscheduledaction-api-openapi.yml Raw ↑

Other APIs AWS Redshift publishes across the network.

Amazon Redshift Serverless API
AWS Redshift #Action=AcceptReservedNodeExchange API
AWS Redshift #Action=AddPartner API
AWS Redshift #Action=AssociateDataShareConsumer API
AWS Redshift #Action=AuthorizeClusterSecurityGroupIngress API
AWS Redshift #Action=AuthorizeDataShare API
AWS Redshift #Action=AuthorizeEndpointAccess API
AWS Redshift #Action=AuthorizeSnapshotAccess API
AWS Redshift #Action=BatchDeleteClusterSnapshots API
AWS Redshift #Action=BatchModifyClusterSnapshots API
AWS Redshift #Action=CancelResize API
AWS Redshift #Action=CopyClusterSnapshot API