There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Amazon Redshift examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Amazon Redshift.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `accept-reserved-node-exchange`
The following code example shows how to use `accept-reserved-node-exchange`.
**AWS CLI**
**To accept reserved node exchange**
The following `accept-reserved-node-exchange` example accepts exchange of a DC1 reserved node for a DC2 reserved node.
```
aws redshift accept-reserved-node-exchange /
--reserved-node-id 12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE /
--target-reserved-node-offering-id 12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE
```
Output:
```
{
"ExchangedReservedNode": {
"ReservedNodeId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE",
"ReservedNodeOfferingId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE",
"NodeType": "dc2.large",
"StartTime": "2019-12-06T21:17:26Z",
"Duration": 31536000,
"FixedPrice": 0.0,
"UsagePrice": 0.0,
"CurrencyCode": "USD",
"NodeCount": 1,
"State": "exchanging",
"OfferingType": "All Upfront",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.0,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedNodeOfferingType": "Regular"
}
}
```
For more information, see [Upgrading Reserved Nodes With the AWS CLI](https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-offering-console.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [AcceptReservedNodeExchange](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/accept-reserved-node-exchange.html) in *AWS CLI Command Reference*.
### `authorize-cluster-security-group-ingress`
The following code example shows how to use `authorize-cluster-security-group-ingress`.
**AWS CLI**
Authorizing Access to an EC2 Security GroupThis example authorizes access to a named Amazon EC2 security group.Command:
```
aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --ec2-security-group-name myec2securitygroup --ec2-security-group-owner-id 123445677890
```
Authorizing Access to a CIDR rangeThis example authorizes access to a CIDR range.Command:
```
aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --cidrip 192.168.100.100/32
```
+ For API details, see [AuthorizeClusterSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/authorize-cluster-security-group-ingress.html) in *AWS CLI Command Reference*.
### `authorize-snapshot-access`
The following code example shows how to use `authorize-snapshot-access`.
**AWS CLI**
Authorize an AWS Account to Restore a SnapshotThis example authorizes the AWS account `444455556666` to restore the snapshot `my-snapshot-id`. By default, the output is in JSON format.Command:
```
aws redshift authorize-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666
```
Result:
```
{
"Snapshot": {
"Status": "available",
"SnapshotCreateTime": "2013-07-17T22:04:18.947Z",
"EstimatedSecondsToCompletion": 0,
"AvailabilityZone": "us-east-1a",
"ClusterVersion": "1.0",
"MasterUsername": "adminuser",
"Encrypted": false,
"OwnerAccount": "111122223333",
"BackupProgressInMegabytes": 11.0,
"ElapsedTimeInSeconds": 0,
"DBName": "dev",
"CurrentBackupRateInMegabytesPerSecond: 0.1534,
"ClusterCreateTime": "2013-01-22T21:59:29.559Z",
"ActualIncrementalBackupSizeInMegabytes"; 11.0,
"SnapshotType": "manual",
"NodeType": "dw.hs1.xlarge",
"ClusterIdentifier": "mycluster",
"TotalBackupSizeInMegabytes": 20.0,
"Port": 5439,
"NumberOfNodes": 2,
"SnapshotIdentifier": "my-snapshot-id"
}
}
```
+ For API details, see [AuthorizeSnapshotAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/authorize-snapshot-access.html) in *AWS CLI Command Reference*.
### `batch-delete-cluster-snapshots`
The following code example shows how to use `batch-delete-cluster-snapshots`.
**AWS CLI**
**To delete a set of cluster snapshots**
The following `batch-delete-cluster-snapshots` example deletes a set of manual cluster snapshots.
```
aws redshift batch-delete-cluster-snapshots \
--identifiers SnapshotIdentifier=mycluster-2019-11-06-14-12 SnapshotIdentifier=mycluster-2019-11-06-14-20
```
Output:
```
{
"Resources": [
"mycluster-2019-11-06-14-12",
"mycluster-2019-11-06-14-20"
]
}
```
For more information, see [Amazon Redshift Snapshots](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [BatchDeleteClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/batch-delete-cluster-snapshots.html) in *AWS CLI Command Reference*.
### `batch-modify-cluster-snapshots`
The following code example shows how to use `batch-modify-cluster-snapshots`.
**AWS CLI**
**To modify a set of cluster snapshots**
The following `batch-modify-cluster-snapshots` example modifies the settings for a set of cluster snapshots.
```
aws redshift batch-modify-cluster-snapshots \
--snapshot-identifier-list mycluster-2019-11-06-16-31 mycluster-2019-11-06-16-32 \
--manual-snapshot-retention-period 30
```
Output:
```
{
"Resources": [
"mycluster-2019-11-06-16-31",
"mycluster-2019-11-06-16-32"
],
"Errors": [],
"ResponseMetadata": {
"RequestId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE",
"HTTPStatusCode": 200,
"HTTPHeaders": {
"x-amzn-requestid": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE,
"content-type": "text/xml",
"content-length": "480",
"date": "Sat, 07 Dec 2019 00:36:09 GMT",
"connection": "keep-alive"
},
"RetryAttempts": 0
}
}
```
For more information, see [Amazon Redshift Snapshots](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [BatchModifyClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/batch-modify-cluster-snapshots.html) in *AWS CLI Command Reference*.
### `cancel-resize`
The following code example shows how to use `cancel-resize`.
**AWS CLI**
**To cancel resize of a cluster**
The following `cancel-resize` example cancels a classic resize operation for a cluster.
```
aws redshift cancel-resize \
--cluster-identifier mycluster
```
Output:
```
{
"TargetNodeType": "dc2.large",
"TargetNumberOfNodes": 2,
"TargetClusterType": "multi-node",
"Status": "CANCELLING",
"ResizeType": "ClassicResize",
"TargetEncryptionType": "NONE"
}
```
For more information, see [Resizing Clusters in Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [CancelResize](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/cancel-resize.html) in *AWS CLI Command Reference*.
### `copy-cluster-snapshot`
The following code example shows how to use `copy-cluster-snapshot`.
**AWS CLI**
Get a Description of All Cluster VersionsThis example returns a description of all cluster versions. By default, the output is in JSON format.Command:
```
aws redshift copy-cluster-snapshot --source-snapshot-identifier cm:examplecluster-2013-01-22-19-27-58 --target-snapshot-identifier my-saved-snapshot-copy
```
Result:
```
{
"Snapshot": {
"Status": "available",
"SnapshotCreateTime": "2013-01-22T19:27:58.931Z",
"AvailabilityZone": "us-east-1c",
"ClusterVersion": "1.0",
"MasterUsername": "adminuser",
"DBName": "dev",
"ClusterCreateTime": "2013-01-22T19:23:59.368Z",
"SnapshotType": "manual",
"NodeType": "dw.hs1.xlarge",
"ClusterIdentifier": "examplecluster",
"Port": 5439,
"NumberOfNodes": "2",
"SnapshotIdentifier": "my-saved-snapshot-copy"
},
"ResponseMetadata": {
"RequestId": "3b279691-64e3-11e2-bec0-17624ad140dd"
}
}
```
+ For API details, see [CopyClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/copy-cluster-snapshot.html) in *AWS CLI Command Reference*.
### `create-cluster-parameter-group`
The following code example shows how to use `create-cluster-parameter-group`.
**AWS CLI**
Create a Cluster Parameter GroupThis example creates a new cluster parameter group.Command:
```
aws redshift create-cluster-parameter-group --parameter-group-name myclusterparametergroup --parameter-group-family redshift-1.0 --description "My first cluster parameter group"
```
Result:
```
{
"ClusterParameterGroup": {
"ParameterGroupFamily": "redshift-1.0",
"Description": "My first cluster parameter group",
"ParameterGroupName": "myclusterparametergroup"
},
"ResponseMetadata": {
"RequestId": "739448f0-64cc-11e2-8f7d-3b939af52818"
}
}
```
+ For API details, see [CreateClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-parameter-group.html) in *AWS CLI Command Reference*.
### `create-cluster-security-group`
The following code example shows how to use `create-cluster-security-group`.
**AWS CLI**
Creating a Cluster Security GroupThis example creates a new cluster security group. By default, the output is in JSON format.Command:
```
aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group"
```
Result:
```
{
"create_cluster_security_group_response": {
"create_cluster_security_group_result": {
"cluster_security_group": {
"description": "This is my cluster security group",
"owner_id": "300454760768",
"cluster_security_group_name": "mysecuritygroup",
"ec2_security_groups": \[],
"ip_ranges": \[]
}
},
"response_metadata": {
"request_id": "5df486a0-343a-11e2-b0d8-d15d0ef48549"
}
}
}
```
You can also obtain the same information in text format using the `--output text` option.Command:
`--output text` option.Command:
option.Command:
```
aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group" --output text
```
Result:
```
This is my cluster security group 300454760768 mysecuritygroup
a0c0bfab-343a-11e2-95d2-c3dc9fe8ab57
```
+ For API details, see [CreateClusterSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-security-group.html) in *AWS CLI Command Reference*.
### `create-cluster-snapshot`
The following code example shows how to use `create-cluster-snapshot`.
**AWS CLI**
Create a Cluster SnapshotThis example creates a new cluster snapshot. By default, the output is in JSON format.Command:
```
aws redshift create-cluster-snapshot --cluster-identifier mycluster --snapshot-identifier my-snapshot-id
```
Result:
```
{
"Snapshot": {
"Status": "creating",
"SnapshotCreateTime": "2013-01-22T22:20:33.548Z",
"AvailabilityZone": "us-east-1a",
"ClusterVersion": "1.0",
"MasterUsername": "adminuser",
"DBName": "dev",
"ClusterCreateTime": "2013-01-22T21:59:29.559Z",
"SnapshotType": "manual",
"NodeType": "dw.hs1.xlarge",
"ClusterIdentifier": "mycluster",
"Port": 5439,
"NumberOfNodes": "2",
"SnapshotIdentifier": "my-snapshot-id"
},
"ResponseMetadata": {
"RequestId": "f024d1a5-64e1-11e2-88c5-53eb05787dfb"
}
}
```
+ For API details, see [CreateClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-snapshot.html) in *AWS CLI Command Reference*.
### `create-cluster-subnet-group`
The following code example shows how to use `create-cluster-subnet-group`.
**AWS CLI**
Create a Cluster Subnet GroupThis example creates a new cluster subnet group.Command:
```
aws redshift create-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup --description "My subnet group" --subnet-ids subnet-763fdd1c
```
Result:
```
{
"ClusterSubnetGroup": {
"Subnets": [
{
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-763fdd1c",
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
}
} ],
"VpcId": "vpc-7e3fdd14",
"SubnetGroupStatus": "Complete",
"Description": "My subnet group",
"ClusterSubnetGroupName": "mysubnetgroup"
},
"ResponseMetadata": {
"RequestId": "500b8ce2-698f-11e2-9790-fd67517fb6fd"
}
}
```
+ For API details, see [CreateClusterSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-subnet-group.html) in *AWS CLI Command Reference*.
### `create-cluster`
The following code example shows how to use `create-cluster`.
**AWS CLI**
Create a Cluster with Minimal ParametersThis example creates a cluster with the minimal set of parameters. By default, the output is in JSON format.Command:
```
aws redshift create-cluster --node-type dw.hs1.xlarge --number-of-nodes 2 --master-username adminuser --master-user-password TopSecret1 --cluster-identifier mycluster
```
Result:
```
{
"Cluster": {
"NodeType": "dw.hs1.xlarge",
"ClusterVersion": "1.0",
"PubliclyAccessible": "true",
"MasterUsername": "adminuser",
"ClusterParameterGroups": [
{
"ParameterApplyStatus": "in-sync",
"ParameterGroupName": "default.redshift-1.0"
} ],
"ClusterSecurityGroups": [
{
"Status": "active",
"ClusterSecurityGroupName": "default"
} ],
"AllowVersionUpgrade": true,
"VpcSecurityGroups": \[],
"PreferredMaintenanceWindow": "sat:03:30-sat:04:00",
"AutomatedSnapshotRetentionPeriod": 1,
"ClusterStatus": "creating",
"ClusterIdentifier": "mycluster",
"DBName": "dev",
"NumberOfNodes": 2,
"PendingModifiedValues": {
"MasterUserPassword": "\****"
}
},
"ResponseMetadata": {
"RequestId": "7cf4bcfc-64dd-11e2-bea9-49e0ce183f07"
}
}
```
+ For API details, see [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster.html) in *AWS CLI Command Reference*.
### `create-event-subscription`
The following code example shows how to use `create-event-subscription`.
**AWS CLI**
**To create a notification subscription for an event**
The following `create-event-subscription` example creates an event notification subscription.
```
aws redshift create-event-subscription \
--subscription-name mysubscription \
--sns-topic-arn arn:aws:sns:us-west-2:123456789012:MySNStopic \
--source-type cluster \
--source-ids mycluster
```
Output:
```
{
"EventSubscription": {
"CustomerAwsId": "123456789012",
"CustSubscriptionId": "mysubscription",
"SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:MySNStopic",
"Status": "active",
"SubscriptionCreationTime": "2019-12-09T20:05:19.365Z",
"SourceType": "cluster",
"SourceIdsList": [
"mycluster"
],
"EventCategoriesList": [],
"Severity": "INFO",
"Enabled": true,
"Tags": []
}
}
```
For more information, see [Subscribing to Amazon Redshift Event Notifications](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [CreateEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-event-subscription.html) in *AWS CLI Command Reference*.
### `create-hsm-client-certificate`
The following code example shows how to use `create-hsm-client-certificate`.
**AWS CLI**
**To create an HSM client certificate**
The following `create-hsm-client-certificate` example generates an HSM client certificate that a cluster can use to connect to an HSM.
```
aws redshift create-hsm-client-certificate \
--hsm-client-certificate-identifier myhsmclientcert
```
Output:
```
{
"HsmClientCertificate": {
"HsmClientCertificateIdentifier": "myhsmclientcert",
"HsmClientCertificatePublicKey": "-----BEGIN CERTIFICATE-----
MIICiEXAMPLECQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTEXAMPLEwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25EXAMPLEIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb2EXAMPLETEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBEXAMPLEMRAwDgYD
EXAMPLETZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAEXAMPLEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKEXAMPLEAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk6EXAMPLE3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugEXAMPLEzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEEXAMPLEEAtCu4
nUhVVxYUEXAMPLEh8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GEXAMPLEl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rEXAMPLE=-----END CERTIFICATE-----\n",
"Tags": []
}
}
```
For more information, see [Amazon Redshift API Permissions Reference](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-policy-resources.resource-permissions.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [CreateHsmClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-hsm-client-certificate.html) in *AWS CLI Command Reference*.
### `create-hsm-configuration`
The following code example shows how to use `create-hsm-configuration`.
**AWS CLI**
**To create an HSM configuration**
The following `create-hsm-configuration` example creates the specified HSM configuration that contains information required by a cluster to store and use database encryption keys in a hardware security module (HSM).
```
aws redshift create-hsm-configuration /
--hsm-configuration-identifier myhsmconnection
--description "My HSM connection"
--hsm-ip-address 192.0.2.09
--hsm-partition-name myhsmpartition /
--hsm-partition-password A1b2c3d4 /
--hsm-server-public-certificate myhsmclientcert
```
Output:
```
{
"HsmConfiguration": {
"HsmConfigurationIdentifier": "myhsmconnection",
"Description": "My HSM connection",
"HsmIpAddress": "192.0.2.09",
"HsmPartitionName": "myhsmpartition",
"Tags": []
}
}
```
+ For API details, see [CreateHsmConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-hsm-configuration.html) in *AWS CLI Command Reference*.
### `create-snapshot-copy-grant`
The following code example shows how to use `create-snapshot-copy-grant`.
**AWS CLI**
**To create a snapshot copy grant**
The following `create-snapshot-copy-grant` example creates a snapshot copy grant and encrypts copied snapshots in a destination AWS Region.
```
aws redshift create-snapshot-copy-grant \
--snapshot-copy-grant-name mysnapshotcopygrantname
```
Output:
```
{
"SnapshotCopyGrant": {
"SnapshotCopyGrantName": "mysnapshotcopygrantname",
"KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/bPxRfih3yCo8nvbEXAMPLEKEY",
"Tags": []
}
}
```
For more information, see [Amazon Redshift Database Encryption](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [CreateSnapshotCopyGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-snapshot-copy-grant.html) in *AWS CLI Command Reference*.
### `create-snapshot-schedule`
The following code example shows how to use `create-snapshot-schedule`.
**AWS CLI**
**To create snapshot schedule**
The following `create-snapshot-schedule` example creates a snapshot schedule with the specified description and a rate of every 12 hours.
```
aws redshift create-snapshot-schedule \
--schedule-definitions "rate(12 hours)" \
--schedule-identifier mysnapshotschedule \
--schedule-description "My schedule description"
```
Output:
```
{
"ScheduleDefinitions": [
"rate(12 hours)"
],
"ScheduleIdentifier": "mysnapshotschedule",
"ScheduleDescription": "My schedule description",
"Tags": []
}
```
For more information, see [Automated Snapshot Schedules](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html#automated-snapshot-schedules) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [CreateSnapshotSchedule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-snapshot-schedule.html) in *AWS CLI Command Reference*.
### `create-tags`
The following code example shows how to use `create-tags`.
**AWS CLI**
**To create tags for a cluster**
The following `create-tags` example adds the specified tag key/value pair to the specified cluster.
```
aws redshift create-tags \
--resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \
--tags "Key"="mytags","Value"="tag1"
```
This command does not produce any output.
For more information, see [Tagging Resources in Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-tagging.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [CreateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-tags.html) in *AWS CLI Command Reference*.
### `delete-cluster-parameter-group`
The following code example shows how to use `delete-cluster-parameter-group`.
**AWS CLI**
Delete a Cluster Parameter GroupThis example deletes a cluster parameter group.Command:
```
aws redshift delete-cluster-parameter-group --parameter-group-name myclusterparametergroup
```
+ For API details, see [DeleteClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-parameter-group.html) in *AWS CLI Command Reference*.
### `delete-cluster-security-group`
The following code example shows how to use `delete-cluster-security-group`.
**AWS CLI**
Delete a Cluster Security GroupThis example deletes a cluster security group.Command:
```
aws redshift delete-cluster-security-group --cluster-security-group-name mysecuritygroup
```
+ For API details, see [DeleteClusterSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-security-group.html) in *AWS CLI Command Reference*.
### `delete-cluster-snapshot`
The following code example shows how to use `delete-cluster-snapshot`.
**AWS CLI**
Delete a Cluster SnapshotThis example deletes a cluster snapshot.Command:
```
aws redshift delete-cluster-snapshot --snapshot-identifier my-snapshot-id
```
+ For API details, see [DeleteClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-snapshot.html) in *AWS CLI Command Reference*.
### `delete-cluster-subnet-group`
The following code example shows how to use `delete-cluster-subnet-group`.
**AWS CLI**
Delete a Cluster subnet GroupThis example deletes a cluster subnet group.Command:
```
aws redshift delete-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup
```
Result:
```
{
"ResponseMetadata": {
"RequestId": "253fbffd-6993-11e2-bc3a-47431073908a"
}
}
```
+ For API details, see [DeleteClusterSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-subnet-group.html) in *AWS CLI Command Reference*.
### `delete-cluster`
The following code example shows how to use `delete-cluster`.
**AWS CLI**
Delete a Cluster with No Final Cluster SnapshotThis example deletes a cluster, forcing data deletion so no final cluster snapshot is created.Command:
```
aws redshift delete-cluster --cluster-identifier mycluster --skip-final-cluster-snapshot
```
Delete a Cluster, Allowing a Final Cluster SnapshotThis example deletes a cluster, but specifies a final cluster snapshot.Command:
```
aws redshift delete-cluster --cluster-identifier mycluster --final-cluster-snapshot-identifier myfinalsnapshot
```
+ For API details, see [DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster.html) in *AWS CLI Command Reference*.
### `delete-event-subscription`
The following code example shows how to use `delete-event-subscription`.
**AWS CLI**
**To delete event subscription**
The following `delete-event-subscription` example deletes the specified event notification subscription.
```
aws redshift delete-event-subscription \
--subscription-name mysubscription
```
This command does not produce any output.
For more information, see [Subscribing to Amazon Redshift Event Notifications](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [DeleteEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-event-subscription.html) in *AWS CLI Command Reference*.
### `delete-hsm-client-certificate`
The following code example shows how to use `delete-hsm-client-certificate`.
**AWS CLI**
**To delete HSM client certificate**
The following `delete-hsm-client-certificate` example deletes an HSM client certificate.
```
aws redshift delete-hsm-client-certificate \
--hsm-client-certificate-identifier myhsmclientcert
```
This command does not produce any output.
For more information, see [Amazon Redshift API Permissions Reference](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-policy-resources.resource-permissions.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [DeleteHsmClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-hsm-client-certificate.html) in *AWS CLI Command Reference*.
### `delete-hsm-configuration`
The following code example shows how to use `delete-hsm-configuration`.
**AWS CLI**
**To delete an HSM configuration**
The following `delete-hsm-configuration` example deletes the specified HSM configuration from the current AWS account.
```
aws redshift delete-hsm-configuration /
--hsm-configuration-identifier myhsmconnection
```
This command does not produce any output.
+ For API details, see [DeleteHsmConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-hsm-configuration.html) in *AWS CLI Command Reference*.
### `delete-scheduled-action`
The following code example shows how to use `delete-scheduled-action`.
**AWS CLI**
**To delete scheduled action**
The following `delete-scheduled-action` example deletes the specified scheduled action.
```
aws redshift delete-scheduled-action \
--scheduled-action-name myscheduledaction
```
This command does not produce any output.
+ For API details, see [DeleteScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-scheduled-action.html) in *AWS CLI Command Reference*.
### `delete-snapshot-copy-grant`
The following code example shows how to use `delete-snapshot-copy-grant`.
**AWS CLI**
**To delete snapshot copy grant**
The following `delete-snapshot-copy-grant` example deletes the specified snapshot copy grant.
```
aws redshift delete-snapshot-copy-grant \
--snapshot-copy-grant-name mysnapshotcopygrantname
```
This command does not produce any output.
For more information, see [Amazon Redshift Database Encryption](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [DeleteSnapshotCopyGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-snapshot-copy-grant.html) in *AWS CLI Command Reference*.
### `delete-snapshot-schedule`
The following code example shows how to use `delete-snapshot-schedule`.
**AWS CLI**
**To delete snapshot schedule**
The following `delete-snapshot-schedule` example deletes the specified snapshot schedule. You must disassociate clusters before deleting the schedule.
```
aws redshift delete-snapshot-schedule \
--schedule-identifier mysnapshotschedule
```
This command does not produce any output.
For more information, see [Automated Snapshot Schedules](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html#automated-snapshot-schedules) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [DeleteSnapshotSchedule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-snapshot-schedule.html) in *AWS CLI Command Reference*.
### `delete-tags`
The following code example shows how to use `delete-tags`.
**AWS CLI**
**To delete tags from a cluster**
The following `delete-tags` example deletes the tags with the specified key names from the specified cluster.
```
aws redshift delete-tags \
--resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \
--tag-keys "clustertagkey" "clustertagvalue"
```
This command does not produce any output.
For more information, see [Tagging Resources in Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-tagging.html) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-tags.html) in *AWS CLI Command Reference*.
### `describe-account-attributes`
The following code example shows how to use `describe-account-attributes`.
**AWS CLI**
**To describe attributes of an AWS account**
The following `describe-account-attributes` example displays the attributes attached to the calling AWS account.
```
aws redshift describe-account-attributes
```
Output:
```
{
"AccountAttributes": [
{
"AttributeName": "max-defer-maintenance-duration",
"AttributeValues": [
{
"AttributeValue": "45"
}
]
}
]
}
```
+ For API details, see [DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-account-attributes.html) in *AWS CLI Command Reference*.
### `describe-cluster-db-revisions`
The following code example shows how to use `describe-cluster-db-revisions`.
**AWS CLI**
**To describe DB revisions for a cluster**
The following `describe-cluster-db-revisions` example displays the details of an array of `ClusterDbRevision` objects for the specified cluster.
```
aws redshift describe-cluster-db-revisions \
--cluster-identifier mycluster
```
Output:
```
{
"ClusterDbRevisions": [
{
"ClusterIdentifier": "mycluster",
"CurrentDatabaseRevision": "11420",
"DatabaseRevisionReleaseDate": "2019-11-22T16:43:49.597Z",
"RevisionTargets": []
}
]
}
```
+ For API details, see [DescribeClusterDbRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-db-revisions.html) in *AWS CLI Command Reference*.
### `describe-cluster-parameter-groups`
The following code example shows how to use `describe-cluster-parameter-groups`.
**AWS CLI**
Get a Description of All Cluster Parameter GroupsThis example returns a description of all cluster parameter groups for the account, with column headers. By default, the output is in JSON format.Command:
```
aws redshift describe-cluster-parameter-groups
```
Result:
```
{
"ParameterGroups": [
{
"ParameterGroupFamily": "redshift-1.0",
"Description": "My first cluster parameter group",
"ParameterGroupName": "myclusterparametergroup"
} ],
"ResponseMetadata": {
"RequestId": "8ceb8f6f-64cc-11e2-bea9-49e0ce183f07"
}
}
```
You can also obtain the same information in text format using the `--output text` option.Command:
`--output text` option.Command:
option.Command:
```
aws redshift describe-cluster-parameter-groups --output text
```
Result:
```
redshift-1.0 My first cluster parameter group myclusterparametergroup
RESPONSEMETADATA 9e665a36-64cc-11e2-8f7d-3b939af52818
```
+ For API details, see [DescribeClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-parameter-groups.html) in *AWS CLI Command Reference*.
### `describe-cluster-parameters`
The following code example shows how to use `describe-cluster-parameters`.
**AWS CLI**
Retrieve the Parameters for a Specified Cluster Parameter GroupThis example retrieves the parameters for the named parameter group. By default, the output is in JSON format.Command:
```
aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup
```
Result:
```
{
"Parameters": [
{
"Description": "Sets the display format for date and time values.",
"DataType": "string",
"IsModifiable": true,
"Source": "engine-default",
"ParameterValue": "ISO, MDY",
"ParameterName": "datestyle"
},
{
"Description": "Sets the number of digits displayed for floating-point values",
"DataType": "integer",
"IsModifiable": true,
"AllowedValues": "-15-2",
"Source": "engine-default",
"ParameterValue": "0",
"ParameterName": "extra_float_digits"
},
(...remaining output omitted...)
]
}
```
You can also obtain the same information in text format using the `--output text` option.Command:
`--output text` option.Command:
option.Command:
```
aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup --output text
```
Result:
```
RESPONSEMETADATA cdac40aa-64cc-11e2-9e70-918437dd236d
Sets the display format for date and time values. string True engine-default ISO, MDY datestyle
Sets the number of digits displayed for floating-point values integer True -15-2 engine-default 0 extra_float_digits
This parameter applies a user-defined label to a group of queries that are run during the same session.. string True engine-default default query_group
require ssl for all databaseconnections boolean True true,false engine-default false require_ssl
Sets the schema search order for names that are not schema-qualified. string True engine-default $user, public search_path
Aborts any statement that takes over the specified number of milliseconds. integer True engine-default 0 statement_timeout
wlm json configuration string True engine-default \[{"query_concurrency":5}] wlm_json_configuration
```
+ For API details, see [DescribeClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-parameters.html) in *AWS CLI Command Reference*.
### `describe-cluster-security-groups`
The following code example shows how to use `describe-cluster-security-groups`.
**AWS CLI**
Get a Description of All Cluster Security GroupsThis example returns a description of all cluster security groups for the account. By default, the output is in JSON format.Command:
```
aws redshift describe-cluster-security-groups
```
Result:
```
{
"ClusterSecurityGroups": [
{
"OwnerId": "100447751468",
"Description": "default",
"ClusterSecurityGroupName": "default",
"EC2SecurityGroups": \[],
"IPRanges": [
{
"Status": "authorized",
"CIDRIP": "0.0.0.0/0"
}
]
},
{
"OwnerId": "100447751468",
"Description": "This is my cluster security group",
"ClusterSecurityGroupName": "mysecuritygroup",
"EC2SecurityGroups": \[],
"IPRanges": \[]
},
(...remaining output omitted...)
]
}
```
+ For API details, see [DescribeClusterSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-security-groups.html) in *AWS CLI Command Reference*.
### `describe-cluster-snapshots`
The following code example shows how to use `describe-cluster-snapshots`.
**AWS CLI**
Get a Description of All Cluster SnapshotsThis example returns a description of all cluster snapshots for the account. By default, the output is in JSON format.Command:
```
aws redshift describe-cluster-snapshots
```
Result:
```
{
"Snapshots": [
{
"Status": "available",
"SnapshotCreateTime": "2013-07-17T22:02:22.852Z",
"EstimatedSecondsToCompletion": -1,
"AvailabilityZone": "us-east-1a",
"ClusterVersion": "1.0",
"MasterUsername": "adminuser",
"Encrypted": false,
"OwnerAccount": "111122223333",
"BackupProgressInMegabytes": 20.0,
"ElapsedTimeInSeconds": 0,
"DBName": "dev",
"CurrentBackupRateInMegabytesPerSecond: 0.0,
"ClusterCreateTime": "2013-01-22T21:59:29.559Z",
"ActualIncrementalBackupSizeInMegabytes"; 20.0
"SnapshotType": "automated",
"NodeType": "dw.hs1.xlarge",
"ClusterIdentifier": "mycluster",
"Port": 5439,
"TotalBackupSizeInMegabytes": 20.0,
"NumberOfNodes": "2",
"SnapshotIdentifier": "cm:mycluster-2013-01-22-22-04-18"
},
{
"EstimatedSecondsToCompletion": 0,
"OwnerAccount": "111122223333",
"CurrentBackupRateInMegabytesPerSecond: 0.1534,
"ActualIncrementalBackupSizeInMegabytes"; 11.0,
"NumberOfNodes": "2",
"Status": "available",
"ClusterVersion": "1.0",
"MasterUsername": "adminuser",
"AccountsWithRestoreAccess": [
{
"AccountID": "444455556666"
} ],
"TotalBackupSizeInMegabytes": 20.0,
"DBName": "dev",
"BackupProgressInMegabytes": 11.0,
"ClusterCreateTime": "2013-01-22T21:59:29.559Z",
"ElapsedTimeInSeconds": 0,
"ClusterIdentifier": "mycluster",
"SnapshotCreateTime": "2013-07-17T22:04:18.947Z",
"AvailabilityZone": "us-east-1a",
"NodeType": "dw.hs1.xlarge",
"Encrypted": false,
"SnapshotType": "manual",
"Port": 5439,
"SnapshotIdentifier": "my-snapshot-id"
} ]
}
(...remaining output omitted...)
```
+ For API details, see [DescribeClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-snapshots.html) in *AWS CLI Command Reference*.
### `describe-cluster-subnet-groups`
The following code example shows how to use `describe-cluster-subnet-groups`.
**AWS CLI**
Get a Description of All Cluster Subnet GroupsThis example returns a description of all cluster subnet groups. By default, the output is in JSON format.Command:
```
aws redshift describe-cluster-subnet-groups
```
Result:
```
{
"ClusterSubnetGroups": [
{
"Subnets": [
{
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-763fdd1c",
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
}
}
],
"VpcId": "vpc-7e3fdd14",
"SubnetGroupStatus": "Complete",
"Description": "My subnet group",
"ClusterSubnetGroupName": "mysubnetgroup"
}
],
"ResponseMetadata": {
"RequestId": "37fa8c89-6990-11e2-8f75-ab4018764c77"
}
}
```
+ For API details, see [DescribeClusterSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-subnet-groups.html) in *AWS CLI Command Reference*.
### `describe-cluster-tracks`
The following code example shows how to use `describe-cluster-tracks`.
**AWS CLI**
**To describe cluster tracks**
The following `describe-cluster-tracks` example displays details of the available maintenance tracks.
```
aws redshift describe-cluster-tracks \
--maintenance-track-name current
```
Output:
```
{
"MaintenanceTracks": [
{
"MaintenanceTrackName": "current",
"DatabaseVersion": "1.0.11420",
"UpdateTargets": [
{
"MaintenanceTrackName": "preview_features",
"DatabaseVersion": "1.0.11746",
"SupportedOperations": [
{
"OperationName": "restore-from-cluster-snapshot"
}
]
},
{
"MaintenanceTrackName": "trailing",
"DatabaseVersion": "1.0.11116",
"SupportedOperations": [
{
"OperationName": "restore-from-cluster-snapshot"
},
{
"OperationName": "modify-cluster"
}
]
}
]
}
]
}
```
For more information, see [Choosing Cluster Maintenance Tracks](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-mgmt-maintenance-tracks) in the *Amazon Redshift Cluster Management Guide*.
+ For API details, see [DescribeClusterTracks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-tracks.html) in *AWS CLI Command Reference*.
### `describe-cluster-versions`
The following code example shows how to use `describe-cluster-versions`.
**AWS CLI**
Get a Description of All Cluster VersionsThis example returns a description of all cluster versions. By default, the output is in JSON format.Command:
```
aws redshift describe-cluster-versions
```
Result:
```
{
"ClusterVersions": [
{
"ClusterVersion": "1.0",
"Description": "Initial release",
"ClusterParameterGroupFamily": "redshift-1.0"
} ],
"ResponseMetadata": {
"RequestId": "16a53de3-64cc-11e2-bec0-17624ad140dd"
}
}
```
+ For API details, see [DescribeClusterVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-versions.html) in *AWS CLI Command Reference*.
### `describe-clusters`
The following code example shows how to use `describe-clusters`.
**AWS CLI**
Get a Description of All ClustersThis example returns a description of all clusters for the account. By default, the output is in JSON format.Command:
```
aws redshift describe-clusters
```
Result:
```
{
"Clusters": [
{
"NodeType": "dw.hs1.xlarge",
"Endpoint": {
"Port": 5439,
"Address": "mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com"
},
"ClusterVersion": "1.0",
"PubliclyAccessible": "true",
"MasterUsername": "adminuser",
"ClusterParameterGroups": [
{
"ParameterApplyStatus": "in-sync",
"ParameterGroupName": "default.redshift-1.0"
} ],
"ClusterSecurityGroups": [
{
"Status": "active",
"ClusterSecurityGroupName": "default"
} ],
"AllowVersionUpgrade": true,
"VpcSecurityGroups": \[],
"AvailabilityZone": "us-east-1a",
"ClusterCreateTime": "2013-01-22T21:59:29.559Z",
"PreferredMaintenanceWindow": "sat:03:30-sat:04:00",
"AutomatedSnapshotRetentionPeriod": 1,
"ClusterStatus": "available",
"ClusterIdentifier": "mycluster",
"DBName": "dev",
"NumberOfNodes": 2,
"PendingModifiedValues": {}
} ],
"ResponseMetadata": {
"RequestId": "65b71cac-64df-11e2-8f5b-e90bd6c77476"
}
}
```
You can also obtain the same information in text format using the `--output text` option.Command:
`--output text` option.Command:
option.Command:
```
aws redshift describe-clusters --output text
```
Result:
```
dw.hs1.xlarge 1.0 true adminuser True us-east-1a 2013-01-22T21:59:29.559Z sat:03:30-sat:04:00 1 available mycluster dev 2
ENDPOINT 5439 mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com
in-sync default.redshift-1.0
active default
PENDINGMODIFIEDVALUES
RESPONSEMETADATA 934281a8-64df-11e2-b07c-f7fbdd006c67
```
+ For API details, see [DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-clusters.html) in *AWS CLI Command Reference*.
### `describe-default-cluster-parameters`
The following code example shows how to use `describe-default-cluster-parameters`.
**AWS CLI**
Get a Description of Default Cluster ParametersThis example returns a description of the default cluster parameters for the `redshift-1.0` family. By default, the output is in JSON format.Command:
```
aws redshift describe-default-cluster-parameters --parameter-group-family redshift-1.0
```
Result:
```
{
"DefaultClusterParameters": {
"ParameterGroupFamily": "redshift-1.0",
"Parameters": [
{
"Description": "Sets the display format for date and time values.",
"DataType": "string",
"IsModifiable": true,
"Source": "engine-default",
"ParameterValue": "ISO, MDY",
"ParameterName": "datestyle"
},
{
"Description": "Sets the number of digits displayed for floating-point values",
"DataType": "integer",
"IsModifiable": true,
"AllowedValues": "-15-2",
"Source": "engine-default",
"ParameterValue": "0",
"ParameterName": "extra_float_digits"
},
(...remaining output omitted...)
]
}
}
```
To see a list of valid parameter group families, use the `describe-cluster-parameter-groups` command.
`describe-cluster-parameter-groups` command.
command.
+ For API details, see [DescribeDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-default-cluster-parameters.html) in *AWS CLI Command Reference*.
### `describe-event-categories`
The following code example shows how to use `describe-event-categories`.
**AWS CLI**
**To describe event categories for a cluster**
The following `describe-event-categories` example displays details for the event categories for a cluster.
```
aws redshift describe-event-categories \
--source-type cluster
```
Output:
```
{
"EventCategoriesMapList": [
{
"SourceType": "cluster",
"Events": [
{
"EventId": "REDSHIFT-EVENT-2000",
"EventCategories": [
"management"
],
"EventDescription": "Cluster created at