How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Redshift Amazon Redshift API

The Amazon Redshift API from AWS Redshift — 119 operation(s) for amazon redshift.

This API exposes 238 operations across 119 paths, and defines 527 schemas. It is described by OpenAPI 3.2.0, at version 2012-12-01.

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

238 operations 119 paths 527 schemas 119 GET119 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2012-12-01
Base URL
https://redshift-serverless.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Redshift Amazon Redshift 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 238

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

Amazon Redshift 238
GET
/#Action=AcceptReservedNodeExchange
Amazon Redshift - G E T Accept Reserved Node Exchange
GET_AcceptReservedNodeExchange 11 params → 200480481482483484485486
POST
/#Action=AcceptReservedNodeExchange
Amazon Redshift - P O S T Accept Reserved Node Exchange
POST_AcceptReservedNodeExchange 9 params body → 200480481482483484485486
GET
/#Action=AddPartner
Amazon Redshift - G E T Add Partner
GET_AddPartner 13 params → 200480481482
POST
/#Action=AddPartner
Amazon Redshift - P O S T Add Partner
POST_AddPartner 9 params body → 200480481482
GET
/#Action=AssociateDataShareConsumer
Amazon Redshift - G E T Associate Data Share Consumer
GET_AssociateDataShareConsumer 13 params → 200480481
POST
/#Action=AssociateDataShareConsumer
Amazon Redshift - P O S T Associate Data Share Consumer
POST_AssociateDataShareConsumer 9 params body → 200480481
GET
/#Action=AuthorizeClusterSecurityGroupIngress
Amazon Redshift - G E T Authorize Cluster Security Group Ingress
GET_AuthorizeClusterSecurityGroupIngress 13 params → 200480481482483
POST
/#Action=AuthorizeClusterSecurityGroupIngress
Amazon Redshift - P O S T Authorize Cluster Security Group Ingress
POST_AuthorizeClusterSecurityGroupIngress 9 params body → 200480481482483
GET
/#Action=AuthorizeDataShare
Amazon Redshift - G E T Authorize Data Share
GET_AuthorizeDataShare 11 params → 200480
POST
/#Action=AuthorizeDataShare
Amazon Redshift - P O S T Authorize Data Share
POST_AuthorizeDataShare 9 params body → 200480
GET
/#Action=AuthorizeEndpointAccess
Amazon Redshift - G E T Authorize Endpoint Access
GET_AuthorizeEndpointAccess 12 params → 200480481482483484485
POST
/#Action=AuthorizeEndpointAccess
Amazon Redshift - P O S T Authorize Endpoint Access
POST_AuthorizeEndpointAccess 9 params body → 200480481482483484485
GET
/#Action=AuthorizeSnapshotAccess
Amazon Redshift - G E T Authorize Snapshot Access
GET_AuthorizeSnapshotAccess 13 params → 200480481482483484485486
POST
/#Action=AuthorizeSnapshotAccess
Amazon Redshift - P O S T Authorize Snapshot Access
POST_AuthorizeSnapshotAccess 9 params body → 200480481482483484485486
GET
/#Action=BatchDeleteClusterSnapshots
Amazon Redshift - G E T Batch Delete Cluster Snapshots
GET_BatchDeleteClusterSnapshots 10 params → 200480
POST
/#Action=BatchDeleteClusterSnapshots
Amazon Redshift - P O S T Batch Delete Cluster Snapshots
POST_BatchDeleteClusterSnapshots 9 params body → 200480
GET
/#Action=BatchModifyClusterSnapshots
Amazon Redshift - G E T Batch Modify Cluster Snapshots
GET_BatchModifyClusterSnapshots 12 params → 200480481
POST
/#Action=BatchModifyClusterSnapshots
Amazon Redshift - P O S T Batch Modify Cluster Snapshots
POST_BatchModifyClusterSnapshots 9 params body → 200480481
GET
/#Action=CancelResize
Amazon Redshift - G E T Cancel Resize
GET_CancelResize 10 params → 200480481482483
POST
/#Action=CancelResize
Amazon Redshift - P O S T Cancel Resize
POST_CancelResize 9 params body → 200480481482483
GET
/#Action=CopyClusterSnapshot
Amazon Redshift - G E T Copy Cluster Snapshot
GET_CopyClusterSnapshot 13 params → 200480481482483484
POST
/#Action=CopyClusterSnapshot
Amazon Redshift - P O S T Copy Cluster Snapshot
POST_CopyClusterSnapshot 9 params body → 200480481482483484
GET
/#Action=CreateAuthenticationProfile
Amazon Redshift - G E T Create Authentication Profile
GET_CreateAuthenticationProfile 11 params → 200480481482
POST
/#Action=CreateAuthenticationProfile
Amazon Redshift - P O S T Create Authentication Profile
POST_CreateAuthenticationProfile 9 params body → 200480481482
GET
/#Action=CreateCluster
Amazon Redshift - G E T Create Cluster
GET_CreateCluster 43 params → 200480481482483484485486
POST
/#Action=CreateCluster
Amazon Redshift - P O S T Create Cluster
POST_CreateCluster 9 params body → 200480481482483484485486
GET
/#Action=CreateClusterParameterGroup
Amazon Redshift - G E T Create Cluster Parameter Group
GET_CreateClusterParameterGroup 13 params → 200480481482483
POST
/#Action=CreateClusterParameterGroup
Amazon Redshift - P O S T Create Cluster Parameter Group
POST_CreateClusterParameterGroup 9 params body → 200480481482483
GET
/#Action=CreateClusterSecurityGroup
Amazon Redshift - G E T Create Cluster Security Group
GET_CreateClusterSecurityGroup 12 params → 200480481482483
POST
/#Action=CreateClusterSecurityGroup
Amazon Redshift - P O S T Create Cluster Security Group
POST_CreateClusterSecurityGroup 9 params body → 200480481482483
GET
/#Action=CreateClusterSnapshot
Amazon Redshift - G E T Create Cluster Snapshot
GET_CreateClusterSnapshot 13 params → 200480481482483484485486
POST
/#Action=CreateClusterSnapshot
Amazon Redshift - P O S T Create Cluster Snapshot
POST_CreateClusterSnapshot 9 params body → 200480481482483484485486
GET
/#Action=CreateClusterSubnetGroup
Amazon Redshift - G E T Create Cluster Subnet Group
GET_CreateClusterSubnetGroup 13 params → 200480481482483484485486
POST
/#Action=CreateClusterSubnetGroup
Amazon Redshift - P O S T Create Cluster Subnet Group
POST_CreateClusterSubnetGroup 9 params body → 200480481482483484485486
GET
/#Action=CreateEndpointAccess
Amazon Redshift - G E T Create Endpoint Access
GET_CreateEndpointAccess 14 params → 200480481482483484485486
POST
/#Action=CreateEndpointAccess
Amazon Redshift - P O S T Create Endpoint Access
POST_CreateEndpointAccess 9 params body → 200480481482483484485486
GET
/#Action=CreateEventSubscription
Amazon Redshift - G E T Create Event Subscription
GET_CreateEventSubscription 17 params → 200480481482483484485486
POST
/#Action=CreateEventSubscription
Amazon Redshift - P O S T Create Event Subscription
POST_CreateEventSubscription 9 params body → 200480481482483484485486
GET
/#Action=CreateHsmClientCertificate
Amazon Redshift - G E T Create Hsm Client Certificate
GET_CreateHsmClientCertificate 11 params → 200480481482483
POST
/#Action=CreateHsmClientCertificate
Amazon Redshift - P O S T Create Hsm Client Certificate
POST_CreateHsmClientCertificate 9 params body → 200480481482483
GET
/#Action=CreateHsmConfiguration
Amazon Redshift - G E T Create Hsm Configuration
GET_CreateHsmConfiguration 16 params → 200480481482483
POST
/#Action=CreateHsmConfiguration
Amazon Redshift - P O S T Create Hsm Configuration
POST_CreateHsmConfiguration 9 params body → 200480481482483
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
GET
/#Action=CreateSnapshotCopyGrant
Amazon Redshift - G E T Create Snapshot Copy Grant
GET_CreateSnapshotCopyGrant 12 params → 200480481482483484485
POST
/#Action=CreateSnapshotCopyGrant
Amazon Redshift - P O S T Create Snapshot Copy Grant
POST_CreateSnapshotCopyGrant 9 params body → 200480481482483484485
GET
/#Action=CreateSnapshotSchedule
Amazon Redshift - G E T Create Snapshot Schedule
GET_CreateSnapshotSchedule 15 params → 200480481482483484485
POST
/#Action=CreateSnapshotSchedule
Amazon Redshift - P O S T Create Snapshot Schedule
POST_CreateSnapshotSchedule 9 params body → 200480481482483484485
GET
/#Action=CreateTags
Amazon Redshift - G E T Create Tags
GET_CreateTags 11 params → 200480481482483
POST
/#Action=CreateTags
Amazon Redshift - P O S T Create Tags
POST_CreateTags 9 params body → 200480481482483
GET
/#Action=CreateUsageLimit
Amazon Redshift - G E T Create Usage Limit
GET_CreateUsageLimit 16 params → 200480481482483484485486
POST
/#Action=CreateUsageLimit
Amazon Redshift - P O S T Create Usage Limit
POST_CreateUsageLimit 9 params body → 200480481482483484485486
GET
/#Action=DeauthorizeDataShare
Amazon Redshift - G E T Deauthorize Data Share
GET_DeauthorizeDataShare 11 params → 200480
POST
/#Action=DeauthorizeDataShare
Amazon Redshift - P O S T Deauthorize Data Share
POST_DeauthorizeDataShare 9 params body → 200480
GET
/#Action=DeleteAuthenticationProfile
Amazon Redshift - G E T Delete Authentication Profile
GET_DeleteAuthenticationProfile 10 params → 200480481
POST
/#Action=DeleteAuthenticationProfile
Amazon Redshift - P O S T Delete Authentication Profile
POST_DeleteAuthenticationProfile 9 params body → 200480481
GET
/#Action=DeleteCluster
Amazon Redshift - G E T Delete Cluster
GET_DeleteCluster 13 params → 200480481482483484
POST
/#Action=DeleteCluster
Amazon Redshift - P O S T Delete Cluster
POST_DeleteCluster 9 params body → 200480481482483484
GET
/#Action=DeleteClusterParameterGroup
Amazon Redshift - G E T Delete Cluster Parameter Group
GET_DeleteClusterParameterGroup 10 params → 200480481
POST
/#Action=DeleteClusterParameterGroup
Amazon Redshift - P O S T Delete Cluster Parameter Group
POST_DeleteClusterParameterGroup 9 params body → 200480481
GET
/#Action=DeleteClusterSecurityGroup
Amazon Redshift - G E T Delete Cluster Security Group
GET_DeleteClusterSecurityGroup 10 params → 200480481
POST
/#Action=DeleteClusterSecurityGroup
Amazon Redshift - P O S T Delete Cluster Security Group
POST_DeleteClusterSecurityGroup 9 params body → 200480481
GET
/#Action=DeleteClusterSnapshot
Amazon Redshift - G E T Delete Cluster Snapshot
GET_DeleteClusterSnapshot 11 params → 200480481
POST
/#Action=DeleteClusterSnapshot
Amazon Redshift - P O S T Delete Cluster Snapshot
POST_DeleteClusterSnapshot 9 params body → 200480481
GET
/#Action=DeleteClusterSubnetGroup
Amazon Redshift - G E T Delete Cluster Subnet Group
GET_DeleteClusterSubnetGroup 10 params → 200480481482
POST
/#Action=DeleteClusterSubnetGroup
Amazon Redshift - P O S T Delete Cluster Subnet Group
POST_DeleteClusterSubnetGroup 9 params body → 200480481482
GET
/#Action=DeleteEndpointAccess
Amazon Redshift - G E T Delete Endpoint Access
GET_DeleteEndpointAccess 10 params → 200480481482483484
POST
/#Action=DeleteEndpointAccess
Amazon Redshift - P O S T Delete Endpoint Access
POST_DeleteEndpointAccess 9 params body → 200480481482483484
GET
/#Action=DeleteEventSubscription
Amazon Redshift - G E T Delete Event Subscription
GET_DeleteEventSubscription 10 params → 200480481
POST
/#Action=DeleteEventSubscription
Amazon Redshift - P O S T Delete Event Subscription
POST_DeleteEventSubscription 9 params body → 200480481
GET
/#Action=DeleteHsmClientCertificate
Amazon Redshift - G E T Delete Hsm Client Certificate
GET_DeleteHsmClientCertificate 10 params → 200480481
POST
/#Action=DeleteHsmClientCertificate
Amazon Redshift - P O S T Delete Hsm Client Certificate
POST_DeleteHsmClientCertificate 9 params body → 200480481
GET
/#Action=DeleteHsmConfiguration
Amazon Redshift - G E T Delete Hsm Configuration
GET_DeleteHsmConfiguration 10 params → 200480481
POST
/#Action=DeleteHsmConfiguration
Amazon Redshift - P O S T Delete Hsm Configuration
POST_DeleteHsmConfiguration 9 params body → 200480481
GET
/#Action=DeletePartner
Amazon Redshift - G E T Delete Partner
GET_DeletePartner 13 params → 200480481482
POST
/#Action=DeletePartner
Amazon Redshift - P O S T Delete Partner
POST_DeletePartner 9 params body → 200480481482
GET
/#Action=DeleteScheduledAction
Amazon Redshift - G E T Delete Scheduled Action
GET_DeleteScheduledAction 10 params → 200480481
POST
/#Action=DeleteScheduledAction
Amazon Redshift - P O S T Delete Scheduled Action
POST_DeleteScheduledAction 9 params body → 200480481
GET
/#Action=DeleteSnapshotCopyGrant
Amazon Redshift - G E T Delete Snapshot Copy Grant
GET_DeleteSnapshotCopyGrant 10 params → 200480481
POST
/#Action=DeleteSnapshotCopyGrant
Amazon Redshift - P O S T Delete Snapshot Copy Grant
POST_DeleteSnapshotCopyGrant 9 params body → 200480481
GET
/#Action=DeleteSnapshotSchedule
Amazon Redshift - G E T Delete Snapshot Schedule
GET_DeleteSnapshotSchedule 10 params → 200480481
POST
/#Action=DeleteSnapshotSchedule
Amazon Redshift - P O S T Delete Snapshot Schedule
POST_DeleteSnapshotSchedule 9 params body → 200480481
GET
/#Action=DeleteTags
Amazon Redshift - G E T Delete Tags
GET_DeleteTags 11 params → 200480481
POST
/#Action=DeleteTags
Amazon Redshift - P O S T Delete Tags
POST_DeleteTags 9 params body → 200480481
GET
/#Action=DeleteUsageLimit
Amazon Redshift - G E T Delete Usage Limit
GET_DeleteUsageLimit 10 params → 200480481
POST
/#Action=DeleteUsageLimit
Amazon Redshift - P O S T Delete Usage Limit
POST_DeleteUsageLimit 9 params body → 200480481
GET
/#Action=DescribeAccountAttributes
Amazon Redshift - G E T Describe Account Attributes
GET_DescribeAccountAttributes 10 params → 200
POST
/#Action=DescribeAccountAttributes
Amazon Redshift - P O S T Describe Account Attributes
POST_DescribeAccountAttributes 9 params body → 200
GET
/#Action=DescribeAuthenticationProfiles
Amazon Redshift - G E T Describe Authentication Profiles
GET_DescribeAuthenticationProfiles 10 params → 200480481
POST
/#Action=DescribeAuthenticationProfiles
Amazon Redshift - P O S T Describe Authentication Profiles
POST_DescribeAuthenticationProfiles 9 params body → 200480481
GET
/#Action=DescribeClusterDbRevisions
Amazon Redshift - G E T Describe Cluster Db Revisions
GET_DescribeClusterDbRevisions 12 params → 200480481
POST
/#Action=DescribeClusterDbRevisions
Amazon Redshift - P O S T Describe Cluster Db Revisions
POST_DescribeClusterDbRevisions 11 params body → 200480481
GET
/#Action=DescribeClusterParameterGroups
Amazon Redshift - G E T Describe Cluster Parameter Groups
GET_DescribeClusterParameterGroups 14 params → 200480481
POST
/#Action=DescribeClusterParameterGroups
Amazon Redshift - P O S T Describe Cluster Parameter Groups
POST_DescribeClusterParameterGroups 11 params body → 200480481
GET
/#Action=DescribeClusterParameters
Amazon Redshift - G E T Describe Cluster Parameters
GET_DescribeClusterParameters 13 params → 200480
POST
/#Action=DescribeClusterParameters
Amazon Redshift - P O S T Describe Cluster Parameters
POST_DescribeClusterParameters 11 params body → 200480
GET
/#Action=DescribeClusterSecurityGroups
Amazon Redshift - G E T Describe Cluster Security Groups
GET_DescribeClusterSecurityGroups 14 params → 200480481
POST
/#Action=DescribeClusterSecurityGroups
Amazon Redshift - P O S T Describe Cluster Security Groups
POST_DescribeClusterSecurityGroups 11 params body → 200480481
GET
/#Action=DescribeClusterSnapshots
Amazon Redshift - G E T Describe Cluster Snapshots
GET_DescribeClusterSnapshots 22 params → 200480481482483
POST
/#Action=DescribeClusterSnapshots
Amazon Redshift - P O S T Describe Cluster Snapshots
POST_DescribeClusterSnapshots 11 params body → 200480481482483
GET
/#Action=DescribeClusterSubnetGroups
Amazon Redshift - G E T Describe Cluster Subnet Groups
GET_DescribeClusterSubnetGroups 14 params → 200480481
POST
/#Action=DescribeClusterSubnetGroups
Amazon Redshift - P O S T Describe Cluster Subnet Groups
POST_DescribeClusterSubnetGroups 11 params body → 200480481
GET
/#Action=DescribeClusterTracks
Amazon Redshift - G E T Describe Cluster Tracks
GET_DescribeClusterTracks 12 params → 200480481
POST
/#Action=DescribeClusterTracks
Amazon Redshift - P O S T Describe Cluster Tracks
POST_DescribeClusterTracks 11 params body → 200480481
GET
/#Action=DescribeClusterVersions
Amazon Redshift - G E T Describe Cluster Versions
GET_DescribeClusterVersions 13 params → 200
POST
/#Action=DescribeClusterVersions
Amazon Redshift - P O S T Describe Cluster Versions
POST_DescribeClusterVersions 11 params body → 200
GET
/#Action=DescribeClusters
Amazon Redshift - G E T Describe Clusters
GET_DescribeClusters 14 params → 200480481
POST
/#Action=DescribeClusters
Amazon Redshift - P O S T Describe Clusters
POST_DescribeClusters 11 params body → 200480481
GET
/#Action=DescribeDataShares
Amazon Redshift - G E T Describe Data Shares
GET_DescribeDataShares 12 params → 200480
POST
/#Action=DescribeDataShares
Amazon Redshift - P O S T Describe Data Shares
POST_DescribeDataShares 11 params body → 200480
GET
/#Action=DescribeDataSharesForConsumer
Amazon Redshift - G E T Describe Data Shares for Consumer
GET_DescribeDataSharesForConsumer 13 params → 200480
POST
/#Action=DescribeDataSharesForConsumer
Amazon Redshift - P O S T Describe Data Shares for Consumer
POST_DescribeDataSharesForConsumer 11 params body → 200480
GET
/#Action=DescribeDataSharesForProducer
Amazon Redshift - G E T Describe Data Shares for Producer
GET_DescribeDataSharesForProducer 13 params → 200480
POST
/#Action=DescribeDataSharesForProducer
Amazon Redshift - P O S T Describe Data Shares for Producer
POST_DescribeDataSharesForProducer 11 params body → 200480
GET
/#Action=DescribeDefaultClusterParameters
Amazon Redshift - G E T Describe Default Cluster Parameters
GET_DescribeDefaultClusterParameters 12 params → 200
POST
/#Action=DescribeDefaultClusterParameters
Amazon Redshift - P O S T Describe Default Cluster Parameters
POST_DescribeDefaultClusterParameters 11 params body → 200
GET
/#Action=DescribeEndpointAccess
Amazon Redshift - G E T Describe Endpoint Access
GET_DescribeEndpointAccess 15 params → 200480481482
POST
/#Action=DescribeEndpointAccess
Amazon Redshift - P O S T Describe Endpoint Access
POST_DescribeEndpointAccess 11 params body → 200480481482
GET
/#Action=DescribeEndpointAuthorization
Amazon Redshift - G E T Describe Endpoint Authorization
GET_DescribeEndpointAuthorization 14 params → 200480481
POST
/#Action=DescribeEndpointAuthorization
Amazon Redshift - P O S T Describe Endpoint Authorization
POST_DescribeEndpointAuthorization 11 params body → 200480481
GET
/#Action=DescribeEventCategories
Amazon Redshift - G E T Describe Event Categories
GET_DescribeEventCategories 10 params → 200
POST
/#Action=DescribeEventCategories
Amazon Redshift - P O S T Describe Event Categories
POST_DescribeEventCategories 9 params body → 200
GET
/#Action=DescribeEventSubscriptions
Amazon Redshift - G E T Describe Event Subscriptions
GET_DescribeEventSubscriptions 14 params → 200480481
POST
/#Action=DescribeEventSubscriptions
Amazon Redshift - P O S T Describe Event Subscriptions
POST_DescribeEventSubscriptions 11 params body → 200480481
GET
/#Action=DescribeEvents
Amazon Redshift - G E T Describe Events
GET_DescribeEvents 16 params → 200
POST
/#Action=DescribeEvents
Amazon Redshift - P O S T Describe Events
POST_DescribeEvents 11 params body → 200
GET
/#Action=DescribeHsmClientCertificates
Amazon Redshift - G E T Describe Hsm Client Certificates
GET_DescribeHsmClientCertificates 14 params → 200480481
POST
/#Action=DescribeHsmClientCertificates
Amazon Redshift - P O S T Describe Hsm Client Certificates
POST_DescribeHsmClientCertificates 11 params body → 200480481
GET
/#Action=DescribeHsmConfigurations
Amazon Redshift - G E T Describe Hsm Configurations
GET_DescribeHsmConfigurations 14 params → 200480481
POST
/#Action=DescribeHsmConfigurations
Amazon Redshift - P O S T Describe Hsm Configurations
POST_DescribeHsmConfigurations 11 params body → 200480481
GET
/#Action=DescribeLoggingStatus
Amazon Redshift - G E T Describe Logging Status
GET_DescribeLoggingStatus 10 params → 200480
POST
/#Action=DescribeLoggingStatus
Amazon Redshift - P O S T Describe Logging Status
POST_DescribeLoggingStatus 9 params body → 200480
GET
/#Action=DescribeNodeConfigurationOptions
Amazon Redshift - G E T Describe Node Configuration Options
GET_DescribeNodeConfigurationOptions 17 params → 200480481482483484
POST
/#Action=DescribeNodeConfigurationOptions
Amazon Redshift - P O S T Describe Node Configuration Options
POST_DescribeNodeConfigurationOptions 11 params body → 200480481482483484
GET
/#Action=DescribeOrderableClusterOptions
Amazon Redshift - G E T Describe Orderable Cluster Options
GET_DescribeOrderableClusterOptions 13 params → 200
POST
/#Action=DescribeOrderableClusterOptions
Amazon Redshift - P O S T Describe Orderable Cluster Options
POST_DescribeOrderableClusterOptions 11 params body → 200
GET
/#Action=DescribePartners
Amazon Redshift - G E T Describe Partners
GET_DescribePartners 13 params → 200480481
POST
/#Action=DescribePartners
Amazon Redshift - P O S T Describe Partners
POST_DescribePartners 9 params body → 200480481
GET
/#Action=DescribeReservedNodeExchangeStatus
Amazon Redshift - G E T Describe Reserved Node Exchange Status
GET_DescribeReservedNodeExchangeStatus 13 params → 200480481482
POST
/#Action=DescribeReservedNodeExchangeStatus
Amazon Redshift - P O S T Describe Reserved Node Exchange Status
POST_DescribeReservedNodeExchangeStatus 11 params body → 200480481482
GET
/#Action=DescribeReservedNodeOfferings
Amazon Redshift - G E T Describe Reserved Node Offerings
GET_DescribeReservedNodeOfferings 12 params → 200480481482
POST
/#Action=DescribeReservedNodeOfferings
Amazon Redshift - P O S T Describe Reserved Node Offerings
POST_DescribeReservedNodeOfferings 11 params body → 200480481482
GET
/#Action=DescribeReservedNodes
Amazon Redshift - G E T Describe Reserved Nodes
GET_DescribeReservedNodes 12 params → 200480481
POST
/#Action=DescribeReservedNodes
Amazon Redshift - P O S T Describe Reserved Nodes
POST_DescribeReservedNodes 11 params body → 200480481
GET
/#Action=DescribeResize
Amazon Redshift - G E T Describe Resize
GET_DescribeResize 10 params → 200480481
POST
/#Action=DescribeResize
Amazon Redshift - P O S T Describe Resize
POST_DescribeResize 9 params body → 200480481
GET
/#Action=DescribeScheduledActions
Amazon Redshift - G E T Describe Scheduled Actions
GET_DescribeScheduledActions 17 params → 200480481
POST
/#Action=DescribeScheduledActions
Amazon Redshift - P O S T Describe Scheduled Actions
POST_DescribeScheduledActions 11 params body → 200480481
GET
/#Action=DescribeSnapshotCopyGrants
Amazon Redshift - G E T Describe Snapshot Copy Grants
GET_DescribeSnapshotCopyGrants 14 params → 200480481
POST
/#Action=DescribeSnapshotCopyGrants
Amazon Redshift - P O S T Describe Snapshot Copy Grants
POST_DescribeSnapshotCopyGrants 11 params body → 200480481
GET
/#Action=DescribeSnapshotSchedules
Amazon Redshift - G E T Describe Snapshot Schedules
GET_DescribeSnapshotSchedules 15 params → 200
POST
/#Action=DescribeSnapshotSchedules
Amazon Redshift - P O S T Describe Snapshot Schedules
POST_DescribeSnapshotSchedules 11 params body → 200
GET
/#Action=DescribeStorage
Amazon Redshift - G E T Describe Storage
GET_DescribeStorage 9 params → 200
POST
/#Action=DescribeStorage
Amazon Redshift - P O S T Describe Storage
POST_DescribeStorage 9 params → 200
GET
/#Action=DescribeTableRestoreStatus
Amazon Redshift - G E T Describe Table Restore Status
GET_DescribeTableRestoreStatus 13 params → 200480481
POST
/#Action=DescribeTableRestoreStatus
Amazon Redshift - P O S T Describe Table Restore Status
POST_DescribeTableRestoreStatus 11 params body → 200480481
GET
/#Action=DescribeTags
Amazon Redshift - G E T Describe Tags
GET_DescribeTags 15 params → 200480481
POST
/#Action=DescribeTags
Amazon Redshift - P O S T Describe Tags
POST_DescribeTags 11 params body → 200480481
GET
/#Action=DescribeUsageLimits
Amazon Redshift - G E T Describe Usage Limits
GET_DescribeUsageLimits 16 params → 200480481
POST
/#Action=DescribeUsageLimits
Amazon Redshift - P O S T Describe Usage Limits
POST_DescribeUsageLimits 11 params body → 200480481
GET
/#Action=DisableLogging
Amazon Redshift - G E T Disable Logging
GET_DisableLogging 10 params → 200480481
POST
/#Action=DisableLogging
Amazon Redshift - P O S T Disable Logging
POST_DisableLogging 9 params body → 200480481
GET
/#Action=DisableSnapshotCopy
Amazon Redshift - G E T Disable Snapshot Copy
GET_DisableSnapshotCopy 10 params → 200480481482483
POST
/#Action=DisableSnapshotCopy
Amazon Redshift - P O S T Disable Snapshot Copy
POST_DisableSnapshotCopy 9 params body → 200480481482483
GET
/#Action=DisassociateDataShareConsumer
Amazon Redshift - G E T Disassociate Data Share Consumer
GET_DisassociateDataShareConsumer 13 params → 200480481
POST
/#Action=DisassociateDataShareConsumer
Amazon Redshift - P O S T Disassociate Data Share Consumer
POST_DisassociateDataShareConsumer 9 params body → 200480481
GET
/#Action=EnableLogging
Amazon Redshift - G E T Enable Logging
GET_EnableLogging 14 params → 200480481482483484485
POST
/#Action=EnableLogging
Amazon Redshift - P O S T Enable Logging
POST_EnableLogging 9 params body → 200480481482483484485
GET
/#Action=EnableSnapshotCopy
Amazon Redshift - G E T Enable Snapshot Copy
GET_EnableSnapshotCopy 14 params → 200480481482483484485486
POST
/#Action=EnableSnapshotCopy
Amazon Redshift - P O S T Enable Snapshot Copy
POST_EnableSnapshotCopy 9 params body → 200480481482483484485486
GET
/#Action=GetClusterCredentials
Amazon Redshift - G E T Get Cluster Credentials
GET_GetClusterCredentials 15 params → 200480481
POST
/#Action=GetClusterCredentials
Amazon Redshift - P O S T Get Cluster Credentials
POST_GetClusterCredentials 9 params body → 200480481
GET
/#Action=GetClusterCredentialsWithIAM
Amazon Redshift - G E T Get Cluster Credentials with I a M
GET_GetClusterCredentialsWithIAM 12 params → 200480481
POST
/#Action=GetClusterCredentialsWithIAM
Amazon Redshift - P O S T Get Cluster Credentials with I a M
POST_GetClusterCredentialsWithIAM 9 params body → 200480481
GET
/#Action=GetReservedNodeExchangeConfigurationOptions
Amazon Redshift - G E T Get Reserved Node Exchange Configuration Options
GET_GetReservedNodeExchangeConfigurationOptions 14 params → 200480481482483484485486
POST
/#Action=GetReservedNodeExchangeConfigurationOptions
Amazon Redshift - P O S T Get Reserved Node Exchange Configuration Options
POST_GetReservedNodeExchangeConfigurationOptions 11 params body → 200480481482483484485486
GET
/#Action=GetReservedNodeExchangeOfferings
Amazon Redshift - G E T Get Reserved Node Exchange Offerings
GET_GetReservedNodeExchangeOfferings 12 params → 200480481482483484485
POST
/#Action=GetReservedNodeExchangeOfferings
Amazon Redshift - P O S T Get Reserved Node Exchange Offerings
POST_GetReservedNodeExchangeOfferings 11 params body → 200480481482483484485
GET
/#Action=ModifyAquaConfiguration
Amazon Redshift - G E T Modify Aqua Configuration
GET_ModifyAquaConfiguration 11 params → 200480481482
POST
/#Action=ModifyAquaConfiguration
Amazon Redshift - P O S T Modify Aqua Configuration
POST_ModifyAquaConfiguration 9 params body → 200480481482
GET
/#Action=ModifyAuthenticationProfile
Amazon Redshift - G E T Modify Authentication Profile
GET_ModifyAuthenticationProfile 11 params → 200480481482
POST
/#Action=ModifyAuthenticationProfile
Amazon Redshift - P O S T Modify Authentication Profile
POST_ModifyAuthenticationProfile 9 params body → 200480481482
GET
/#Action=ModifyCluster
Amazon Redshift - G E T Modify Cluster
GET_ModifyCluster 34 params → 200480481482483484485486
POST
/#Action=ModifyCluster
Amazon Redshift - P O S T Modify Cluster
POST_ModifyCluster 9 params body → 200480481482483484485486
GET
/#Action=ModifyClusterDbRevision
Amazon Redshift - G E T Modify Cluster Db Revision
GET_ModifyClusterDbRevision 11 params → 200480481482
POST
/#Action=ModifyClusterDbRevision
Amazon Redshift - P O S T Modify Cluster Db Revision
POST_ModifyClusterDbRevision 9 params body → 200480481482
GET
/#Action=ModifyClusterIamRoles
Amazon Redshift - G E T Modify Cluster Iam Roles
GET_ModifyClusterIamRoles 13 params → 200480481
POST
/#Action=ModifyClusterIamRoles
Amazon Redshift - P O S T Modify Cluster Iam Roles
POST_ModifyClusterIamRoles 9 params body → 200480481
GET
/#Action=ModifyClusterMaintenance
Amazon Redshift - G E T Modify Cluster Maintenance
GET_ModifyClusterMaintenance 15 params → 200480481
POST
/#Action=ModifyClusterMaintenance
Amazon Redshift - P O S T Modify Cluster Maintenance
POST_ModifyClusterMaintenance 9 params body → 200480481
GET
/#Action=ModifyClusterParameterGroup
Amazon Redshift - G E T Modify Cluster Parameter Group
GET_ModifyClusterParameterGroup 11 params → 200480481
POST
/#Action=ModifyClusterParameterGroup
Amazon Redshift - P O S T Modify Cluster Parameter Group
POST_ModifyClusterParameterGroup 9 params body → 200480481
GET
/#Action=ModifyClusterSnapshot
Amazon Redshift - G E T Modify Cluster Snapshot
GET_ModifyClusterSnapshot 12 params → 200480481482
POST
/#Action=ModifyClusterSnapshot
Amazon Redshift - P O S T Modify Cluster Snapshot
POST_ModifyClusterSnapshot 9 params body → 200480481482
GET
/#Action=ModifyClusterSnapshotSchedule
Amazon Redshift - G E T Modify Cluster Snapshot Schedule
GET_ModifyClusterSnapshotSchedule 12 params → 200480481482
POST
/#Action=ModifyClusterSnapshotSchedule
Amazon Redshift - P O S T Modify Cluster Snapshot Schedule
POST_ModifyClusterSnapshotSchedule 9 params body → 200480481482
GET
/#Action=ModifyClusterSubnetGroup
Amazon Redshift - G E T Modify Cluster Subnet Group
GET_ModifyClusterSubnetGroup 12 params → 200480481482483484485
POST
/#Action=ModifyClusterSubnetGroup
Amazon Redshift - P O S T Modify Cluster Subnet Group
POST_ModifyClusterSubnetGroup 9 params body → 200480481482483484485
GET
/#Action=ModifyEndpointAccess
Amazon Redshift - G E T Modify Endpoint Access
GET_ModifyEndpointAccess 11 params → 200480481482483484485
POST
/#Action=ModifyEndpointAccess
Amazon Redshift - P O S T Modify Endpoint Access
POST_ModifyEndpointAccess 9 params body → 200480481482483484485
GET
/#Action=ModifyEventSubscription
Amazon Redshift - G E T Modify Event Subscription
GET_ModifyEventSubscription 16 params → 200480481482483484485486
POST
/#Action=ModifyEventSubscription
Amazon Redshift - P O S T Modify Event Subscription
POST_ModifyEventSubscription 9 params body → 200480481482483484485486
GET
/#Action=ModifyScheduledAction
Amazon Redshift - G E T Modify Scheduled Action
GET_ModifyScheduledAction 17 params → 200480481482483484
POST
/#Action=ModifyScheduledAction
Amazon Redshift - P O S T Modify Scheduled Action
POST_ModifyScheduledAction 9 params body → 200480481482483484
GET
/#Action=ModifySnapshotCopyRetentionPeriod
Amazon Redshift - G E T Modify Snapshot Copy Retention Period
GET_ModifySnapshotCopyRetentionPeriod 12 params → 200480481482483484
POST
/#Action=ModifySnapshotCopyRetentionPeriod
Amazon Redshift - P O S T Modify Snapshot Copy Retention Period
POST_ModifySnapshotCopyRetentionPeriod 9 params body → 200480481482483484
GET
/#Action=ModifySnapshotSchedule
Amazon Redshift - G E T Modify Snapshot Schedule
GET_ModifySnapshotSchedule 11 params → 200480481482
POST
/#Action=ModifySnapshotSchedule
Amazon Redshift - P O S T Modify Snapshot Schedule
POST_ModifySnapshotSchedule 9 params body → 200480481482
GET
/#Action=ModifyUsageLimit
Amazon Redshift - G E T Modify Usage Limit
GET_ModifyUsageLimit 12 params → 200480481482
POST
/#Action=ModifyUsageLimit
Amazon Redshift - P O S T Modify Usage Limit
POST_ModifyUsageLimit 9 params body → 200480481482
GET
/#Action=PauseCluster
Amazon Redshift - G E T Pause Cluster
GET_PauseCluster 10 params → 200480481
POST
/#Action=PauseCluster
Amazon Redshift - P O S T Pause Cluster
POST_PauseCluster 9 params body → 200480481
GET
/#Action=PurchaseReservedNodeOffering
Amazon Redshift - G E T Purchase Reserved Node Offering
GET_PurchaseReservedNodeOffering 11 params → 200480481482483
POST
/#Action=PurchaseReservedNodeOffering
Amazon Redshift - P O S T Purchase Reserved Node Offering
POST_PurchaseReservedNodeOffering 9 params body → 200480481482483
GET
/#Action=RebootCluster
Amazon Redshift - G E T Reboot Cluster
GET_RebootCluster 10 params → 200480481
POST
/#Action=RebootCluster
Amazon Redshift - P O S T Reboot Cluster
POST_RebootCluster 9 params body → 200480481
GET
/#Action=RejectDataShare
Amazon Redshift - G E T Reject Data Share
GET_RejectDataShare 10 params → 200480
POST
/#Action=RejectDataShare
Amazon Redshift - P O S T Reject Data Share
POST_RejectDataShare 9 params body → 200480
GET
/#Action=ResetClusterParameterGroup
Amazon Redshift - G E T Reset Cluster Parameter Group
GET_ResetClusterParameterGroup 12 params → 200480481
POST
/#Action=ResetClusterParameterGroup
Amazon Redshift - P O S T Reset Cluster Parameter Group
POST_ResetClusterParameterGroup 9 params body → 200480481
GET
/#Action=ResizeCluster
Amazon Redshift - G E T Resize Cluster
GET_ResizeCluster 16 params → 200480481482483484485486
POST
/#Action=ResizeCluster
Amazon Redshift - P O S T Resize Cluster
POST_ResizeCluster 9 params body → 200480481482483484485486
GET
/#Action=RestoreFromClusterSnapshot
Amazon Redshift - G E T Restore from Cluster Snapshot
GET_RestoreFromClusterSnapshot 42 params → 200480481482483484485486
POST
/#Action=RestoreFromClusterSnapshot
Amazon Redshift - P O S T Restore from Cluster Snapshot
POST_RestoreFromClusterSnapshot 9 params body → 200480481482483484485486
GET
/#Action=RestoreTableFromClusterSnapshot
Amazon Redshift - G E T Restore Table from Cluster Snapshot
GET_RestoreTableFromClusterSnapshot 18 params → 200480481482483484485486
POST
/#Action=RestoreTableFromClusterSnapshot
Amazon Redshift - P O S T Restore Table from Cluster Snapshot
POST_RestoreTableFromClusterSnapshot 9 params body → 200480481482483484485486
GET
/#Action=ResumeCluster
Amazon Redshift - G E T Resume Cluster
GET_ResumeCluster 10 params → 200480481482
POST
/#Action=ResumeCluster
Amazon Redshift - P O S T Resume Cluster
POST_ResumeCluster 9 params body → 200480481482
GET
/#Action=RevokeClusterSecurityGroupIngress
Amazon Redshift - G E T Revoke Cluster Security Group Ingress
GET_RevokeClusterSecurityGroupIngress 13 params → 200480481482
POST
/#Action=RevokeClusterSecurityGroupIngress
Amazon Redshift - P O S T Revoke Cluster Security Group Ingress
POST_RevokeClusterSecurityGroupIngress 9 params body → 200480481482
GET
/#Action=RevokeEndpointAccess
Amazon Redshift - G E T Revoke Endpoint Access
GET_RevokeEndpointAccess 13 params → 200480481482483484485486
POST
/#Action=RevokeEndpointAccess
Amazon Redshift - P O S T Revoke Endpoint Access
POST_RevokeEndpointAccess 9 params body → 200480481482483484485486
GET
/#Action=RevokeSnapshotAccess
Amazon Redshift - G E T Revoke Snapshot Access
GET_RevokeSnapshotAccess 13 params → 200480481482483
POST
/#Action=RevokeSnapshotAccess
Amazon Redshift - P O S T Revoke Snapshot Access
POST_RevokeSnapshotAccess 9 params body → 200480481482483
GET
/#Action=RotateEncryptionKey
Amazon Redshift - G E T Rotate Encryption Key
GET_RotateEncryptionKey 10 params → 200480481482
POST
/#Action=RotateEncryptionKey
Amazon Redshift - P O S T Rotate Encryption Key
POST_RotateEncryptionKey 9 params body → 200480481482
GET
/#Action=UpdatePartnerStatus
Amazon Redshift - G E T Update Partner Status
GET_UpdatePartnerStatus 15 params → 200480481482
POST
/#Action=UpdatePartnerStatus
Amazon Redshift - P O S T Update Partner Status
POST_UpdatePartnerStatus 9 params body → 200480481482

Schemas 527

The contract defines 527 schemas that model the data the API accepts and returns. The most detailed are Cluster (52 properties), CreateClusterMessage (34 properties), Snapshot (34 properties), RestoreFromClusterSnapshotMessage (33 properties). Each schema is shown below with its type and property counts.

DeleteClusterSnapshotResult
object
1 property
GetReservedNodeExchangeConfigurationOptionsOutputMessage
object
2 properties
DeleteSnapshotCopyGrantMessage
object
The result of the DeleteSnapshotCopyGrant action.
1 property 1 required
DisableSnapshotCopyMessage
object
1 property 1 required
NodeConfigurationOptionsFilter
object
A set of elements to filter the returned node configurations.
3 properties
DescribeDataSharesMessage
object
3 properties
UsageLimit
object
Describes a usage limit object for a cluster.
8 properties
ModifyEndpointAccessMessage
object
2 properties 1 required
MaintenanceTrack
object
Defines a maintenance track that determines which Amazon Redshift version to apply during a maintenance window. If the value for MaintenanceTrack is current ,…
3 properties
UsageLimitNotFoundFault
ModifyClusterDbRevisionResult
object
1 property
EventCategoriesMapList
array
VpcEndpointsList
array
ScheduleDefinitionList
array
ClusterSecurityGroupNotFoundFault
DescribeLoggingStatusMessage
object
1 property 1 required
DescribePartnersOutputMessage
object
1 property
InvalidSnapshotCopyGrantStateFault
EndpointsPerClusterLimitExceededFault
SnapshotCopyAlreadyDisabledFault
TableRestoreStatusType
string
UnauthorizedPartnerIntegrationFault
ScheduledActionTimeList
array
ClusterParameterGroupNameMessage
object
2 properties
AuthenticationProfile
object
Describes an authentication profile.
2 properties
SnapshotErrorMessage
object
Describes the errors returned by a snapshot.
4 properties
EnableSnapshotCopyMessage
object
5 properties 2 required
Snapshot
object
Describes a snapshot.
34 properties
ClusterSubnetGroupMessage
object
Contains the output from the DescribeClusterSubnetGroups action.
2 properties
DescribeClusterDbRevisionsMessage
object
3 properties
PartnerIntegrationInfo
object
Describes a partner integration.
6 properties
Subnet
object
Describes a subnet.
3 properties
GetReservedNodeExchangeOfferingsOutputMessage
object
2 properties
ClusterSecurityGroupNameList
array
SnapshotScheduleList
array
DescribeUsageLimitsMessage
object
7 properties
CreateClusterSecurityGroupResult
object
1 property
CancelResizeMessage
object
1 property 1 required
InvalidVPCNetworkStateFault
BooleanOptional
boolean
SnapshotIdentifierList
array
ClusterParameterGroupNotFoundFault
InvalidSubnet
ScheduledActionType
object
The action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler.
3 properties
ClusterDbRevisionsMessage
object
2 properties
InvalidReservedNodeStateFault
BatchModifyClusterSnapshotsOutputMessage
object
2 properties
PartnerIntegrationDatabaseName
string
ScheduledActionTypeUnsupportedFault
CreateSnapshotCopyGrantMessage
object
The result of the CreateSnapshotCopyGrant action.
3 properties 1 required
SNSInvalidTopicFault
DescribeOrderableClusterOptionsMessage
object
4 properties
TableRestoreNotFoundFault
ModifyClusterSubnetGroupMessage
object
3 properties 2 required
RevokeClusterSecurityGroupIngressResult
object
1 property
DataShareStatusForConsumer
string
AuthorizationQuotaExceededFault
DescribeReservedNodeOfferingsMessage
object
3 properties
TrackListMessage
object
2 properties
ReservedNodeExchangeNotFoundFault
AccountAttribute
object
A name value pair that describes an aspect of an account.
2 properties
ModifyClusterParameterGroupMessage
object
Describes a modify cluster parameter group operation.
2 properties 2 required
EventCategoriesList
array
CreateClusterParameterGroupResult
object
1 property
RevokeSnapshotAccessResult
object
1 property
ResizeInfo
object
Describes a resize operation.
2 properties
SNSNoAuthorizationFault
DeleteClusterSubnetGroupMessage
object
1 property 1 required
UnknownSnapshotCopyRegionFault
ClusterNode
object
The identifier of a node in a cluster.
3 properties
ScheduledActionFilter
object
A set of elements to filter the returned scheduled actions.
2 properties 2 required
SnapshotMessage
object
Contains the output from the DescribeClusterSnapshots action.
2 properties
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
PartnerIntegrationClusterIdentifier
string
SubscriptionAlreadyExistFault
RestoreTableFromClusterSnapshotResult
object
1 property
LogDestinationType
string
PartnerIntegrationInputMessage
object
4 properties 4 required
ScheduleDefinitionTypeUnsupportedFault
TagLimitExceededFault
ModifyClusterMessage
object
25 properties 1 required
DoubleOptional
number
EndpointAuthorizationList
object
2 properties
HsmStatus
object
Describes the status of changes to HSM settings.
3 properties
DeleteClusterSnapshotMessageList
array
DescribeDataSharesResult
object
2 properties
DescribeSnapshotCopyGrantsMessage
object
The result of the DescribeSnapshotCopyGrants action.
5 properties
DeleteScheduledActionMessage
object
1 property 1 required
EndpointAccesses
array
CreateSnapshotScheduleMessage
object
6 properties
BatchModifyClusterSnapshotsMessage
object
3 properties 1 required
DeleteSnapshotScheduleMessage
object
1 property 1 required
ClusterSecurityGroupQuotaExceededFault
SupportedOperation
object
Describes the operations that are allowed on a maintenance track.
1 property
VpcSecurityGroupMembership
object
Describes the members of a VPC security group.
2 properties
RevokeEndpointAccessMessage
object
4 properties
DescribeDefaultClusterParametersResult
object
1 property
RebootClusterResult
object
1 property
ReservedNodeNotFoundFault
DescribeClustersMessage
object
5 properties
SubnetList
array
ModifySnapshotCopyRetentionPeriodMessage
object
3 properties 2 required
NumberOfNodesPerClusterLimitExceededFault
AccountsWithRestoreAccessList
array
LoggingStatus
object
Describes the status of logging for a cluster.
8 properties
RecurringChargeList
array
UsageLimitPeriod
string
UsageLimitFeatureType
string
SourceIdsList
array
AvailabilityZone
object
Describes an availability zone.
2 properties
BatchSnapshotOperationErrorList
array
VpcSecurityGroupMembershipList
array
ClusterVersionsMessage
object
Contains the output from the DescribeClusterVersions action.
2 properties
CreateSnapshotCopyGrantResult
object
1 property
ReservedNodeOfferingType
string
DescribeClusterTracksMessage
object
3 properties
InvalidEndpointStateFault
AquaConfigurationStatus
string
HsmConfigurationNotFoundFault
ResourceNotFoundFault
PurchaseReservedNodeOfferingResult
object
1 property
ModifyClusterIamRolesMessage
object
4 properties 1 required
Double
number
InvalidClusterTrackFault
TableRestoreStatusList
array
DataShare
object
5 properties
EndpointAccessList
object
2 properties
OrderableClusterOptionsMessage
object
Contains the output from the DescribeOrderableClusterOptions action.
2 properties
InvalidHsmConfigurationStateFault
ClusterAlreadyExistsFault
DescribeEventSubscriptionsMessage
object
5 properties
ClusterSubnetGroup
object
Describes a subnet group.
6 properties
AuthorizeClusterSecurityGroupIngressMessage
object
4 properties 1 required
InvalidClusterStateFault
DescribeReservedNodeExchangeStatusInputMessage
object
4 properties
InsufficientS3BucketPolicyFault
DescribeClusterVersionsMessage
object
4 properties
DescribeDataSharesForConsumerMessage
object
4 properties
InvalidNamespaceFault
ModifyClusterSnapshotMessage
object
3 properties 1 required
ReservedNode
object
Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.
13 properties
ModifyEventSubscriptionResult
object
1 property
DataShareStatusForProducer
string
InvalidHsmClientCertificateStateFault
Boolean
boolean
SnapshotCopyGrantMessage
object
2 properties
DeleteHsmConfigurationMessage
object
1 property 1 required
ClusterParameterGroupStatusList
array
LongOptional
integer
ClusterParameterGroupsMessage
object
Contains the output from the DescribeClusterParameterGroups action.
2 properties
EndpointAuthorizations
array
CreateHsmConfigurationResult
object
1 property
EndpointAuthorizationAlreadyExistsFault
DescribeEventsMessage
object
7 properties
InvalidClusterParameterGroupStateFault
DescribeDataSharesForConsumerResult
object
2 properties
HsmConfigurationMessage
object
2 properties
IPRange
object
Describes an IP range used in a security group.
3 properties
RestoreFromClusterSnapshotResult
object
1 property
ClusterSecurityGroupMembership
object
Describes a cluster security group.
2 properties
ClusterSubnetGroupQuotaExceededFault
AuthenticationProfileAlreadyExistsFault
SnapshotCopyDisabledFault
NodeConfigurationOptionsFilterName
string
ActionType
string
SnapshotCopyGrantAlreadyExistsFault
HsmClientCertificate
object
Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift clust…
3 properties
DescribeClusterParametersMessage
object
4 properties 1 required
NumberOfNodesQuotaExceededFault
DeleteEndpointAccessMessage
object
1 property 1 required
AttributeList
array
AuthorizationAlreadyExistsFault
UpdatePartnerStatusInputMessage
object
6 properties 5 required
NetworkInterfaceList
array
ClusterSecurityGroup
object
Describes a security group.
5 properties
PartnerIntegrationAccountId
string
DescribeResizeMessage
object
1 property 1 required
RestorableNodeTypeList
array
IPRangeList
array
ClusterSnapshotAlreadyExistsFault
AuthorizeSnapshotAccessMessage
object
4 properties 1 required
EventCategoriesMessage
object
1 property
EventSubscriptionsList
array
CreateEventSubscriptionMessage
object
8 properties 2 required
SnapshotCopyGrantNotFoundFault
SnapshotList
array
ResizeProgressMessage
object
Describes the result of a cluster resize operation.
16 properties
InvalidRestoreFault
ClusterOnLatestRevisionFault
InvalidClusterSnapshotScheduleStateFault
IntegerOptional
integer
ParametersList
array
DescribeTableRestoreStatusMessage
object
4 properties
SnapshotScheduleNotFoundFault
ScheduledActionNotFoundFault
ReservedNodeConfigurationOption
object
Details for a reserved-node exchange. Examples include the node type for a reserved node, the price for a node, the node's state, and other details.
3 properties
ClusterSecurityGroups
array
AssociatedClusterList
array
EventsMessage
object
2 properties
VpcIdentifierList
array
AccountWithRestoreAccess
object
Describes an Amazon Web Services account authorized to restore a snapshot.
2 properties
AccountAttributeList
object
1 property
ReservedNodeOffering
object
Describes a reserved node offering.
9 properties
AttributeNameList
array
ClusterSecurityGroupMessage
object
2 properties
ModifyClusterMaintenanceResult
object
1 property
EnableSnapshotCopyResult
object
1 property
UsageLimitList
object
2 properties
SnapshotSortingEntity
object
Describes a sorting entity
2 properties 1 required
GetReservedNodeExchangeOfferingsInputMessage
object
3 properties 1 required
RestoreTableFromClusterSnapshotMessage
object
9 properties 5 required
InvalidAuthenticationProfileRequestFault
ImportTablesCompleted
array
ClusterParameterGroupQuotaExceededFault
PartnerNotFoundFault
Endpoint
object
Describes a connection endpoint.
3 properties
ClusterList
array
HsmClientCertificateQuotaExceededFault
HsmConfiguration
object
Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM…
5 properties
DeleteClusterSnapshotMessage
object
2 properties 1 required
DescribeEndpointAccessMessage
object
6 properties
PartnerIntegrationInfoList
array
DescribeEventCategoriesMessage
object
1 property
AuthenticationProfileList
array
BatchDeleteRequestSizeExceededFault
InvalidClusterSecurityGroupStateFault
ClusterParameterGroupStatus
object
Describes the status of a parameter group.
3 properties
RecurringCharge
object
Describes a recurring charge.
2 properties
ClusterNodesList
array
VpcSecurityGroupIdList
array
UnsupportedOptionFault
ClusterVersionList
array
UsageLimitAlreadyExistsFault
OrderableClusterOption
object
Describes an orderable cluster option.
4 properties
DescribeSnapshotSchedulesOutputMessage
object
2 properties
DescribeClusterSubnetGroupsMessage
object
5 properties
CreateHsmClientCertificateResult
object
1 property
DataShareStatus
string
CopyToRegionDisabledFault
ClusterParameterGroupDetails
object
Contains the output from the DescribeClusterParameters action.
2 properties
InvalidClusterSnapshotStateFault
UsageLimitBreachAction
string
Cluster
object
Describes a cluster.
52 properties
ClusterSubnetQuotaExceededFault
DeferredMaintenanceWindowsList
array
DescribeDataSharesForProducerMessage
object
4 properties
ClusterSnapshotCopyStatus
object
Returns the destination region and retention period that are configured for cross-region snapshot copy.
4 properties
TaggedResource
object
A tag and its associated resource.
3 properties
DeauthorizeDataShareMessage
object
2 properties 2 required
DisableSnapshotCopyResult
object
1 property
EventInfoMapList
array
ModifySnapshotScheduleMessage
object
2 properties 2 required
CreateClusterParameterGroupMessage
object
4 properties 3 required
ModifyClusterResult
object
1 property
PartnerIntegrationStatus
string
SNSTopicArnNotFoundFault
ClusterNotFoundFault
InvalidDataShareFault
BatchModifyClusterSnapshotsLimitExceededFault
ClusterSubnetGroupAlreadyExistsFault
ImportTablesNotStarted
array
BatchSnapshotOperationErrors
array
CreateScheduledActionMessage
object
8 properties 4 required
AuthorizeClusterSecurityGroupIngressResult
object
1 property
LimitExceededFault
CreateHsmConfigurationMessage
object
7 properties 6 required
ReservedNodeExchangeActionType
string
ClusterIamRoleList
array
EC2SecurityGroup
object
Describes an Amazon EC2 security group.
4 properties
ModifyClusterSnapshotResult
object
1 property
ValueStringList
array
DescribeTagsMessage
object
6 properties
InvalidUsageLimitFault
HsmConfigurationAlreadyExistsFault
TaggedResourceListMessage
object
2 properties
AquaConfiguration
object
The operation that uses this structure is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
2 properties
BatchDeleteClusterSnapshotsResult
object
2 properties
ModifyClusterSubnetGroupResult
object
1 property
UpdateTarget
object
A maintenance track that you can switch the current track to.
3 properties
Parameter
object
Describes a parameter in a cluster parameter group.
9 properties
ClusterSubnetGroups
array
AcceptReservedNodeExchangeInputMessage
object
2 properties 2 required
AttributeValueList
array
AuthorizeDataShareMessage
object
2 properties 2 required
ReservedNodeExchangeStatus
object
Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other detail…
9 properties
CreateClusterSecurityGroupMessage
object
3 properties 2 required
UsageLimits
array
HsmClientCertificateAlreadyExistsFault
InvalidScheduledActionFault
LogTypeList
array
AuthenticationProfileNotFoundFault
GetClusterCredentialsMessage
object
The request parameters to get cluster credentials.
6 properties 2 required
AuthorizeSnapshotAccessResult
object
1 property
ClusterParameterStatusList
array
DeferredMaintenanceWindow
object
Describes a deferred maintenance window
3 properties
AcceptReservedNodeExchangeOutputMessage
object
1 property
EventSubscriptionsMessage
object
2 properties
ScheduledActionsMessage
object
2 properties
EventInfoMap
object
Describes event information.
4 properties
InvalidAuthorizationStateFault
CreateUsageLimitMessage
object
7 properties 4 required
CreateTagsMessage
object
Contains the output from the CreateTags action.
2 properties 2 required
ClusterSubnetGroupNotFoundFault
DeleteAuthenticationProfileMessage
object
1 property 1 required
DataShareList
array
DescribeNodeConfigurationOptionsMessage
object
8 properties 1 required
SortByOrder
string
DeleteAuthenticationProfileResult
object
1 property
DescribeClusterSnapshotsMessage
object
13 properties
ScheduledActionQuotaExceededFault
ScheduledActionFilterName
string
ScheduledActionTypeValues
string
EventSubscription
object
Describes event subscriptions.
11 properties
ModifyUsageLimitMessage
object
3 properties 1 required
ParameterApplyType
string
RestoreFromClusterSnapshotMessage
object
33 properties 1 required
NodeConfigurationOptionsMessage
object
2 properties
Tag
object
A tag consisting of a name/value pair for a resource.
2 properties
DescribeClusterSecurityGroupsMessage
object
5 properties
ElasticIpStatus
object
Describes the status of the elastic IP (EIP) address.
2 properties
String
string
RevokeSnapshotAccessMessage
object
4 properties 1 required
ReservedNodeOfferingNotFoundFault
EndpointAuthorizationsPerClusterLimitExceededFault
ReservedNodesMessage
object
2 properties
IamRoleArnList
array
DeleteTagsMessage
object
Contains the output from the DeleteTags action.
2 properties 2 required
DescribeDataSharesForProducerResult
object
2 properties
SubscriptionCategoryNotFoundFault
SensitiveString
string
Integer
integer
SupportedPlatform
object
A list of supported platforms for orderable clusters.
1 property
RestoreStatus
object
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
6 properties
EventList
array
ScheduledActionAlreadyExistsFault
ResizeClusterResult
object
1 property
UsageLimitLimitType
string
AvailabilityZoneList
array
ClusterSnapshotNotFoundFault
GetClusterCredentialsWithIAMMessage
object
3 properties 1 required
InvalidClusterSubnetGroupStateFault
CopyClusterSnapshotMessage
object
4 properties 2 required
AuthenticationProfileQuotaExceededFault
ScheduledSnapshotTimeList
array
DescribeScheduledActionsMessage
object
8 properties
DisassociateDataShareConsumerMessage
object
4 properties 1 required
DescribeReservedNodesMessage
object
3 properties
AssociateDataShareConsumerMessage
object
4 properties 1 required
CopyClusterSnapshotResult
object
1 property
ModifySnapshotCopyRetentionPeriodResult
object
1 property
ReservedNodeExchangeStatusList
array
SourceType
string
UnsupportedOperationFault
ReservedNodeExchangeStatusType
string
TagList
array
PartnerIntegrationOutputMessage
object
2 properties
ModifyClusterIamRolesResult
object
1 property
AuthorizationStatus
string
CreateClusterSubnetGroupMessage
object
4 properties 3 required
ScheduledActionFilterList
array
VpcEndpoint
object
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
3 properties
SubnetIdentifierList
array
InvalidSubscriptionStateFault
DescribePartnersInputMessage
object
4 properties 2 required
TableRestoreStatus
object
Describes the status of a RestoreTableFromClusterSnapshot operation.
14 properties
DeleteHsmClientCertificateMessage
object
1 property 1 required
EndpointAuthorizationNotFoundFault
DependentServiceUnavailableFault
EndpointsPerAuthorizationLimitExceededFault
CreateClusterSnapshotMessage
object
4 properties 2 required
DescribeAuthenticationProfilesMessage
object
1 property
SnapshotCopyGrant
object
The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified encrypted symmetric key from Amazon Web Services…
3 properties
PendingActionsList
array
AccessToSnapshotDeniedFault
NodeConfigurationOptionList
array
DeleteUsageLimitMessage
object
1 property 1 required
DeleteClusterResult
object
1 property
CreateClusterSnapshotResult
object
1 property
CreateAuthenticationProfileMessage
object
2 properties 2 required
ClusterSecurityGroupAlreadyExistsFault
ClusterSecurityGroupMembershipList
array
ResumeClusterResult
object
1 property
IncompatibleOrderableOptions
DataShareAssociation
object
The association of a datashare from a producer account with a data consumer.
5 properties
HsmClientCertificateList
array
ModifyAquaOutputMessage
object
1 property
EndpointAuthorization
object
Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across Amazon Web Services accounts.
9 properties
InProgressTableRestoreQuotaExceededFault
ParameterGroupList
array
DataTransferProgress
object
Describes the status of a cluster while it is in the process of resizing with an incremental resize.
6 properties
ImportTablesInProgress
array
EC2SecurityGroupList
array
SnapshotScheduleAlreadyExistsFault
ClusterParameterStatus
object
Describes the status of a parameter group.
3 properties
UnauthorizedOperation
RevisionTargetsList
array
CustomerStorageMessage
object
2 properties
DescribeSnapshotSchedulesMessage
object
6 properties
SnapshotCopyAlreadyEnabledFault
DeleteClusterMessage
object
4 properties 1 required
AuthorizeEndpointAccessMessage
object
3 properties 1 required
CreateHsmClientCertificateMessage
object
2 properties 1 required
InvalidRetentionPeriodFault
SourceNotFoundFault
EndpointAlreadyExistsFault
ReservedNodeAlreadyExistsFault
BatchDeleteClusterSnapshotsRequest
object
1 property 1 required
TaggedResourceList
array
DescribeAccountAttributesMessage
object
1 property
SubscriptionEventIdNotFoundFault
InvalidS3KeyPrefixFault
RebootClusterMessage
object
1 property 1 required
SnapshotScheduleUpdateInProgressFault
HsmClientCertificateNotFoundFault
Long
integer
DeleteClusterSecurityGroupMessage
object
1 property 1 required
SupportedOperationList
array
SnapshotSortingEntityList
array
TStamp
string
HsmConfigurationList
array
DataShareAssociationList
array
DescribeAuthenticationProfilesResult
object
1 property
PartnerIntegrationStatusMessage
string
SubscriptionSeverityNotFoundFault
ReservedNodeAlreadyMigratedFault
ReservedNodeConfigurationOptionList
array
DescribeClusterParameterGroupsMessage
object
5 properties
ReservedNodeOfferingList
array
DisableLoggingMessage
object
1 property 1 required
BucketNotFoundFault
NodeConfigurationOptionsFilterList
array
ModifyClusterSnapshotScheduleMessage
object
3 properties 1 required
PurchaseReservedNodeOfferingMessage
object
2 properties 1 required
TableLimitExceededFault
DescribeDefaultClusterParametersMessage
object
3 properties 1 required
ClusterIamRole
object
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
2 properties
InvalidScheduleFault
ClusterAssociatedToSchedule
object
2 properties
DescribeReservedNodeExchangeStatusOutputMessage
object
2 properties
DescribeHsmConfigurationsMessage
object
5 properties
InsufficientClusterCapacityFault
DeleteClusterParameterGroupMessage
object
1 property 1 required
NodeConfigurationOption
object
A list of node configurations.
4 properties
ClusterDbRevisionsList
array
DbGroupList
array
CreateAuthenticationProfileResult
object
2 properties
EventCategoriesMap
object
Describes event categories.
2 properties
EndpointAccess
object
Describes a Redshift-managed VPC endpoint.
10 properties
HsmClientCertificateMessage
object
2 properties
TrackList
array
NetworkInterface
object
Describes a network interface.
4 properties
ClusterCredentials
object
Temporary credentials with authorization to log on to an Amazon Redshift database.
3 properties
CreateClusterResult
object
1 property
ModifyAuthenticationProfileResult
object
2 properties
SnapshotAttributeToSortBy
string
AuthenticationProfileNameString
string
PartnerIntegrationPartnerName
string
PauseClusterResult
object
1 property
EligibleTracksToUpdateList
array
GetReservedNodeExchangeConfigurationOptionsInputMessage
object
5 properties 1 required
CreateEventSubscriptionResult
object
1 property
ModifyEventSubscriptionMessage
object
7 properties 1 required
RevokeClusterSecurityGroupIngressMessage
object
4 properties 1 required
InvalidTagFault
SubnetAlreadyInUse
InvalidElasticIpFault
PauseClusterMessage
object
Describes a pause cluster operation. For example, a scheduled action to run the PauseCluster API operation.
1 property 1 required
ResumeClusterMessage
object
Describes a resume cluster operation. For example, a scheduled action to run the ResumeCluster API operation.
1 property 1 required
RejectDataShareMessage
object
1 property 1 required
AquaStatus
string
CreateClusterSubnetGroupResult
object
1 property
SubscriptionNotFoundFault
DescribeEndpointAuthorizationMessage
object
5 properties
RevisionTarget
object
Describes a RevisionTarget .
3 properties
InvalidS3BucketNameFault
SnapshotSchedule
object
Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates.
7 properties
ScheduledActionList
array
ClusterVersion
object
Describes a cluster version, including the parameter group family and description of the version.
3 properties
Event
object
Describes an event.
7 properties
HsmConfigurationQuotaExceededFault
ClustersMessage
object
Contains the output from the DescribeClusters action.
2 properties
AccessToClusterDeniedFault
DefaultClusterParameters
object
Describes the default cluster parameters for a parameter group family.
3 properties
SupportedPlatformsList
array
SnapshotCopyGrantQuotaExceededFault
ClusterDbRevision
object
Describes a ClusterDbRevision .
4 properties
ClusterParameterGroup
object
Describes a parameter group.
4 properties
Mode
string
ResetClusterParameterGroupMessage
object
3 properties 1 required
TagValueList
array
ModifyClusterDbRevisionMessage
object
2 properties 2 required
ReservedNodeOfferingsMessage
object
2 properties
OperatorType
string
SnapshotCopyGrantList
array
OrderableClusterOptionsList
array
SnapshotScheduleQuotaExceededFault
ModifyAquaInputMessage
object
2 properties 1 required
EventSubscriptionQuotaExceededFault
ClusterQuotaExceededFault
InvalidClusterSubnetStateFault
ModifyAuthenticationProfileMessage
object
2 properties 2 required
ModifyClusterMaintenanceMessage
object
6 properties 1 required
AuthorizationNotFoundFault
CreateClusterMessage
object
34 properties 4 required
ResizeClusterMessage
object
Describes a resize cluster operation. For example, a scheduled action to run the ResizeCluster API operation.
7 properties 1 required
ScheduledActionState
string
InvalidTableRestoreArgumentFault
TableRestoreStatusMessage
object
2 properties
ClusterSnapshotQuotaExceededFault
ModifyScheduledActionMessage
object
8 properties 1 required
ResizeNotFoundFault
DeleteEventSubscriptionMessage
object
1 property 1 required
ScheduleState
string
RotateEncryptionKeyMessage
object
1 property 1 required
RotateEncryptionKeyResult
object
1 property
TagKeyList
array
ClusterParameterGroupAlreadyExistsFault
ReservedNodeQuotaExceededFault
EndpointNotFoundFault
ReservedNodeList
array
AttributeValueTarget
object
Describes an attribute value.
1 property
DescribeHsmClientCertificatesMessage
object
5 properties
CreateEndpointAccessMessage
object
5 properties 2 required
EnableLoggingMessage
object
5 properties 1 required
ClusterExtendedCredentials
object
4 properties
DependentServiceRequestThrottlingFault
PendingModifiedValues
object
Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-redshift-amazon-redshift-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of AWS Redshift Amazon Redshift API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.