[][src]Crate rusoto_redshift

Amazon Redshift

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

AcceptReservedNodeExchangeInputMessage
AcceptReservedNodeExchangeOutputMessage
AccountAttribute

A name value pair that describes an aspect of an account.

AccountAttributeList
AccountWithRestoreAccess

Describes an AWS customer account authorized to restore a snapshot.

AttributeValueTarget

Describes an attribute value.

AuthorizeClusterSecurityGroupIngressMessage

AuthorizeClusterSecurityGroupIngressResult
AuthorizeSnapshotAccessMessage

AuthorizeSnapshotAccessResult
AvailabilityZone

Describes an availability zone.

BatchDeleteClusterSnapshotsRequest
BatchDeleteClusterSnapshotsResult
BatchModifyClusterSnapshotsMessage
BatchModifyClusterSnapshotsOutputMessage
CancelResizeMessage
Cluster

Describes a cluster.

ClusterAssociatedToSchedule

ClusterCredentials

Temporary credentials with authorization to log on to an Amazon Redshift database.

ClusterDbRevision

Describes a ClusterDbRevision.

ClusterDbRevisionsMessage
ClusterIamRole

An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.

ClusterNode

The identifier of a node in a cluster.

ClusterParameterGroup

Describes a parameter group.

ClusterParameterGroupDetails

Contains the output from the DescribeClusterParameters action.

ClusterParameterGroupNameMessage

ClusterParameterGroupStatus

Describes the status of a parameter group.

ClusterParameterGroupsMessage

Contains the output from the DescribeClusterParameterGroups action.

ClusterParameterStatus

Describes the status of a parameter group.

ClusterSecurityGroup

Describes a security group.

ClusterSecurityGroupMembership

Describes a cluster security group.

ClusterSecurityGroupMessage

ClusterSnapshotCopyStatus

Returns the destination region and retention period that are configured for cross-region snapshot copy.

ClusterSubnetGroup

Describes a subnet group.

ClusterSubnetGroupMessage

Contains the output from the DescribeClusterSubnetGroups action.

ClusterVersion

Describes a cluster version, including the parameter group family and description of the version.

ClusterVersionsMessage

Contains the output from the DescribeClusterVersions action.

ClustersMessage

Contains the output from the DescribeClusters action.

CopyClusterSnapshotMessage

CopyClusterSnapshotResult
CreateClusterMessage

CreateClusterParameterGroupMessage

CreateClusterParameterGroupResult
CreateClusterResult
CreateClusterSecurityGroupMessage

CreateClusterSecurityGroupResult
CreateClusterSnapshotMessage

CreateClusterSnapshotResult
CreateClusterSubnetGroupMessage

CreateClusterSubnetGroupResult
CreateEventSubscriptionMessage

CreateEventSubscriptionResult
CreateHsmClientCertificateMessage

CreateHsmClientCertificateResult
CreateHsmConfigurationMessage

CreateHsmConfigurationResult
CreateScheduledActionMessage
CreateSnapshotCopyGrantMessage

The result of the CreateSnapshotCopyGrant action.

CreateSnapshotCopyGrantResult
CreateSnapshotScheduleMessage
CreateTagsMessage

Contains the output from the CreateTags action.

CreateUsageLimitMessage
CustomerStorageMessage
DataTransferProgress

Describes the status of a cluster while it is in the process of resizing with an incremental resize.

DefaultClusterParameters

Describes the default cluster parameters for a parameter group family.

DeferredMaintenanceWindow

Describes a deferred maintenance window

DeleteClusterMessage

DeleteClusterParameterGroupMessage

DeleteClusterResult
DeleteClusterSecurityGroupMessage

DeleteClusterSnapshotMessage

DeleteClusterSnapshotResult
DeleteClusterSubnetGroupMessage

DeleteEventSubscriptionMessage

DeleteHsmClientCertificateMessage

DeleteHsmConfigurationMessage

DeleteScheduledActionMessage
DeleteSnapshotCopyGrantMessage

The result of the DeleteSnapshotCopyGrant action.

DeleteSnapshotScheduleMessage
DeleteTagsMessage

Contains the output from the DeleteTags action.

DeleteUsageLimitMessage
DescribeAccountAttributesMessage
DescribeClusterDbRevisionsMessage
DescribeClusterParameterGroupsMessage

DescribeClusterParametersMessage

DescribeClusterSecurityGroupsMessage

DescribeClusterSnapshotsMessage

DescribeClusterSubnetGroupsMessage

DescribeClusterTracksMessage
DescribeClusterVersionsMessage

DescribeClustersMessage

DescribeDefaultClusterParametersMessage

DescribeDefaultClusterParametersResult
DescribeEventCategoriesMessage

DescribeEventSubscriptionsMessage

DescribeEventsMessage

DescribeHsmClientCertificatesMessage

DescribeHsmConfigurationsMessage

DescribeLoggingStatusMessage

DescribeNodeConfigurationOptionsMessage
DescribeOrderableClusterOptionsMessage

DescribeReservedNodeOfferingsMessage

DescribeReservedNodesMessage

DescribeResizeMessage

DescribeScheduledActionsMessage
DescribeSnapshotCopyGrantsMessage

The result of the DescribeSnapshotCopyGrants action.

DescribeSnapshotSchedulesMessage
DescribeSnapshotSchedulesOutputMessage
DescribeTableRestoreStatusMessage

DescribeTagsMessage

DescribeUsageLimitsMessage
DisableLoggingMessage

DisableSnapshotCopyMessage

DisableSnapshotCopyResult
EC2SecurityGroup

Describes an Amazon EC2 security group.

ElasticIpStatus

Describes the status of the elastic IP (EIP) address.

EnableLoggingMessage

EnableSnapshotCopyMessage

EnableSnapshotCopyResult
Endpoint

Describes a connection endpoint.

Event

Describes an event.

EventCategoriesMap

Describes event categories.

EventCategoriesMessage

EventInfoMap

Describes event information.

EventSubscription

Describes event subscriptions.

EventSubscriptionsMessage

EventsMessage

GetClusterCredentialsMessage

The request parameters to get cluster credentials.

GetReservedNodeExchangeOfferingsInputMessage

GetReservedNodeExchangeOfferingsOutputMessage
HsmClientCertificate

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.

HsmClientCertificateMessage

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.

HsmConfigurationMessage

HsmStatus

Describes the status of changes to HSM settings.

IPRange

Describes an IP range used in a security group.

LoggingStatus

Describes the status of logging for a cluster.

MaintenanceTrack

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.

ModifyClusterDbRevisionMessage
ModifyClusterDbRevisionResult
ModifyClusterIamRolesMessage

ModifyClusterIamRolesResult
ModifyClusterMaintenanceMessage
ModifyClusterMaintenanceResult
ModifyClusterMessage

ModifyClusterParameterGroupMessage

ModifyClusterResult
ModifyClusterSnapshotMessage
ModifyClusterSnapshotResult
ModifyClusterSnapshotScheduleMessage
ModifyClusterSubnetGroupMessage

ModifyClusterSubnetGroupResult
ModifyEventSubscriptionMessage

ModifyEventSubscriptionResult
ModifyScheduledActionMessage
ModifySnapshotCopyRetentionPeriodMessage

ModifySnapshotCopyRetentionPeriodResult
ModifySnapshotScheduleMessage
ModifyUsageLimitMessage
NodeConfigurationOption

A list of node configurations.

NodeConfigurationOptionsFilter

A set of elements to filter the returned node configurations.

NodeConfigurationOptionsMessage
OrderableClusterOption

Describes an orderable cluster option.

OrderableClusterOptionsMessage

Contains the output from the DescribeOrderableClusterOptions action.

Parameter

Describes a parameter in a cluster parameter group.

PauseClusterMessage
PauseClusterResult
PendingModifiedValues

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.

PurchaseReservedNodeOfferingMessage

PurchaseReservedNodeOfferingResult
RebootClusterMessage

RebootClusterResult
RecurringCharge

Describes a recurring charge.

RedshiftClient

A client for the Amazon Redshift API.

ReservedNode

Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

ReservedNodeOffering

Describes a reserved node offering.

ReservedNodeOfferingsMessage

ReservedNodesMessage

ResetClusterParameterGroupMessage

ResizeClusterMessage
ResizeClusterResult
ResizeInfo

Describes a resize operation.

ResizeProgressMessage

Describes the result of a cluster resize operation.

RestoreFromClusterSnapshotMessage

RestoreFromClusterSnapshotResult
RestoreStatus

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

RestoreTableFromClusterSnapshotMessage

RestoreTableFromClusterSnapshotResult
ResumeClusterMessage
ResumeClusterResult
RevisionTarget

Describes a RevisionTarget.

RevokeClusterSecurityGroupIngressMessage

RevokeClusterSecurityGroupIngressResult
RevokeSnapshotAccessMessage

RevokeSnapshotAccessResult
RotateEncryptionKeyMessage

RotateEncryptionKeyResult
ScheduledAction

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.

ScheduledActionFilter

A set of elements to filter the returned scheduled actions.

ScheduledActionType

The action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler.

ScheduledActionsMessage
Snapshot

Describes a snapshot.

SnapshotCopyGrant

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.

SnapshotCopyGrantMessage

SnapshotErrorMessage

Describes the errors returned by a snapshot.

SnapshotMessage

Contains the output from the DescribeClusterSnapshots action.

SnapshotSchedule

Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates.

SnapshotSortingEntity

Describes a sorting entity

Subnet

Describes a subnet.

SupportedOperation

Describes the operations that are allowed on a maintenance track.

SupportedPlatform

A list of supported platforms for orderable clusters.

TableRestoreStatus

Describes the status of a RestoreTableFromClusterSnapshot operation.

TableRestoreStatusMessage

Tag

A tag consisting of a name/value pair for a resource.

TaggedResource

A tag and its associated resource.

TaggedResourceListMessage

TrackListMessage
UpdateTarget

A maintenance track that you can switch the current track to.

UsageLimit

Describes a usage limit object for a cluster.

UsageLimitList
VpcSecurityGroupMembership

Describes the members of a VPC security group.

Enums

AcceptReservedNodeExchangeError

Errors returned by AcceptReservedNodeExchange

AuthorizeClusterSecurityGroupIngressError

Errors returned by AuthorizeClusterSecurityGroupIngress

AuthorizeSnapshotAccessError

Errors returned by AuthorizeSnapshotAccess

BatchDeleteClusterSnapshotsError

Errors returned by BatchDeleteClusterSnapshots

BatchModifyClusterSnapshotsError

Errors returned by BatchModifyClusterSnapshots

CancelResizeError

Errors returned by CancelResize

CopyClusterSnapshotError

Errors returned by CopyClusterSnapshot

CreateClusterError

Errors returned by CreateCluster

CreateClusterParameterGroupError

Errors returned by CreateClusterParameterGroup

CreateClusterSecurityGroupError

Errors returned by CreateClusterSecurityGroup

CreateClusterSnapshotError

Errors returned by CreateClusterSnapshot

CreateClusterSubnetGroupError

Errors returned by CreateClusterSubnetGroup

CreateEventSubscriptionError

Errors returned by CreateEventSubscription

CreateHsmClientCertificateError

Errors returned by CreateHsmClientCertificate

CreateHsmConfigurationError

Errors returned by CreateHsmConfiguration

CreateScheduledActionError

Errors returned by CreateScheduledAction

CreateSnapshotCopyGrantError

Errors returned by CreateSnapshotCopyGrant

CreateSnapshotScheduleError

Errors returned by CreateSnapshotSchedule

CreateTagsError

Errors returned by CreateTags

CreateUsageLimitError

Errors returned by CreateUsageLimit

DeleteClusterError

Errors returned by DeleteCluster

DeleteClusterParameterGroupError

Errors returned by DeleteClusterParameterGroup

DeleteClusterSecurityGroupError

Errors returned by DeleteClusterSecurityGroup

DeleteClusterSnapshotError

Errors returned by DeleteClusterSnapshot

DeleteClusterSubnetGroupError

Errors returned by DeleteClusterSubnetGroup

DeleteEventSubscriptionError

Errors returned by DeleteEventSubscription

DeleteHsmClientCertificateError

Errors returned by DeleteHsmClientCertificate

DeleteHsmConfigurationError

Errors returned by DeleteHsmConfiguration

DeleteScheduledActionError

Errors returned by DeleteScheduledAction

DeleteSnapshotCopyGrantError

Errors returned by DeleteSnapshotCopyGrant

DeleteSnapshotScheduleError

Errors returned by DeleteSnapshotSchedule

DeleteTagsError

Errors returned by DeleteTags

DeleteUsageLimitError

Errors returned by DeleteUsageLimit

DescribeAccountAttributesError

Errors returned by DescribeAccountAttributes

DescribeClusterDbRevisionsError

Errors returned by DescribeClusterDbRevisions

DescribeClusterParameterGroupsError

Errors returned by DescribeClusterParameterGroups

DescribeClusterParametersError

Errors returned by DescribeClusterParameters

DescribeClusterSecurityGroupsError

Errors returned by DescribeClusterSecurityGroups

DescribeClusterSnapshotsError

Errors returned by DescribeClusterSnapshots

DescribeClusterSubnetGroupsError

Errors returned by DescribeClusterSubnetGroups

DescribeClusterTracksError

Errors returned by DescribeClusterTracks

DescribeClusterVersionsError

Errors returned by DescribeClusterVersions

DescribeClustersError

Errors returned by DescribeClusters

DescribeDefaultClusterParametersError

Errors returned by DescribeDefaultClusterParameters

DescribeEventCategoriesError

Errors returned by DescribeEventCategories

DescribeEventSubscriptionsError

Errors returned by DescribeEventSubscriptions

DescribeEventsError

Errors returned by DescribeEvents

DescribeHsmClientCertificatesError

Errors returned by DescribeHsmClientCertificates

DescribeHsmConfigurationsError

Errors returned by DescribeHsmConfigurations

DescribeLoggingStatusError

Errors returned by DescribeLoggingStatus

DescribeNodeConfigurationOptionsError

Errors returned by DescribeNodeConfigurationOptions

DescribeOrderableClusterOptionsError

Errors returned by DescribeOrderableClusterOptions

DescribeReservedNodeOfferingsError

Errors returned by DescribeReservedNodeOfferings

DescribeReservedNodesError

Errors returned by DescribeReservedNodes

DescribeResizeError

Errors returned by DescribeResize

DescribeScheduledActionsError

Errors returned by DescribeScheduledActions

DescribeSnapshotCopyGrantsError

Errors returned by DescribeSnapshotCopyGrants

DescribeSnapshotSchedulesError

Errors returned by DescribeSnapshotSchedules

DescribeStorageError

Errors returned by DescribeStorage

DescribeTableRestoreStatusError

Errors returned by DescribeTableRestoreStatus

DescribeTagsError

Errors returned by DescribeTags

DescribeUsageLimitsError

Errors returned by DescribeUsageLimits

DisableLoggingError

Errors returned by DisableLogging

DisableSnapshotCopyError

Errors returned by DisableSnapshotCopy

EnableLoggingError

Errors returned by EnableLogging

EnableSnapshotCopyError

Errors returned by EnableSnapshotCopy

GetClusterCredentialsError

Errors returned by GetClusterCredentials

GetReservedNodeExchangeOfferingsError

Errors returned by GetReservedNodeExchangeOfferings

ModifyClusterDbRevisionError

Errors returned by ModifyClusterDbRevision

ModifyClusterError

Errors returned by ModifyCluster

ModifyClusterIamRolesError

Errors returned by ModifyClusterIamRoles

ModifyClusterMaintenanceError

Errors returned by ModifyClusterMaintenance

ModifyClusterParameterGroupError

Errors returned by ModifyClusterParameterGroup

ModifyClusterSnapshotError

Errors returned by ModifyClusterSnapshot

ModifyClusterSnapshotScheduleError

Errors returned by ModifyClusterSnapshotSchedule

ModifyClusterSubnetGroupError

Errors returned by ModifyClusterSubnetGroup

ModifyEventSubscriptionError

Errors returned by ModifyEventSubscription

ModifyScheduledActionError

Errors returned by ModifyScheduledAction

ModifySnapshotCopyRetentionPeriodError

Errors returned by ModifySnapshotCopyRetentionPeriod

ModifySnapshotScheduleError

Errors returned by ModifySnapshotSchedule

ModifyUsageLimitError

Errors returned by ModifyUsageLimit

PauseClusterError

Errors returned by PauseCluster

PurchaseReservedNodeOfferingError

Errors returned by PurchaseReservedNodeOffering

RebootClusterError

Errors returned by RebootCluster

ResetClusterParameterGroupError

Errors returned by ResetClusterParameterGroup

ResizeClusterError

Errors returned by ResizeCluster

RestoreFromClusterSnapshotError

Errors returned by RestoreFromClusterSnapshot

RestoreTableFromClusterSnapshotError

Errors returned by RestoreTableFromClusterSnapshot

ResumeClusterError

Errors returned by ResumeCluster

RevokeClusterSecurityGroupIngressError

Errors returned by RevokeClusterSecurityGroupIngress

RevokeSnapshotAccessError

Errors returned by RevokeSnapshotAccess

RotateEncryptionKeyError

Errors returned by RotateEncryptionKey

Traits

Redshift

Trait representing the capabilities of the Amazon Redshift API. Amazon Redshift clients implement this trait.