Module types

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that Amazon Redshift can respond with.

Structs§

AccountAttribute

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

AccountWithRestoreAccess

Describes an Amazon Web Services account authorized to restore a snapshot.

AquaConfiguration

The operation that uses this structure is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Association

Contains information about the custom domain name association.

AttributeValueTarget

Describes an attribute value.

AuthenticationProfile

Describes an authentication profile.

AuthorizedTokenIssuer

The authorized token issuer for the Amazon Redshift IAM Identity Center application.

AvailabilityZone

Describes an availability zone.

CertificateAssociation

A cluster ID and custom domain name tied to a specific certificate. These are typically returned in a list.

Cluster

Describes a cluster.

ClusterAssociatedToSchedule

ClusterDbRevision

Describes a ClusterDbRevision.

ClusterIamRole

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

ClusterNode

The identifier of a node in a cluster.

ClusterParameterGroup

Describes a parameter group.

ClusterParameterGroupStatus

Describes the status of a parameter group.

ClusterParameterStatus

Describes the status of a parameter group.

ClusterSecurityGroup

Describes a security group.

ClusterSecurityGroupMembership

Describes a cluster security group.

ClusterSnapshotCopyStatus

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

ClusterSubnetGroup

Describes a subnet group.

ClusterVersion

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

DataShare
DataShareAssociation

The association of a datashare from a producer account with a data consumer.

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

DeleteClusterSnapshotMessage

DescribeIntegrationsFilter

A set of elements to filter the returned integrations.

Ec2SecurityGroup

Describes an Amazon EC2 security group.

ElasticIpStatus

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

Endpoint

Describes a connection endpoint.

EndpointAccess

Describes a Redshift-managed VPC endpoint.

EndpointAuthorization

Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across Amazon Web Services accounts.

Event

Describes an event.

EventCategoriesMap

Describes event categories.

EventInfoMap

Describes event information.

EventSubscription

Describes event subscriptions.

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.

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.

HsmStatus

Describes the status of changes to HSM settings.

InboundIntegration

The content of an inbound integration.

Integration
IntegrationError

The error of an inbound integration.

IpRange

Describes an IP range used in a security group.

LakeFormationQuery

The Lake Formation scope.

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.

NetworkInterface

Describes a network interface.

NodeConfigurationOption

A list of node configurations.

NodeConfigurationOptionsFilter

A set of elements to filter the returned node configurations.

OrderableClusterOption

Describes an orderable cluster option.

Parameter

Describes a parameter in a cluster parameter group.

PartnerIntegrationInfo

Describes a partner integration.

PauseClusterMessage

Describes a pause cluster operation. For example, a scheduled action to run the PauseCluster API operation.

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.

ProvisionedIdentifier

The identifier for a provisioned cluster.

ReadWriteAccess

The S3 Access Grants scope.

Recommendation

An Amazon Redshift Advisor recommended action on the Amazon Redshift cluster.

RecommendedAction

The recommended action from the Amazon Redshift Advisor recommendation.

RecurringCharge

Describes a recurring charge.

RedshiftIdcApplication

Contains properties for the Redshift IDC application.

ReferenceLink

A link to an Amazon Redshift Advisor reference for more information about a recommendation.

ReservedNode

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

ReservedNodeConfigurationOption

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.

ReservedNodeExchangeStatus

Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other details.

ReservedNodeOffering

Describes a reserved node offering.

ResizeClusterMessage

Describes a resize cluster operation. For example, a scheduled action to run the ResizeCluster API operation.

ResizeInfo

Describes a resize operation.

ResourcePolicy

The policy that is attached to a resource.

RestoreStatus

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

ResumeClusterMessage

Describes a resume cluster operation. For example, a scheduled action to run the ResumeCluster API operation.

RevisionTarget

Describes a RevisionTarget.

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.

SecondaryClusterInfo

The AvailabilityZone and ClusterNodes information of the secondary compute unit.

ServerlessIdentifier

The identifier for a serverless namespace.

Snapshot

Describes a snapshot.

SnapshotCopyGrant

The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified encrypted symmetric key from Amazon Web Services 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.

SnapshotErrorMessage

Describes the errors returned by a snapshot.

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.

Tag

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

TaggedResource

A tag and its associated resource.

UpdateTarget

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

UsageLimit

Describes a usage limit object for a cluster.

VpcEndpoint

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

VpcSecurityGroupMembership

Describes the members of a VPC security group.

Enums§

ActionType
When writing a match expression against ActionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AquaConfigurationStatus
When writing a match expression against AquaConfigurationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AquaStatus
When writing a match expression against AquaStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AuthorizationStatus
When writing a match expression against AuthorizationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DataShareStatus
When writing a match expression against DataShareStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DataShareStatusForConsumer
When writing a match expression against DataShareStatusForConsumer, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DataShareStatusForProducer
When writing a match expression against DataShareStatusForProducer, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DataShareType
When writing a match expression against DataShareType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DescribeIntegrationsFilterName
When writing a match expression against DescribeIntegrationsFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ImpactRankingType
When writing a match expression against ImpactRankingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LakeFormationScopeUnion

A list of scopes set up for Lake Formation integration.

LogDestinationType
When writing a match expression against LogDestinationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Mode
When writing a match expression against Mode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NamespaceIdentifierUnion

Object to store union of values for a provisioned cluster or serverless namespace’s identifier.

NamespaceRegistrationStatus
When writing a match expression against NamespaceRegistrationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NodeConfigurationOptionsFilterName
When writing a match expression against NodeConfigurationOptionsFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OperatorType
When writing a match expression against OperatorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ParameterApplyType
When writing a match expression against ParameterApplyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PartnerIntegrationStatus
When writing a match expression against PartnerIntegrationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RecommendedActionType
When writing a match expression against RecommendedActionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ReservedNodeExchangeActionType
When writing a match expression against ReservedNodeExchangeActionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ReservedNodeExchangeStatusType
When writing a match expression against ReservedNodeExchangeStatusType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ReservedNodeOfferingType
When writing a match expression against ReservedNodeOfferingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
S3AccessGrantsScopeUnion

A list of scopes set up for S3 Access Grants integration.

ScheduleState
When writing a match expression against ScheduleState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ScheduledActionFilterName
When writing a match expression against ScheduledActionFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ScheduledActionState
When writing a match expression against ScheduledActionState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ScheduledActionTypeValues
When writing a match expression against ScheduledActionTypeValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ServiceAuthorization
When writing a match expression against ServiceAuthorization, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ServiceIntegrationsUnion

A list of service integrations.

SnapshotAttributeToSortBy
When writing a match expression against SnapshotAttributeToSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortByOrder
When writing a match expression against SortByOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SourceType
When writing a match expression against SourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TableRestoreStatusType
When writing a match expression against TableRestoreStatusType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
UsageLimitBreachAction
When writing a match expression against UsageLimitBreachAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
UsageLimitFeatureType
When writing a match expression against UsageLimitFeatureType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
UsageLimitLimitType
When writing a match expression against UsageLimitLimitType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
UsageLimitPeriod
When writing a match expression against UsageLimitPeriod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ZeroEtlIntegrationStatus
When writing a match expression against ZeroEtlIntegrationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.