AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <RedshiftClient.h>
<fullname>Amazon Redshift</fullname>
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.
Definition at line 43 of file RedshiftClient.h.
Definition at line 46 of file RedshiftClient.h.
Definition at line 50 of file RedshiftClient.h.
Definition at line 51 of file RedshiftClient.h.
Aws::Redshift::RedshiftClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Redshift::RedshiftClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Redshift::RedshiftClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.
nullptr
An Async wrapper for AcceptReservedNodeExchange that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 130 of file RedshiftClient.h.
A Callable wrapper for AcceptReservedNodeExchange that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 121 of file RedshiftClient.h.
Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website.
nullptr
An Async wrapper for AddPartner that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 158 of file RedshiftClient.h.
A Callable wrapper for AddPartner that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 149 of file RedshiftClient.h.
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.
nullptr
An Async wrapper for AssociateDataShareConsumer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 186 of file RedshiftClient.h.
A Callable wrapper for AssociateDataShareConsumer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 177 of file RedshiftClient.h.
Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same Amazon Web Services Region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for AuthorizeClusterSecurityGroupIngress that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 229 of file RedshiftClient.h.
A Callable wrapper for AuthorizeClusterSecurityGroupIngress that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 220 of file RedshiftClient.h.
From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access permissions.
nullptr
An Async wrapper for AuthorizeDataShare that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 257 of file RedshiftClient.h.
A Callable wrapper for AuthorizeDataShare that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 248 of file RedshiftClient.h.
nullptr
An Async wrapper for AuthorizeEndpointAccess that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 282 of file RedshiftClient.h.
A Callable wrapper for AuthorizeEndpointAccess that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 273 of file RedshiftClient.h.
Authorizes the specified Amazon Web Services account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for AuthorizeSnapshotAccess that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 311 of file RedshiftClient.h.
A Callable wrapper for AuthorizeSnapshotAccess that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 302 of file RedshiftClient.h.
nullptr
An Async wrapper for BatchDeleteClusterSnapshots that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 336 of file RedshiftClient.h.
A Callable wrapper for BatchDeleteClusterSnapshots that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 327 of file RedshiftClient.h.
nullptr
An Async wrapper for BatchModifyClusterSnapshots that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 362 of file RedshiftClient.h.
A Callable wrapper for BatchModifyClusterSnapshots that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 353 of file RedshiftClient.h.
nullptr
An Async wrapper for CancelResize that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 387 of file RedshiftClient.h.
A Callable wrapper for CancelResize that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 378 of file RedshiftClient.h.
Converts any request object to a presigned URL with the GET method, using region for the signer and a timeout of 15 minutes.
Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for CopyClusterSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 422 of file RedshiftClient.h.
A Callable wrapper for CopyClusterSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 413 of file RedshiftClient.h.
nullptr
An Async wrapper for CreateAuthenticationProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 448 of file RedshiftClient.h.
A Callable wrapper for CreateAuthenticationProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 439 of file RedshiftClient.h.
Creates a new cluster with the specified parameters.
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for CreateCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 480 of file RedshiftClient.h.
A Callable wrapper for CreateCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 471 of file RedshiftClient.h.
Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for CreateClusterParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 514 of file RedshiftClient.h.
A Callable wrapper for CreateClusterParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 505 of file RedshiftClient.h.
Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for CreateClusterSecurityGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 544 of file RedshiftClient.h.
A Callable wrapper for CreateClusterSecurityGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 535 of file RedshiftClient.h.
Creates a manual snapshot of the specified cluster. The cluster must be in the available
state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for CreateClusterSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 574 of file RedshiftClient.h.
A Callable wrapper for CreateClusterSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 565 of file RedshiftClient.h.
Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for CreateClusterSubnetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 605 of file RedshiftClient.h.
A Callable wrapper for CreateClusterSubnetGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 596 of file RedshiftClient.h.
Used to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the certificate Amazon Resource Name (ARN).
nullptr
An Async wrapper for CreateCustomDomainAssociation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 632 of file RedshiftClient.h.
A Callable wrapper for CreateCustomDomainAssociation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 623 of file RedshiftClient.h.
nullptr
An Async wrapper for CreateEndpointAccess that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 657 of file RedshiftClient.h.
A Callable wrapper for CreateEndpointAccess that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 648 of file RedshiftClient.h.
Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your Amazon Web Services account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your Amazon Web Services account. You must specify a source type if you specify a source ID.
nullptr
An Async wrapper for CreateEventSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 701 of file RedshiftClient.h.
A Callable wrapper for CreateEventSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 692 of file RedshiftClient.h.
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for CreateHsmClientCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 735 of file RedshiftClient.h.
A Callable wrapper for CreateHsmClientCertificate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 726 of file RedshiftClient.h.
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for CreateHsmConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 768 of file RedshiftClient.h.
A Callable wrapper for CreateHsmConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 759 of file RedshiftClient.h.
Creates a zero-ETL integration or S3 event integration with Amazon Redshift.
nullptr
An Async wrapper for CreateIntegration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 794 of file RedshiftClient.h.
A Callable wrapper for CreateIntegration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 785 of file RedshiftClient.h.
Creates an Amazon Redshift application for use with IAM Identity Center.
nullptr
An Async wrapper for CreateRedshiftIdcApplication that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 820 of file RedshiftClient.h.
A Callable wrapper for CreateRedshiftIdcApplication that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 811 of file RedshiftClient.h.
Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster
API operation.
nullptr
An Async wrapper for CreateScheduledAction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 847 of file RedshiftClient.h.
A Callable wrapper for CreateScheduledAction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 838 of file RedshiftClient.h.
Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for CreateSnapshotCopyGrant that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 878 of file RedshiftClient.h.
A Callable wrapper for CreateSnapshotCopyGrant that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 869 of file RedshiftClient.h.
{}
)
const
Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
nullptr
,
{}
An Async wrapper for CreateSnapshotSchedule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 904 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for CreateSnapshotSchedule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 895 of file RedshiftClient.h.
Adds tags to a cluster.
A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
nullptr
An Async wrapper for CreateTags that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 933 of file RedshiftClient.h.
A Callable wrapper for CreateTags that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 924 of file RedshiftClient.h.
Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
nullptr
An Async wrapper for CreateUsageLimit that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 960 of file RedshiftClient.h.
A Callable wrapper for CreateUsageLimit that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 951 of file RedshiftClient.h.
From a datashare producer account, removes authorization from the specified datashare.
nullptr
An Async wrapper for DeauthorizeDataShare that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 986 of file RedshiftClient.h.
A Callable wrapper for DeauthorizeDataShare that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 977 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteAuthenticationProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1011 of file RedshiftClient.h.
A Callable wrapper for DeleteAuthenticationProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1002 of file RedshiftClient.h.
Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false
and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for DeleteCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1052 of file RedshiftClient.h.
A Callable wrapper for DeleteCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1043 of file RedshiftClient.h.
Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
nullptr
An Async wrapper for DeleteClusterParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1079 of file RedshiftClient.h.
A Callable wrapper for DeleteClusterParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1070 of file RedshiftClient.h.
Deletes an Amazon Redshift security group.
You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for DeleteClusterSecurityGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1110 of file RedshiftClient.h.
A Callable wrapper for DeleteClusterSecurityGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1101 of file RedshiftClient.h.
Deletes the specified manual snapshot. The snapshot must be in the available
state, with no other users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
nullptr
An Async wrapper for DeleteClusterSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1142 of file RedshiftClient.h.
A Callable wrapper for DeleteClusterSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1133 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteClusterSubnetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1167 of file RedshiftClient.h.
A Callable wrapper for DeleteClusterSubnetGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1158 of file RedshiftClient.h.
Contains information about deleting a custom domain association for a cluster.
nullptr
An Async wrapper for DeleteCustomDomainAssociation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1193 of file RedshiftClient.h.
A Callable wrapper for DeleteCustomDomainAssociation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1184 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteEndpointAccess that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1218 of file RedshiftClient.h.
A Callable wrapper for DeleteEndpointAccess that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1209 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteEventSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1244 of file RedshiftClient.h.
A Callable wrapper for DeleteEventSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1235 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteHsmClientCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1269 of file RedshiftClient.h.
A Callable wrapper for DeleteHsmClientCertificate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1260 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteHsmConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1295 of file RedshiftClient.h.
A Callable wrapper for DeleteHsmConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1286 of file RedshiftClient.h.
Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.
nullptr
An Async wrapper for DeleteIntegration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1321 of file RedshiftClient.h.
A Callable wrapper for DeleteIntegration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1312 of file RedshiftClient.h.
Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.
nullptr
An Async wrapper for DeletePartner that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1348 of file RedshiftClient.h.
A Callable wrapper for DeletePartner that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1339 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteRedshiftIdcApplication that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1374 of file RedshiftClient.h.
A Callable wrapper for DeleteRedshiftIdcApplication that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1365 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteResourcePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1400 of file RedshiftClient.h.
A Callable wrapper for DeleteResourcePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1391 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteScheduledAction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1425 of file RedshiftClient.h.
A Callable wrapper for DeleteScheduledAction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1416 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteSnapshotCopyGrant that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1450 of file RedshiftClient.h.
A Callable wrapper for DeleteSnapshotCopyGrant that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1441 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteSnapshotSchedule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1475 of file RedshiftClient.h.
A Callable wrapper for DeleteSnapshotSchedule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1466 of file RedshiftClient.h.
Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
nullptr
An Async wrapper for DeleteTags that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1501 of file RedshiftClient.h.
A Callable wrapper for DeleteTags that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1492 of file RedshiftClient.h.
nullptr
An Async wrapper for DeleteUsageLimit that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1526 of file RedshiftClient.h.
A Callable wrapper for DeleteUsageLimit that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1517 of file RedshiftClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeAccountAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1552 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeAccountAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1543 of file RedshiftClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeAuthenticationProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1577 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeAuthenticationProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1568 of file RedshiftClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeClusterDbRevisions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1603 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeClusterDbRevisions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1594 of file RedshiftClient.h.
{}
)
const
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all parameter groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
nullptr
,
{}
An Async wrapper for DescribeClusterParameterGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1643 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeClusterParameterGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1634 of file RedshiftClient.h.
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for DescribeClusterParameters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1679 of file RedshiftClient.h.
A Callable wrapper for DescribeClusterParameters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1670 of file RedshiftClient.h.
{}
)
const
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all clusters that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
nullptr
,
{}
An Async wrapper for DescribeClusters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1886 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeClusters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1877 of file RedshiftClient.h.
{}
)
const
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all security groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
nullptr
,
{}
An Async wrapper for DescribeClusterSecurityGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1718 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeClusterSecurityGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1709 of file RedshiftClient.h.
{}
)
const
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
nullptr
,
{}
An Async wrapper for DescribeClusterSnapshots that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1756 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeClusterSnapshots that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1747 of file RedshiftClient.h.
{}
)
const
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all subnet groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
nullptr
,
{}
An Async wrapper for DescribeClusterSubnetGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1791 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeClusterSubnetGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1782 of file RedshiftClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeClusterTracks that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1817 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeClusterTracks that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1808 of file RedshiftClient.h.
{}
)
const
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
nullptr
,
{}
An Async wrapper for DescribeClusterVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1848 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeClusterVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1839 of file RedshiftClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeCustomDomainAssociations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1912 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeCustomDomainAssociations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1903 of file RedshiftClient.h.
{}
)
const
Shows the status of any inbound or outbound datashares available in the specified account.
nullptr
,
{}
An Async wrapper for DescribeDataShares that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1938 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeDataShares that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1929 of file RedshiftClient.h.
{}
)
const
Returns a list of datashares where the account identifier being called is a consumer account identifier.
nullptr
,
{}
An Async wrapper for DescribeDataSharesForConsumer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1964 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeDataSharesForConsumer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1955 of file RedshiftClient.h.
{}
)
const
Returns a list of datashares when the account identifier being called is a producer account identifier.
nullptr
,
{}
An Async wrapper for DescribeDataSharesForProducer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1990 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeDataSharesForProducer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1981 of file RedshiftClient.h.
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
nullptr
An Async wrapper for DescribeDefaultClusterParameters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2020 of file RedshiftClient.h.
A Callable wrapper for DescribeDefaultClusterParameters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2011 of file RedshiftClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeEndpointAccess that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2045 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeEndpointAccess that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2036 of file RedshiftClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeEndpointAuthorization that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2070 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeEndpointAuthorization that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2061 of file RedshiftClient.h.
{}
)
const
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
nullptr
,
{}
An Async wrapper for DescribeEventCategories that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2099 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeEventCategories that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2090 of file RedshiftClient.h.
{}
)
const
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
nullptr
,
{}
An Async wrapper for DescribeEvents that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2163 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeEvents that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2154 of file RedshiftClient.h.
{}
)
const
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
nullptr
,
{}
An Async wrapper for DescribeEventSubscriptions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2134 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeEventSubscriptions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2125 of file RedshiftClient.h.
{}
)
const
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
nullptr
,
{}
An Async wrapper for DescribeHsmClientCertificates that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2198 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeHsmClientCertificates that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2189 of file RedshiftClient.h.
{}
)
const
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all HSM connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
nullptr
,
{}
An Async wrapper for DescribeHsmConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2233 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeHsmConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2224 of file RedshiftClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeInboundIntegrations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2258 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeInboundIntegrations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2249 of file RedshiftClient.h.
{}
)
const
Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.
nullptr
,
{}
An Async wrapper for DescribeIntegrations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2284 of file RedshiftClient.h.
{}
)
const
A Callable wrapper for DescribeIntegrations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2275 of file RedshiftClient.h.
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
nullptr
An Async wrapper for DescribeLoggingStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2311 of file RedshiftClient.h.
A Callable wrapper for DescribeLoggingStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2302 of file RedshiftClient.h.
Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
nullptr
An Async wrapper for DescribeNodeConfigurationOptions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2338 of file RedshiftClient.h.
A Callable wrapper for DescribeNodeConfigurationOptions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2329 of file RedshiftClient.h.
{}
)
const
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
nullptr
,
{}
An Async wrapper for DescribeOrderableClusterOptions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2372 of file RedshiftClient.h.