Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Account
Attribute A name value pair that describes an aspect of an account.
- Account
With Restore Access Describes an Amazon Web Services account authorized to restore a snapshot.
- Aqua
Configuration 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.
- Attribute
Value Target Describes an attribute value.
- Authentication
Profile Describes an authentication profile.
- Authorized
Token Issuer The authorized token issuer for the Amazon Redshift IAM Identity Center application.
- Availability
Zone Describes an availability zone.
- Certificate
Association A cluster ID and custom domain name tied to a specific certificate. These are typically returned in a list.
- Cluster
Describes a cluster.
- Cluster
Associated ToSchedule - Cluster
DbRevision Describes a
ClusterDbRevision
.- Cluster
IamRole An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
- Cluster
Node The identifier of a node in a cluster.
- Cluster
Parameter Group Describes a parameter group.
- Cluster
Parameter Group Status Describes the status of a parameter group.
- 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
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
Version Describes a cluster version, including the parameter group family and description of the version.
- Data
Share - Data
Share Association The association of a datashare from a producer account with a data consumer.
- 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 Snapshot Message - Describe
Integrations Filter A set of elements to filter the returned integrations.
- Ec2Security
Group Describes an Amazon EC2 security group.
- Elastic
IpStatus Describes the status of the elastic IP (EIP) address.
- Endpoint
Describes a connection endpoint.
- Endpoint
Access Describes a Redshift-managed VPC endpoint.
- Endpoint
Authorization Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across Amazon Web Services accounts.
- Event
Describes an event.
- Event
Categories Map Describes event categories.
- Event
Info Map Describes event information.
- Event
Subscription Describes event subscriptions.
- 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.
- 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.
- Inbound
Integration The content of an inbound integration.
- Integration
- Integration
Error The error of an inbound integration.
- IpRange
Describes an IP range used in a security group.
- Lake
Formation Query The Lake Formation scope.
- Maintenance
Track Defines a maintenance track that determines which Amazon Redshift version to apply during a maintenance window. If the value for
MaintenanceTrack
iscurrent
, 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.- 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.
- Orderable
Cluster Option Describes an orderable cluster option.
- Parameter
Describes a parameter in a cluster parameter group.
- Partner
Integration Info Describes a partner integration.
- Pause
Cluster Message Describes a pause cluster operation. For example, a scheduled action to run the
PauseCluster
API operation.- 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.
- Provisioned
Identifier The identifier for a provisioned cluster.
- Read
Write Access The S3 Access Grants scope.
- Recommendation
An Amazon Redshift Advisor recommended action on the Amazon Redshift cluster.
- Recommended
Action The recommended action from the Amazon Redshift Advisor recommendation.
- Recurring
Charge Describes a recurring charge.
- Redshift
IdcApplication Contains properties for the Redshift IDC application.
- Reference
Link A link to an Amazon Redshift Advisor reference for more information about a recommendation.
- Reserved
Node Describes a reserved node. You can call the
DescribeReservedNodeOfferings
API to obtain the available reserved node offerings.- Reserved
Node Configuration Option 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.
- Reserved
Node Exchange Status 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.
- Reserved
Node Offering Describes a reserved node offering.
- Resize
Cluster Message Describes a resize cluster operation. For example, a scheduled action to run the
ResizeCluster
API operation.- Resize
Info Describes a resize operation.
- Resource
Policy The policy that is attached to a resource.
- Restore
Status Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
- Resume
Cluster Message Describes a resume cluster operation. For example, a scheduled action to run the
ResumeCluster
API operation.- Revision
Target Describes a
RevisionTarget
.- 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.
- Secondary
Cluster Info The AvailabilityZone and ClusterNodes information of the secondary compute unit.
- Serverless
Identifier The identifier for a serverless namespace.
- Snapshot
Describes a snapshot.
- Snapshot
Copy Grant 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.
- Snapshot
Error Message Describes the errors returned by a snapshot.
- 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.- Tag
A tag consisting of a name/value pair for a resource.
- Tagged
Resource A tag and its associated resource.
- Update
Target A maintenance track that you can switch the current track to.
- Usage
Limit Describes a usage limit object for a cluster.
- 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§
- Action
Type - 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. - Aqua
Configuration Status - 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. - Aqua
Status - 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. - Authorization
Status - 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. - Data
Share Status - 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. - Data
Share Status ForConsumer - 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. - Data
Share Status ForProducer - 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. - Data
Share Type - 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. - Describe
Integrations Filter Name - 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. - Impact
Ranking Type - 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. - Lake
Formation Scope Union A list of scopes set up for Lake Formation integration.
- LogDestination
Type - 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. - Namespace
Identifier Union Object to store union of values for a provisioned cluster or serverless namespace’s identifier.
- Namespace
Registration Status - 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. - Node
Configuration Options Filter Name - 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. - Operator
Type - 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. - Parameter
Apply Type - 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. - Partner
Integration Status - 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. - Recommended
Action Type - 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. - Reserved
Node Exchange Action Type - 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. - Reserved
Node Exchange Status Type - 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. - Reserved
Node Offering Type - 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. - S3Access
Grants Scope Union A list of scopes set up for S3 Access Grants integration.
- Schedule
State - 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. - Scheduled
Action Filter Name - 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. - Scheduled
Action State - 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. - Scheduled
Action Type Values - 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. - Service
Authorization - 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. - Service
Integrations Union A list of service integrations.
- Snapshot
Attribute ToSort By - 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. - Sort
ByOrder - 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. - Source
Type - 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. - Table
Restore Status Type - 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. - Usage
Limit Breach Action - 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. - Usage
Limit Feature Type - 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. - Usage
Limit Limit Type - 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. - Usage
Limit Period - 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. - Zero
EtlIntegration Status - 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.