Crate rusoto_redshift
source · [−]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
A name value pair that describes an aspect of an account.
Describes an AWS customer account authorized to restore a snapshot.
The AQUA (Advanced Query Accelerator) configuration of the cluster.
Describes an attribute value.
Describes an availability zone.
Describes a cluster.
Temporary credentials with authorization to log on to an Amazon Redshift database.
Describes a ClusterDbRevision.
An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.
The identifier of a node in a cluster.
Describes a parameter group.
Contains the output from the DescribeClusterParameters action.
Describes the status of a parameter group.
Contains the output from the DescribeClusterParameterGroups action.
Describes the status of a parameter group.
Describes a security group.
Describes a cluster security group.
Returns the destination region and retention period that are configured for cross-region snapshot copy.
Describes a subnet group.
Contains the output from the DescribeClusterSubnetGroups action.
Describes a cluster version, including the parameter group family and description of the version.
Contains the output from the DescribeClusterVersions action.
Contains the output from the DescribeClusters action.
The result of the CreateSnapshotCopyGrant action.
Contains the output from the CreateTags action.
Describes the status of a cluster while it is in the process of resizing with an incremental resize.
Describes the default cluster parameters for a parameter group family.
Describes a deferred maintenance window
The result of the DeleteSnapshotCopyGrant action.
Contains the output from the DeleteTags action.
The result of the DescribeSnapshotCopyGrants action.
Describes an Amazon EC2 security group.
Describes the status of the elastic IP (EIP) address.
Describes a connection endpoint.
Describes a Redshift-managed VPC endpoint.
Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
Describes an event.
Describes event categories.
Describes event information.
Describes event subscriptions.
The request parameters to get cluster credentials.
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.
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.
Describes the status of changes to HSM settings.
Describes an IP range used in a security group.
Describes the status of logging for a cluster.
Defines a maintenance track that determines which Amazon Redshift version to apply during a maintenance window. If the value for MaintenanceTrack is current, the cluster is updated to the most recently certified maintenance release. If the value is trailing, the cluster is updated to the previously certified maintenance release.
Describes a modify cluster parameter group operation.
Describes a network interface.
A list of node configurations.
A set of elements to filter the returned node configurations.
Describes an orderable cluster option.
Contains the output from the DescribeOrderableClusterOptions action.
Describes a parameter in a cluster parameter group.
Describes a partner integration.
Describes a pause cluster operation. For example, a scheduled action to run the PauseCluster API operation.
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.
Describes a recurring charge.
A client for the Amazon Redshift API.
Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.
Describes a reserved node offering.
Describes a resize cluster operation. For example, a scheduled action to run the ResizeCluster API operation.
Describes a resize operation.
Describes the result of a cluster resize operation.
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Describes a resume cluster operation. For example, a scheduled action to run the ResumeCluster API operation.
Describes a RevisionTarget.
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.
A set of elements to filter the returned scheduled actions.
The action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler.
Describes a snapshot.
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.
Describes the errors returned by a snapshot.
Contains the output from the DescribeClusterSnapshots action.
Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates.
Describes a sorting entity
Describes a subnet.
Describes the operations that are allowed on a maintenance track.
A list of supported platforms for orderable clusters.
Describes the status of a RestoreTableFromClusterSnapshot operation.
A tag consisting of a name/value pair for a resource.
A tag and its associated resource.
A maintenance track that you can switch the current track to.
Describes a usage limit object for a cluster.
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
Describes the members of a VPC security group.
Enums
Errors returned by AcceptReservedNodeExchange
Errors returned by AddPartner
Errors returned by AuthorizeClusterSecurityGroupIngress
Errors returned by AuthorizeEndpointAccess
Errors returned by AuthorizeSnapshotAccess
Errors returned by BatchDeleteClusterSnapshots
Errors returned by BatchModifyClusterSnapshots
Errors returned by CancelResize
Errors returned by CopyClusterSnapshot
Errors returned by CreateCluster
Errors returned by CreateClusterParameterGroup
Errors returned by CreateClusterSecurityGroup
Errors returned by CreateClusterSnapshot
Errors returned by CreateClusterSubnetGroup
Errors returned by CreateEndpointAccess
Errors returned by CreateEventSubscription
Errors returned by CreateHsmClientCertificate
Errors returned by CreateHsmConfiguration
Errors returned by CreateScheduledAction
Errors returned by CreateSnapshotCopyGrant
Errors returned by CreateSnapshotSchedule
Errors returned by CreateTags
Errors returned by CreateUsageLimit
Errors returned by DeleteCluster
Errors returned by DeleteClusterParameterGroup
Errors returned by DeleteClusterSecurityGroup
Errors returned by DeleteClusterSnapshot
Errors returned by DeleteClusterSubnetGroup
Errors returned by DeleteEndpointAccess
Errors returned by DeleteEventSubscription
Errors returned by DeleteHsmClientCertificate
Errors returned by DeleteHsmConfiguration
Errors returned by DeletePartner
Errors returned by DeleteScheduledAction
Errors returned by DeleteSnapshotCopyGrant
Errors returned by DeleteSnapshotSchedule
Errors returned by DeleteTags
Errors returned by DeleteUsageLimit
Errors returned by DescribeAccountAttributes
Errors returned by DescribeClusterDbRevisions
Errors returned by DescribeClusterParameterGroups
Errors returned by DescribeClusterParameters
Errors returned by DescribeClusterSecurityGroups
Errors returned by DescribeClusterSnapshots
Errors returned by DescribeClusterSubnetGroups
Errors returned by DescribeClusterTracks
Errors returned by DescribeClusterVersions
Errors returned by DescribeClusters
Errors returned by DescribeDefaultClusterParameters
Errors returned by DescribeEndpointAccess
Errors returned by DescribeEndpointAuthorization
Errors returned by DescribeEventCategories
Errors returned by DescribeEventSubscriptions
Errors returned by DescribeEvents
Errors returned by DescribeHsmClientCertificates
Errors returned by DescribeHsmConfigurations
Errors returned by DescribeLoggingStatus
Errors returned by DescribeNodeConfigurationOptions
Errors returned by DescribeOrderableClusterOptions
Errors returned by DescribePartners
Errors returned by DescribeReservedNodeOfferings
Errors returned by DescribeReservedNodes
Errors returned by DescribeResize
Errors returned by DescribeScheduledActions
Errors returned by DescribeSnapshotCopyGrants
Errors returned by DescribeSnapshotSchedules
Errors returned by DescribeStorage
Errors returned by DescribeTableRestoreStatus
Errors returned by DescribeTags
Errors returned by DescribeUsageLimits
Errors returned by DisableLogging
Errors returned by DisableSnapshotCopy
Errors returned by EnableLogging
Errors returned by EnableSnapshotCopy
Errors returned by GetClusterCredentials
Errors returned by GetReservedNodeExchangeOfferings
Errors returned by ModifyAquaConfiguration
Errors returned by ModifyClusterDbRevision
Errors returned by ModifyCluster
Errors returned by ModifyClusterIamRoles
Errors returned by ModifyClusterMaintenance
Errors returned by ModifyClusterParameterGroup
Errors returned by ModifyClusterSnapshot
Errors returned by ModifyClusterSnapshotSchedule
Errors returned by ModifyClusterSubnetGroup
Errors returned by ModifyEndpointAccess
Errors returned by ModifyEventSubscription
Errors returned by ModifyScheduledAction
Errors returned by ModifySnapshotCopyRetentionPeriod
Errors returned by ModifySnapshotSchedule
Errors returned by ModifyUsageLimit
Errors returned by PauseCluster
Errors returned by PurchaseReservedNodeOffering
Errors returned by RebootCluster
Errors returned by ResetClusterParameterGroup
Errors returned by ResizeCluster
Errors returned by RestoreFromClusterSnapshot
Errors returned by RestoreTableFromClusterSnapshot
Errors returned by ResumeCluster
Errors returned by RevokeClusterSecurityGroupIngress
Errors returned by RevokeEndpointAccess
Errors returned by RevokeSnapshotAccess
Errors returned by RotateEncryptionKey
Errors returned by UpdatePartnerStatus
Traits
Trait representing the capabilities of the Amazon Redshift API. Amazon Redshift clients implement this trait.