aws redshift
Overview This is an interface reference for Amazon Redshift. AWS CLI reference
145 commands Its page in the AWS CLI reference
Commands
accept-reserved-node-exchangeExchanges 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.add-partnerAdds a partner integration to a cluster.associate-data-share-consumerFrom a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn).authorize-cluster-security-group-ingressAdds an inbound (ingress) rule to an Amazon Redshift security group.authorize-data-shareFrom a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities.authorize-endpoint-accessGrants access to a cluster.authorize-snapshot-accessAuthorizes the specified Amazon Web Services account to restore the specified snapshot.batch-delete-cluster-snapshotsDeletes a set of cluster snapshots.batch-modify-cluster-snapshotsModifies the settings for a set of cluster snapshots.cancel-resizeCancels a resize operation for a cluster.copy-cluster-snapshotCopies the specified automated cluster snapshot to a new manual cluster snapshot.create-authentication-profileCreates an authentication profile with the specified parameters.create-clusterCreates a new cluster with the specified parameters.create-cluster-parameter-groupCreates an Amazon Redshift parameter group.create-cluster-security-groupCreates a new Amazon Redshift security group.create-cluster-snapshotCreates a manual snapshot of the specified cluster.create-cluster-subnet-groupCreates a new Amazon Redshift subnet group.create-custom-domain-associationUsed to create a custom domain name for a cluster.create-endpoint-accessCreates a Redshift-managed VPC endpoint.create-event-subscriptionCreates an Amazon Redshift event notification subscription.create-hsm-client-certificateCreates 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.create-hsm-configurationCreates 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).create-integrationCreates a zero-ETL integration or S3 event integration with Amazon Redshift.create-qev2-idc-applicationCreates an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.create-redshift-idc-applicationCreates an Amazon Redshift application for use with IAM Identity Center.create-scheduled-actionCreates a scheduled action.create-snapshot-copy-grantCreates 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.create-snapshot-scheduleCreate a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.create-tagsAdds tags to a cluster.create-usage-limitCreates a usage limit for a specified Amazon Redshift feature on a cluster.deauthorize-data-shareFrom a datashare producer account, removes authorization from the specified datashare.delete-authentication-profileDeletes an authentication profile.delete-clusterDeletes a previously provisioned cluster without its final snapshot being created.delete-cluster-parameter-groupDeletes a specified Amazon Redshift parameter group.delete-cluster-security-groupDeletes an Amazon Redshift security group.delete-cluster-snapshotDeletes the specified manual snapshot.delete-cluster-subnet-groupDeletes the specified cluster subnet group.delete-custom-domain-associationContains information about deleting a custom domain association for a cluster.delete-endpoint-accessDeletes a Redshift-managed VPC endpoint.delete-event-subscriptionDeletes an Amazon Redshift event notification subscription.delete-hsm-client-certificateDeletes the specified HSM client certificate.delete-hsm-configurationDeletes the specified Amazon Redshift HSM configuration.delete-integrationDeletes a zero-ETL integration or S3 event integration with Amazon Redshift.delete-partnerDeletes a partner integration from a cluster.delete-qev2-idc-applicationDeletes an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.delete-redshift-idc-applicationDeletes an Amazon Redshift IAM Identity Center application.delete-resource-policyDeletes the resource policy for a specified resource.delete-scheduled-actionDeletes a scheduled action.delete-snapshot-copy-grantDeletes the specified snapshot copy grant.delete-snapshot-scheduleDeletes a snapshot schedule.delete-tagsDeletes tags from a resource.delete-usage-limitDeletes a usage limit from a cluster.deregister-namespaceDeregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog.describe-account-attributesReturns a list of attributes attached to an accountdescribe-authentication-profilesDescribes an authentication profile.describe-cluster-db-revisionsReturns an array of ClusterDbRevision objects.describe-cluster-parameter-groupsReturns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.describe-cluster-parametersReturns a detailed list of parameters contained within the specified Amazon Redshift parameter group.describe-cluster-security-groupsReturns information about Amazon Redshift security groups.describe-cluster-snapshotsReturns one or more snapshot objects, which contain metadata about your cluster snapshots.describe-cluster-subnet-groupsReturns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.describe-cluster-tracksReturns a list of all the available maintenance tracks.describe-cluster-versionsReturns descriptions of the available Amazon Redshift cluster versions.describe-clustersReturns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties.describe-custom-domain-associationsContains information about custom domain associations for a cluster.describe-data-sharesShows the status of any inbound or outbound datashares available in the specified account.describe-data-shares-for-consumerReturns a list of datashares where the account identifier being called is a consumer account identifier.describe-data-shares-for-producerReturns a list of datashares when the account identifier being called is a producer account identifier.describe-default-cluster-parametersReturns a list of parameter settings for the specified parameter group family.describe-endpoint-accessDescribes a Redshift-managed VPC endpoint.describe-endpoint-authorizationDescribes an endpoint authorization.describe-event-categoriesDisplays a list of event categories for all event source types, or for a specified source type.describe-event-subscriptionsLists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.describe-eventsReturns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.describe-hsm-client-certificatesReturns information about the specified HSM client certificate.describe-hsm-configurationsReturns information about the specified Amazon Redshift HSM configuration.describe-inbound-integrationsReturns a list of inbound integrations.describe-integrationsDescribes one or more zero-ETL or S3 event integrations with Amazon Redshift.describe-logging-statusDescribes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.describe-node-configuration-optionsReturns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.describe-orderable-cluster-optionsReturns a list of orderable cluster options.describe-partnersReturns information about the partner integrations defined for a cluster.describe-qev2-idc-applicationsLists the Amazon Redshift Query Editor (QEV2) IAM Identity Center applications.describe-redshift-idc-applicationsLists the Amazon Redshift IAM Identity Center applications.describe-reserved-node-exchange-statusReturns exchange status details and associated metadata for a reserved-node exchange.describe-reserved-node-offeringsReturns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.describe-reserved-nodesReturns the descriptions of the reserved nodes.describe-resizeReturns information about the last resize operation for the specified cluster.describe-scheduled-actionsDescribes properties of scheduled actions.describe-snapshot-copy-grantsReturns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.describe-snapshot-schedulesReturns a list of snapshot schedules.describe-storageReturns account level backups storage size and provisional storage.describe-table-restore-statusLists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action.describe-tagsReturns a list of tags.describe-usage-limitsShows usage limits on a cluster.disable-loggingStops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.disable-snapshot-copyDisables the automatic copying of snapshots from one region to another region for a specified cluster.disassociate-data-share-consumerFrom a datashare consumer account, remove association for the specified datashare.enable-loggingStarts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.enable-snapshot-copyEnables the automatic copy of snapshots from one region to another region for a specified cluster.failover-primary-computeFails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.get-cluster-credentialsReturns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database.get-cluster-credentials-with-iamReturns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database.get-identity-center-auth-tokenGenerates an encrypted authentication token that propagates the caller's Amazon Web Services IAM Identity Center identity to Amazon Redshift clusters.get-reserved-node-exchange-configuration-optionsGets the configuration options for the reserved-node exchange.get-reserved-node-exchange-offeringsReturns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.get-resource-policyGet the resource policy for a specified resource.list-recommendationsList the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.modify-aqua-configurationThis operation is retired.modify-authentication-profileModifies an authentication profile.modify-clusterModifies the settings for a cluster.modify-cluster-db-revisionModifies the database revision of a cluster.modify-cluster-iam-rolesModifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.modify-cluster-maintenanceModifies the maintenance settings of a cluster.modify-cluster-parameter-groupModifies the parameters of a parameter group.modify-cluster-snapshotModifies the settings for a snapshot.modify-cluster-snapshot-scheduleModifies a snapshot schedule for a cluster.modify-cluster-subnet-groupModifies a cluster subnet group to include the specified list of VPC subnets.modify-custom-domain-associationContains information for changing a custom domain association.modify-endpoint-accessModifies a Redshift-managed VPC endpoint.modify-event-subscriptionModifies an existing Amazon Redshift event notification subscription.modify-integrationModifies a zero-ETL integration or S3 event integration with Amazon Redshift.modify-lakehouse-configurationModifies the lakehouse configuration for a cluster.modify-qev2-idc-applicationModifies an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.modify-redshift-idc-applicationChanges an existing Amazon Redshift IAM Identity Center application.modify-scheduled-actionModifies a scheduled action.modify-snapshot-copy-retention-periodModifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.modify-snapshot-scheduleModifies a snapshot schedule.modify-usage-limitModifies a usage limit in a cluster.pause-clusterPauses a cluster.purchase-reserved-node-offeringAllows you to purchase reserved nodes.put-resource-policyUpdates the resource policy for a specified resource.reboot-clusterReboots a cluster.register-namespaceRegisters a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.reject-data-shareFrom a datashare consumer account, rejects the specified datashare.reset-cluster-parameter-groupSets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default".resize-clusterChanges the size of the cluster.restore-from-cluster-snapshotCreates a new cluster from a snapshot.restore-table-from-cluster-snapshotCreates a new table from a table in an Amazon Redshift cluster snapshot.resume-clusterResumes a paused cluster.revoke-cluster-security-group-ingressRevokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group.revoke-endpoint-accessRevokes access to a cluster.revoke-snapshot-accessRemoves the ability of the specified Amazon Web Services account to restore the specified snapshot.rotate-encryption-keyRotates the encryption keys for a cluster.update-partner-statusUpdates the status of a partner integration.