AWS Redshift #Action=ModifyCluster 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=ModifyCluster. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
2 operations
across 1 path,
and defines 69 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 operations1 paths69 schemas1 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
AWS Redshift #Action=ModifyCluster 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.
The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are Cluster (52 properties), ModifyClusterMessage (25 properties), PendingModifiedValues (11 properties), ReservedNodeExchangeStatus (9 properties). Each schema is shown below with its type and property counts.
ScheduleState
string
NetworkInterface
object
Describes a network interface.
4 properties
HsmClientCertificateNotFoundFault
PendingActionsList
array
ClusterParameterStatus
object
Describes the status of a parameter group.
3 properties
Tag
object
A tag consisting of a name/value pair for a resource.
2 properties
BooleanOptional
boolean
ReservedNodeExchangeStatusType
string
Double
number
TStamp
string
VpcEndpointsList
array
InvalidElasticIpFault
NumberOfNodesPerClusterLimitExceededFault
Integer
integer
ClusterSecurityGroupMembershipList
array
AquaConfiguration
object
The operation that uses this structure is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
2 properties
InsufficientClusterCapacityFault
String
string
TagList
array
DeferredMaintenanceWindowsList
array
UnauthorizedOperation
HsmStatus
object
Describes the status of changes to HSM settings.
3 properties
AquaConfigurationStatus
string
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
ClusterParameterGroupStatus
object
Describes the status of a parameter group.
3 properties
DoubleOptional
number
ClusterSecurityGroupMembership
object
Describes a cluster security group.
2 properties
HsmConfigurationNotFoundFault
ResizeInfo
object
Describes a resize operation.
2 properties
ClusterAlreadyExistsFault
ClusterSecurityGroupNameList
array
VpcSecurityGroupIdList
array
Endpoint
object
Describes a connection endpoint.
3 properties
AquaStatus
string
NumberOfNodesQuotaExceededFault
RestoreStatus
object
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
6 properties
ClusterParameterGroupStatusList
array
ClusterSecurityGroupNotFoundFault
Cluster
object
Describes a cluster.
52 properties
NetworkInterfaceList
array
ClusterIamRoleList
array
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
UnsupportedOptionFault
VpcEndpoint
object
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
3 properties
InvalidClusterStateFault
ClusterParameterGroupNotFoundFault
ClusterSnapshotCopyStatus
object
Returns the destination region and retention period that are configured for cross-region snapshot copy.
4 properties
ClusterNodesList
array
TableLimitExceededFault
ClusterNode
object
The identifier of a node in a cluster.
3 properties
InvalidClusterTrackFault
DependentServiceRequestThrottlingFault
Boolean
boolean
ModifyClusterResult
object
1 property
VpcSecurityGroupMembership
object
Describes the members of a VPC security group.
2 properties
InvalidClusterSecurityGroupStateFault
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
IntegerOptional
integer
ElasticIpStatus
object
Describes the status of the elastic IP (EIP) address.
2 properties
VpcSecurityGroupMembershipList
array
ClusterParameterStatusList
array
Long
integer
InvalidRetentionPeriodFault
LimitExceededFault
LongOptional
integer
DeferredMaintenanceWindow
object
Describes a deferred maintenance window
3 properties
ClusterNotFoundFault
DataTransferProgress
object
Describes the status of a cluster while it is in the process of resizing with an incremental resize.
6 properties
ModifyClusterMessage
object
25 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
