Expand description
Overview
This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.
Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.
If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.
If you’re using the service, you’re probably looking for RedshiftClient and Redshift.
Structs§
- Accept
Reserved Node Exchange Input Message - Accept
Reserved Node Exchange Output Message - Account
Attribute A name value pair that describes an aspect of an account.
- Account
Attribute List - Account
With Restore Access Describes an AWS customer account authorized to restore a snapshot.
- Aqua
Configuration The AQUA (Advanced Query Accelerator) configuration of the cluster.
- Attribute
Value Target Describes an attribute value.
- Authorize
Cluster Security Group Ingress Message - Authorize
Cluster Security Group Ingress Result - Authorize
Endpoint Access Message - Authorize
Snapshot Access Message - Authorize
Snapshot Access Result - Availability
Zone Describes an availability zone.
- Batch
Delete Cluster Snapshots Request - Batch
Delete Cluster Snapshots Result - Batch
Modify Cluster Snapshots Message - Batch
Modify Cluster Snapshots Output Message - Cancel
Resize Message - Cluster
Describes a cluster.
- Cluster
Associated ToSchedule - Cluster
Credentials Temporary credentials with authorization to log on to an Amazon Redshift database.
- Cluster
DbRevision Describes a
ClusterDbRevision.- Cluster
DbRevisions Message - Cluster
IamRole An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.
- Cluster
Node The identifier of a node in a cluster.
- Cluster
Parameter Group Describes a parameter group.
- Cluster
Parameter Group Details Contains the output from the DescribeClusterParameters action.
- Cluster
Parameter Group Name Message - Cluster
Parameter Group Status Describes the status of a parameter group.
- Cluster
Parameter Groups Message Contains the output from the DescribeClusterParameterGroups action.
- Cluster
Parameter Status Describes the status of a parameter group.
- Cluster
Security Group Describes a security group.
- Cluster
Security Group Membership Describes a cluster security group.
- Cluster
Security Group Message - Cluster
Snapshot Copy Status Returns the destination region and retention period that are configured for cross-region snapshot copy.
- Cluster
Subnet Group Describes a subnet group.
- Cluster
Subnet Group Message Contains the output from the DescribeClusterSubnetGroups action.
- Cluster
Version Describes a cluster version, including the parameter group family and description of the version.
- Cluster
Versions Message Contains the output from the DescribeClusterVersions action.
- Clusters
Message Contains the output from the DescribeClusters action.
- Copy
Cluster Snapshot Message - Copy
Cluster Snapshot Result - Create
Cluster Message - Create
Cluster Parameter Group Message - Create
Cluster Parameter Group Result - Create
Cluster Result - Create
Cluster Security Group Message - Create
Cluster Security Group Result - Create
Cluster Snapshot Message - Create
Cluster Snapshot Result - Create
Cluster Subnet Group Message - Create
Cluster Subnet Group Result - Create
Endpoint Access Message - Create
Event Subscription Message - Create
Event Subscription Result - Create
HsmClient Certificate Message - Create
HsmClient Certificate Result - Create
HsmConfiguration Message - Create
HsmConfiguration Result - Create
Scheduled Action Message - Create
Snapshot Copy Grant Message The result of the
CreateSnapshotCopyGrantaction.- Create
Snapshot Copy Grant Result - Create
Snapshot Schedule Message - Create
Tags Message Contains the output from the
CreateTagsaction.- Create
Usage Limit Message - Customer
Storage Message - Data
Transfer Progress Describes the status of a cluster while it is in the process of resizing with an incremental resize.
- Default
Cluster Parameters Describes the default cluster parameters for a parameter group family.
- Deferred
Maintenance Window Describes a deferred maintenance window
- Delete
Cluster Message - Delete
Cluster Parameter Group Message - Delete
Cluster Result - Delete
Cluster Security Group Message - Delete
Cluster Snapshot Message - Delete
Cluster Snapshot Result - Delete
Cluster Subnet Group Message - Delete
Endpoint Access Message - Delete
Event Subscription Message - Delete
HsmClient Certificate Message - Delete
HsmConfiguration Message - Delete
Scheduled Action Message - Delete
Snapshot Copy Grant Message The result of the
DeleteSnapshotCopyGrantaction.- Delete
Snapshot Schedule Message - Delete
Tags Message Contains the output from the
DeleteTagsaction.- Delete
Usage Limit Message - Describe
Account Attributes Message - Describe
Cluster DbRevisions Message - Describe
Cluster Parameter Groups Message - Describe
Cluster Parameters Message - Describe
Cluster Security Groups Message - Describe
Cluster Snapshots Message - Describe
Cluster Subnet Groups Message - Describe
Cluster Tracks Message - Describe
Cluster Versions Message - Describe
Clusters Message - Describe
Default Cluster Parameters Message - Describe
Default Cluster Parameters Result - Describe
Endpoint Access Message - Describe
Endpoint Authorization Message - Describe
Event Categories Message - Describe
Event Subscriptions Message - Describe
Events Message - Describe
HsmClient Certificates Message - Describe
HsmConfigurations Message - Describe
Logging Status Message - Describe
Node Configuration Options Message - Describe
Orderable Cluster Options Message - Describe
Partners Input Message - Describe
Partners Output Message - Describe
Reserved Node Offerings Message - Describe
Reserved Nodes Message - Describe
Resize Message - Describe
Scheduled Actions Message - Describe
Snapshot Copy Grants Message The result of the
DescribeSnapshotCopyGrantsaction.- Describe
Snapshot Schedules Message - Describe
Snapshot Schedules Output Message - Describe
Table Restore Status Message - Describe
Tags Message - Describe
Usage Limits Message - Disable
Logging Message - Disable
Snapshot Copy Message - Disable
Snapshot Copy Result - EC2Security
Group Describes an Amazon EC2 security group.
- Elastic
IpStatus Describes the status of the elastic IP (EIP) address.
- Enable
Logging Message - Enable
Snapshot Copy Message - Enable
Snapshot Copy Result - Endpoint
Describes a connection endpoint.
- Endpoint
Access Describes a Redshift-managed VPC endpoint.
- Endpoint
Access List - Endpoint
Authorization Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
- Endpoint
Authorization List - Event
Describes an event.
- Event
Categories Map Describes event categories.
- Event
Categories Message - Event
Info Map Describes event information.
- Event
Subscription Describes event subscriptions.
- Event
Subscriptions Message - Events
Message - GetCluster
Credentials Message The request parameters to get cluster credentials.
- GetReserved
Node Exchange Offerings Input Message - GetReserved
Node Exchange Offerings Output Message - HsmClient
Certificate Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
- HsmClient
Certificate Message - HsmConfiguration
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 where they can store database encryption keys.
- HsmConfiguration
Message - HsmStatus
Describes the status of changes to HSM settings.
- IPRange
Describes an IP range used in a security group.
- Logging
Status Describes the status of logging for a cluster.
- Maintenance
Track Defines a maintenance track that determines which Amazon Redshift version to apply during a maintenance window. If the value for
MaintenanceTrackiscurrent, the cluster is updated to the most recently certified maintenance release. If the value istrailing, the cluster is updated to the previously certified maintenance release.- Modify
Aqua Input Message - Modify
Aqua Output Message - Modify
Cluster DbRevision Message - Modify
Cluster DbRevision Result - Modify
Cluster IamRoles Message - Modify
Cluster IamRoles Result - Modify
Cluster Maintenance Message - Modify
Cluster Maintenance Result - Modify
Cluster Message - Modify
Cluster Parameter Group Message Describes a modify cluster parameter group operation.
- Modify
Cluster Result - Modify
Cluster Snapshot Message - Modify
Cluster Snapshot Result - Modify
Cluster Snapshot Schedule Message - Modify
Cluster Subnet Group Message - Modify
Cluster Subnet Group Result - Modify
Endpoint Access Message - Modify
Event Subscription Message - Modify
Event Subscription Result - Modify
Scheduled Action Message - Modify
Snapshot Copy Retention Period Message - Modify
Snapshot Copy Retention Period Result - Modify
Snapshot Schedule Message - Modify
Usage Limit Message - Network
Interface Describes a network interface.
- Node
Configuration Option A list of node configurations.
- Node
Configuration Options Filter A set of elements to filter the returned node configurations.
- Node
Configuration Options Message - Orderable
Cluster Option Describes an orderable cluster option.
- Orderable
Cluster Options Message Contains the output from the DescribeOrderableClusterOptions action.
- Parameter
Describes a parameter in a cluster parameter group.
- Partner
Integration Info Describes a partner integration.
- Partner
Integration Input Message - Partner
Integration Output Message - Pause
Cluster Message Describes a pause cluster operation. For example, a scheduled action to run the
PauseClusterAPI operation.- Pause
Cluster Result - Pending
Modified Values 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.
- Purchase
Reserved Node Offering Message - Purchase
Reserved Node Offering Result - Reboot
Cluster Message - Reboot
Cluster Result - Recurring
Charge Describes a recurring charge.
- Redshift
Client - A client for the Amazon Redshift API.
- Reserved
Node Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.
- Reserved
Node Offering Describes a reserved node offering.
- Reserved
Node Offerings Message - Reserved
Nodes Message - Reset
Cluster Parameter Group Message - Resize
Cluster Message Describes a resize cluster operation. For example, a scheduled action to run the
ResizeClusterAPI operation.- Resize
Cluster Result - Resize
Info Describes a resize operation.
- Resize
Progress Message Describes the result of a cluster resize operation.
- Restore
From Cluster Snapshot Message - Restore
From Cluster Snapshot Result - Restore
Status Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
- Restore
Table From Cluster Snapshot Message - Restore
Table From Cluster Snapshot Result - Resume
Cluster Message Describes a resume cluster operation. For example, a scheduled action to run the
ResumeClusterAPI operation.- Resume
Cluster Result - Revision
Target Describes a
RevisionTarget.- Revoke
Cluster Security Group Ingress Message - Revoke
Cluster Security Group Ingress Result - Revoke
Endpoint Access Message - Revoke
Snapshot Access Message - Revoke
Snapshot Access Result - Rotate
Encryption KeyMessage - Rotate
Encryption KeyResult - Scheduled
Action 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 operations can be scheduled, see ScheduledActionType.
- Scheduled
Action Filter A set of elements to filter the returned scheduled actions.
- Scheduled
Action Type The action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler.
- Scheduled
Actions Message - Snapshot
Describes a snapshot.
- Snapshot
Copy Grant The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
- Snapshot
Copy Grant Message - Snapshot
Error Message Describes the errors returned by a snapshot.
- Snapshot
Message Contains the output from the DescribeClusterSnapshots action.
- Snapshot
Schedule Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates.
- Snapshot
Sorting Entity Describes a sorting entity
- Subnet
Describes a subnet.
- Supported
Operation Describes the operations that are allowed on a maintenance track.
- Supported
Platform A list of supported platforms for orderable clusters.
- Table
Restore Status Describes the status of a RestoreTableFromClusterSnapshot operation.
- Table
Restore Status Message - Tag
A tag consisting of a name/value pair for a resource.
- Tagged
Resource A tag and its associated resource.
- Tagged
Resource List Message - Track
List Message - Update
Partner Status Input Message - Update
Target A maintenance track that you can switch the current track to.
- Usage
Limit Describes a usage limit object for a cluster.
- Usage
Limit List - VpcEndpoint
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
- VpcSecurity
Group Membership Describes the members of a VPC security group.
Enums§
- Accept
Reserved Node Exchange Error - Errors returned by AcceptReservedNodeExchange
- AddPartner
Error - Errors returned by AddPartner
- Authorize
Cluster Security Group Ingress Error - Errors returned by AuthorizeClusterSecurityGroupIngress
- Authorize
Endpoint Access Error - Errors returned by AuthorizeEndpointAccess
- Authorize
Snapshot Access Error - Errors returned by AuthorizeSnapshotAccess
- Batch
Delete Cluster Snapshots Error - Errors returned by BatchDeleteClusterSnapshots
- Batch
Modify Cluster Snapshots Error - Errors returned by BatchModifyClusterSnapshots
- Cancel
Resize Error - Errors returned by CancelResize
- Copy
Cluster Snapshot Error - Errors returned by CopyClusterSnapshot
- Create
Cluster Error - Errors returned by CreateCluster
- Create
Cluster Parameter Group Error - Errors returned by CreateClusterParameterGroup
- Create
Cluster Security Group Error - Errors returned by CreateClusterSecurityGroup
- Create
Cluster Snapshot Error - Errors returned by CreateClusterSnapshot
- Create
Cluster Subnet Group Error - Errors returned by CreateClusterSubnetGroup
- Create
Endpoint Access Error - Errors returned by CreateEndpointAccess
- Create
Event Subscription Error - Errors returned by CreateEventSubscription
- Create
HsmClient Certificate Error - Errors returned by CreateHsmClientCertificate
- Create
HsmConfiguration Error - Errors returned by CreateHsmConfiguration
- Create
Scheduled Action Error - Errors returned by CreateScheduledAction
- Create
Snapshot Copy Grant Error - Errors returned by CreateSnapshotCopyGrant
- Create
Snapshot Schedule Error - Errors returned by CreateSnapshotSchedule
- Create
Tags Error - Errors returned by CreateTags
- Create
Usage Limit Error - Errors returned by CreateUsageLimit
- Delete
Cluster Error - Errors returned by DeleteCluster
- Delete
Cluster Parameter Group Error - Errors returned by DeleteClusterParameterGroup
- Delete
Cluster Security Group Error - Errors returned by DeleteClusterSecurityGroup
- Delete
Cluster Snapshot Error - Errors returned by DeleteClusterSnapshot
- Delete
Cluster Subnet Group Error - Errors returned by DeleteClusterSubnetGroup
- Delete
Endpoint Access Error - Errors returned by DeleteEndpointAccess
- Delete
Event Subscription Error - Errors returned by DeleteEventSubscription
- Delete
HsmClient Certificate Error - Errors returned by DeleteHsmClientCertificate
- Delete
HsmConfiguration Error - Errors returned by DeleteHsmConfiguration
- Delete
Partner Error - Errors returned by DeletePartner
- Delete
Scheduled Action Error - Errors returned by DeleteScheduledAction
- Delete
Snapshot Copy Grant Error - Errors returned by DeleteSnapshotCopyGrant
- Delete
Snapshot Schedule Error - Errors returned by DeleteSnapshotSchedule
- Delete
Tags Error - Errors returned by DeleteTags
- Delete
Usage Limit Error - Errors returned by DeleteUsageLimit
- Describe
Account Attributes Error - Errors returned by DescribeAccountAttributes
- Describe
Cluster DbRevisions Error - Errors returned by DescribeClusterDbRevisions
- Describe
Cluster Parameter Groups Error - Errors returned by DescribeClusterParameterGroups
- Describe
Cluster Parameters Error - Errors returned by DescribeClusterParameters
- Describe
Cluster Security Groups Error - Errors returned by DescribeClusterSecurityGroups
- Describe
Cluster Snapshots Error - Errors returned by DescribeClusterSnapshots
- Describe
Cluster Subnet Groups Error - Errors returned by DescribeClusterSubnetGroups
- Describe
Cluster Tracks Error - Errors returned by DescribeClusterTracks
- Describe
Cluster Versions Error - Errors returned by DescribeClusterVersions
- Describe
Clusters Error - Errors returned by DescribeClusters
- Describe
Default Cluster Parameters Error - Errors returned by DescribeDefaultClusterParameters
- Describe
Endpoint Access Error - Errors returned by DescribeEndpointAccess
- Describe
Endpoint Authorization Error - Errors returned by DescribeEndpointAuthorization
- Describe
Event Categories Error - Errors returned by DescribeEventCategories
- Describe
Event Subscriptions Error - Errors returned by DescribeEventSubscriptions
- Describe
Events Error - Errors returned by DescribeEvents
- Describe
HsmClient Certificates Error - Errors returned by DescribeHsmClientCertificates
- Describe
HsmConfigurations Error - Errors returned by DescribeHsmConfigurations
- Describe
Logging Status Error - Errors returned by DescribeLoggingStatus
- Describe
Node Configuration Options Error - Errors returned by DescribeNodeConfigurationOptions
- Describe
Orderable Cluster Options Error - Errors returned by DescribeOrderableClusterOptions
- Describe
Partners Error - Errors returned by DescribePartners
- Describe
Reserved Node Offerings Error - Errors returned by DescribeReservedNodeOfferings
- Describe
Reserved Nodes Error - Errors returned by DescribeReservedNodes
- Describe
Resize Error - Errors returned by DescribeResize
- Describe
Scheduled Actions Error - Errors returned by DescribeScheduledActions
- Describe
Snapshot Copy Grants Error - Errors returned by DescribeSnapshotCopyGrants
- Describe
Snapshot Schedules Error - Errors returned by DescribeSnapshotSchedules
- Describe
Storage Error - Errors returned by DescribeStorage
- Describe
Table Restore Status Error - Errors returned by DescribeTableRestoreStatus
- Describe
Tags Error - Errors returned by DescribeTags
- Describe
Usage Limits Error - Errors returned by DescribeUsageLimits
- Disable
Logging Error - Errors returned by DisableLogging
- Disable
Snapshot Copy Error - Errors returned by DisableSnapshotCopy
- Enable
Logging Error - Errors returned by EnableLogging
- Enable
Snapshot Copy Error - Errors returned by EnableSnapshotCopy
- GetCluster
Credentials Error - Errors returned by GetClusterCredentials
- GetReserved
Node Exchange Offerings Error - Errors returned by GetReservedNodeExchangeOfferings
- Modify
Aqua Configuration Error - Errors returned by ModifyAquaConfiguration
- Modify
Cluster DbRevision Error - Errors returned by ModifyClusterDbRevision
- Modify
Cluster Error - Errors returned by ModifyCluster
- Modify
Cluster IamRoles Error - Errors returned by ModifyClusterIamRoles
- Modify
Cluster Maintenance Error - Errors returned by ModifyClusterMaintenance
- Modify
Cluster Parameter Group Error - Errors returned by ModifyClusterParameterGroup
- Modify
Cluster Snapshot Error - Errors returned by ModifyClusterSnapshot
- Modify
Cluster Snapshot Schedule Error - Errors returned by ModifyClusterSnapshotSchedule
- Modify
Cluster Subnet Group Error - Errors returned by ModifyClusterSubnetGroup
- Modify
Endpoint Access Error - Errors returned by ModifyEndpointAccess
- Modify
Event Subscription Error - Errors returned by ModifyEventSubscription
- Modify
Scheduled Action Error - Errors returned by ModifyScheduledAction
- Modify
Snapshot Copy Retention Period Error - Errors returned by ModifySnapshotCopyRetentionPeriod
- Modify
Snapshot Schedule Error - Errors returned by ModifySnapshotSchedule
- Modify
Usage Limit Error - Errors returned by ModifyUsageLimit
- Pause
Cluster Error - Errors returned by PauseCluster
- Purchase
Reserved Node Offering Error - Errors returned by PurchaseReservedNodeOffering
- Reboot
Cluster Error - Errors returned by RebootCluster
- Reset
Cluster Parameter Group Error - Errors returned by ResetClusterParameterGroup
- Resize
Cluster Error - Errors returned by ResizeCluster
- Restore
From Cluster Snapshot Error - Errors returned by RestoreFromClusterSnapshot
- Restore
Table From Cluster Snapshot Error - Errors returned by RestoreTableFromClusterSnapshot
- Resume
Cluster Error - Errors returned by ResumeCluster
- Revoke
Cluster Security Group Ingress Error - Errors returned by RevokeClusterSecurityGroupIngress
- Revoke
Endpoint Access Error - Errors returned by RevokeEndpointAccess
- Revoke
Snapshot Access Error - Errors returned by RevokeSnapshotAccess
- Rotate
Encryption KeyError - Errors returned by RotateEncryptionKey
- Update
Partner Status Error - Errors returned by UpdatePartnerStatus
Traits§
- Redshift
- Trait representing the capabilities of the Amazon Redshift API. Amazon Redshift clients implement this trait.