command line reference api version...
Post on 05-Apr-2018
249 Views
Preview:
TRANSCRIPT
Amazon RedshiftCommand Line Reference
API Version 2012-12-01
Amazon Web Services
Amazon Redshift Command Line Reference
Amazon Redshift: Command Line ReferenceAmazon Web ServicesCopyright © 2012 Amazon Web Services LLC or its affiliates. All rights reserved.
Amazon Redshift Command Line Reference
Welcome ................................................................................................................................................. 1Setting up the Command Line Tools ....................................................................................................... 2Getting Started with the AWS Command Line Interface ......................................................................... 4Common Options .................................................................................................................................... 9List of Command Line Operations by Function ..................................................................................... 12Command Line Interface (CLI) Reference ............................................................................................ 14authorize-cluster-security-group-ingress .............................................................................................. 15authorize-snapshot-access ................................................................................................................... 17create-cluster ........................................................................................................................................ 19copy-cluster-snapshot ........................................................................................................................... 26create-cluster-parameter-group ............................................................................................................ 29create-cluster-security-group ................................................................................................................ 31create-cluster-snapshot ........................................................................................................................ 33create-cluster-subnet-group .................................................................................................................. 36delete-cluster ........................................................................................................................................ 37delete-cluster-parameter-group ............................................................................................................ 40delete-cluster-security-group ................................................................................................................ 41delete-cluster-snapshot ........................................................................................................................ 42delete-cluster-subnet-group .................................................................................................................. 44describe-cluster-parameter-groups ....................................................................................................... 45describe-cluster-parameters ................................................................................................................. 47describe-clusters .................................................................................................................................. 50describe-cluster-security-groups .......................................................................................................... 54describe-cluster-snapshots ................................................................................................................... 56describe-cluster-subnet-groups ............................................................................................................ 60describe-cluster-versions ...................................................................................................................... 62describe-default-cluster-parameters ..................................................................................................... 64describe-events .................................................................................................................................... 66describe-orderable-cluster-options ....................................................................................................... 69describe-reserved-node-offerings ......................................................................................................... 72describe-reserved-nodes ...................................................................................................................... 75describe-resize ..................................................................................................................................... 77modify-cluster ....................................................................................................................................... 78modify-cluster-parameter-group ........................................................................................................... 84modify-cluster-subnet-group ................................................................................................................. 86purchase-reserved-node-offering ......................................................................................................... 88reboot-cluster ........................................................................................................................................ 90reset-cluster-parameter-group .............................................................................................................. 93restore-from-cluster-snapshot ............................................................................................................... 95revoke-cluster-security-group-ingress ................................................................................................... 99revoke-snapshot-access ..................................................................................................................... 101Document History ............................................................................................................................... 104
API Version 2012-12-014
Amazon Redshift Command Line Reference
Welcome
This is the Amazon Redshift Command Line Reference.
To work with Amazon Redshift from the command line, you use the AWS Command Line Interface (CLI).The AWS CLI lets you control multiple AWS services, including Amazon Redshift. Using the AWS CLI,you can interact directly with Amazon Redshift and other services; you can also use the AWS CLI tocreate your own scripts and automate tasks.
This section discusses who should read this guide, how the guide is organized, and other resourcesrelated to Amazon Redshift.
Are You a First-Time Amazon Redshift User?If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the followingsections:
• Service Highlights and Pricing – The product detail page provides the Amazon Redshift valueproposition, service highlights, and pricing.
• Getting Started – The Getting Started Guide includes an example that walks you through the processof creating a cluster, creating database tables, uploading data, and testing queries.
After you complete the Getting Started guide, we recommend that you explore one of the following guides:
• Amazon Redshift Cluster Management Guide – This guide shows you how to create and manageAmazon Redshift clusters. For more information, go to the Amazon Redshift Cluster ManagementGuide.
If you are an application developer, you can use the Amazon Redshift Query API to manage clustersprogrammatically. Additionally, the AWS SDK libraries that wrap the underlying Amazon Redshift APIsimplify your programming tasks. If you prefer a more interactive way of managing clusters, you canuse the Amazon Redshift console and the AWS command line interface (AWS CLI). For informationabout the API, go to the API Reference.
• Amazon Redshift Database Developer Guide – If you are a database developer, the Amazon RedshiftDatabase Developer Guide explains how to design, build, query, and maintain the databases that makeup your data warehouse.
API Version 2012-12-011
Amazon Redshift Command Line ReferenceAre You a First-Time Amazon Redshift User?
Setting up the Command LineTools
This section explains how to set up and run the Amazon Redshift command line tools. The AmazonRedshift command line tools run on the the AWS Command Line Interface (AWS CLI), which in turn usesPython (http://www.python.org/).The AWS CLI can be run on any operating system that supports Python.
Installation InstructionsTo begin using the Amazon Redshift command line tools, you first set up the AWS CLI, and then you addconfiguration files that define the Amazon Redshift CLI options.
If you have already installed and configured the AWS CLI for another AWS service, you can skip thisprocedure.
To install the AWS Command Line Interface
1. Go to the AWS Command Line Interface page and then follow the onscreen instructions for installingthe AWS CLI. For detailed instructions, go to Getting Set Up in the AWS Command Line InterfaceUser Guide.
NoteFor CLI access, you need an access key ID and secret access key. For more informationabout getting credentials, see How Do I Get Security Credentials? in the AWS GeneralReference.
2. Create a file containing configuration information such as your access keys, default region, andcommand output format. Then set the AWS_CONFIG_FILE environment variable to reference thatfile. For detailed instructions, go to Getting Started in the AWS Command Line Interface User Guide.
3. Run a test command to confirm that the AWS CLI interface is working. For example, the followingcommand should display help information for the AWS CLI:
aws help
The following command should display help information for Amazon Redshift:
API Version 2012-12-012
Amazon Redshift Command Line ReferenceInstallation Instructions
aws redshift help
API Version 2012-12-013
Amazon Redshift Command Line ReferenceInstallation Instructions
Getting Started with the AWSCommand Line Interface
Topics
• Step 1: Before You Begin (p. 4)
• Step 2: Launch a Cluster (p. 5)
• Step 3: Authorize Inbound Traffic for Cluster Access (p. 6)
• Step 4: Connect to Your Cluster (p. 7)
• Step 5: Create Tables, Upload Data, and Try Example Queries (p. 7)
• Step 6: Delete Your Sample Cluster (p. 8)
To help you get started using the command line interface, this section shows how to perform basicadministrative tasks for an Amazon Redshift cluster. These tasks are very similar to those in the AmazonRedshift Getting Started Guide, but they are focused on the command line interface rather than theAmazon Redshift console.
This section walks you through the process of creating a cluster, creating database tables, uploadingdata, and testing queries.You will use the Amazon Redshift CLI to provision a cluster and to authorizenecessary access permissions.You will then use the SQL Workbench client to connect to the cluster andcreate sample tables, upload sample data, and execute test queries.
Step 1: Before You BeginIf you don't already have an AWS account, you must sign up for one. Then you'll need to set up theAmazon Redshift command line tools. Finally, you'll need to download client tools and drivers in order toconnect to your cluster.
Step 1.1: Sign Up for an AWS accountFor information about signing up for an AWS user account, go to the Amazon Redshift Getting StartedGuide.
API Version 2012-12-014
Amazon Redshift Command Line ReferenceStep 1: Before You Begin
Step 1.2: Download and Install the AWS CommandLine Interface (CLI)If you have not installed the AWS Command Line Interface, see Setting up the Command Line Tools (p. 2).
Step 1.3: Download the Client Tools and DriversYou can use any SQL client tools to connect to an Amazon Redshift cluster with PostgreSQL JDBC orODBC drivers. If you do not currently have such software installed, you can use SQL Workbench, a freecross-platform tool that you can use to query tables in an Amazon Redshift cluster. The examples in thissection will use the SQL Workbench client.
To download SQL Workbench and the PostgreSQL drivers, go to the Amazon Redshift Getting StartedGuide.
Step 2: Launch a ClusterNow you're ready to launch a cluster by using the AWS Command Line Interface (CLI).
ImportantThe cluster that you're about to launch will be live (and not running in a sandbox).You will incurthe standard usage fees for the cluster until you terminate it. If you complete the exercisedescribed here in one sitting and terminate your cluster when you are finished, the total chargeswill be minimal.
The create-cluster command has a large number of parameters. For this exercise, you will use theparameter values that are described in the following table. Before you create a cluster in a productionenvironment, we recommend that you review all the required and optional parameters so that your clusterconfiguration matches your requirements. For more information, see create-cluster (p. 19)
Parameter Value for This ExerciseParameter Name
exampleclusterCluster Identifier
masteruserMaster Username
TopSecret1Master Password
dw.hs1.xlarge. If you plan to test with a largerdataset, consider using the dw.hs1.8xlarge nodetype.
Node Type
single-nodeCluster Type
To create your cluster, type the following command:
aws redshift create-cluster --cluster-identifier examplecluster --master-username masteruser --master-user-password TopSecret1 --node-type dw.hs1.xlarge --cluster-type single-node
The cluster creation process will take several minutes to complete.To check the status, type the followingcommand:
API Version 2012-12-015
Amazon Redshift Command Line ReferenceStep 1.2: Download and Install the AWS Command Line
Interface (CLI)
aws redshift describe-clusters --cluster-identifier examplecluster
The output will look similar to this:
{ "Clusters": [ {
...output omitted...
"ClusterStatus": "creating", "ClusterIdentifier": "examplecluster",
...output omitted...
}
When the ClusterStatus field changes from creating to available, your cluster is ready for use.
In the next step, you will authorize access so that you can connect to the cluster.
Step 3: Authorize Inbound Traffic for ClusterAccess
You must explicitly grant inbound access to your client in order to connect to the cluster.Your client canbe an Amazon EC2 instance or an external computer.
When you created a cluster in the previous step, because you did not specify a security group, youassociated the default cluster security group with the cluster. The default cluster security group containsno rules to authorize any inbound traffic to the cluster. To access the new cluster, you must add rules forinbound traffic, which are called ingress rules, to the cluster security group.
Ingress Rules for Applications Running on theInternetIf you are accessing your cluster from the Internet, you will need to authorize a Classless Inter-DomainRouting IP (CIDR/IP) address range. For this example, we will use a CIDR/IP rule of 192.0.2.0/24; youwill need to modify this range to reflect your actual IP address and netmask.
To allow network ingress to your cluster, type the following command:
aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name default --cidrip 192.0.2.0/24
Ingress Rules for EC2 InstancesIf you are accessing your cluster from an Amazon EC2 instance, you will need to authorize an AmazonEC2 security group.To do so, you specify the security group name, along with the 12-digit account numberof the EC2 security group owner.
API Version 2012-12-016
Amazon Redshift Command Line ReferenceStep 3: Authorize Inbound Traffic for Cluster Access
You can use the Amazon EC2 console to determine the EC2 security group associated with your instance:
To find your AWS account number, go to http://aws.amazon.com and sign in to the My Account page.Your AWS account number is shown in the upper right-hand corner of that page.
For this example, we will use myec2securitygroup for the Amazon EC2 security group name, and123456789012 for the account number.You will need to modify these to suit your needs.
To allow network ingress to your cluster, type the following command:
aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name default --ec2-security-group-name myec2securitygroup --ec2-security-group-owner 123456789012
Step 4: Connect to Your ClusterNow that you have added an ingress rule to the default cluster security group, incoming connections froma specific CIDR/IP or EC2 Security Group to examplecluster are authorized.
You are now ready to connect to the cluster.
For information about connecting to your cluster, go to the Amazon Redshift Getting Started Guide.
Step 5: Create Tables, Upload Data, and TryExample Queries
For information about creating tables, uploading data, and issuing queries, go to the Amazon RedshiftGetting Started Guide.
API Version 2012-12-017
Amazon Redshift Command Line ReferenceStep 4: Connect to Your Cluster
Step 6: Delete Your Sample ClusterAfter you have launched a cluster and it is available for use, you are billed for the time the cluster isrunning, even if you are not actively using it. When you no longer need the cluster, you can delete it.
When you delete a cluster, you must decide whether to create a final snapshot. Because this is an exerciseand your test cluster should not have any important data in it, you can skip the final snapshot.
To delete your cluster, type the following command:
aws redshift delete-cluster --cluster-identifier examplecluster --skip-final-cluster-snapshot
Congratulations! You successfully launched, authorized access to, connected to, and terminated a cluster.
API Version 2012-12-018
Amazon Redshift Command Line ReferenceStep 6: Delete Your Sample Cluster
Common Options
This section describes the syntax and common options for Amazon Redshift command line tools.
Syntaxaws redshift operation
[--output output_format]
[--region region_name]
[--profile debug]
[--profile profile_name]
[--endpoint-url endpoint_url]
Only the operation is required. For a list of valid operations, see Command Line Interface (CLI)Reference (p. 14).
OptionsFollowing are the common options for all Amazon Redshift commands.
DescriptionOption
Specifies the Amazon Redshift operation to perform. Examples ofoperations are create-cluster, describe-events andmodify-cluster-parameter-group. For a list of valid operations,see Command Line Interface (CLI) Reference (p. 14).
operation
Specifies the format of the command output.
Default: json
Valid values: json | text | csv
--output
API Version 2012-12-019
Amazon Redshift Command Line ReferenceSyntax
DescriptionOption
Overrides the default AWS Region.
Default: us-east-1
Example: --region us-west-2
--region
Turns on debug logging.
Default: No debug information is generated.
--debug
Uses a specific profile from your credential file.
Default: The [default] profile is used.
--profile
Overrides the Amazon Redshift default URL with the given URL.--endpoint-url
ExamplesThis example returns a description of all clusters for the account.
PROMPT> aws redshift describe-clusters
This example returns a description of all clusters for the account. The output is returned in text format
PROMPT> aws redshift create-cluster-parameter-group --parameter-group-name myc lusterparametergroup --parameter-group-family redshift-1.0 --description "My first cluster parameter group" --output text
TroubleshootingThe following table lists common error conditions you might encounter, and how to address them.
Try the following...Error Message
Check the spelling of the command you specified.error: argumentoperation: invalid choice
Check the options you specified for the command.
• Check the spelling of the options.
• Check that all options have an "--" before them.
• Verify that the options are valid for the specified operation.
Something is wrong. Wehave leftover options
API Version 2012-12-0110
Amazon Redshift Command Line ReferenceExamples
Try the following...Error Message
Check the request response which contains details of the error. Forexample, the following error is returned when using the awsredshift describe-clusters command with acluster-identifier that does not exist.
{ "ErrorResponse": { "RequestId": "5a48a9e4-5a93-11e2-b05d-2129be933c3d", "Error": { "Message": "Cluster mycluster not found.", "Code": "ClusterNotFound", "Type": "Sender" } }}
If the cause of the error is an invalid security token, the response willbe as follows:
{ "ErrorResponse": { "RequestId": "aad31e1a-5a97-11e2-9b77-f77b7944b367", "Error": { "Message": "The security token included in the request is invalid.", "Code": "InvalidClientTokenId", "Type": "Sender" } }}
In the event of an invalid security token, you can use the --debugoption to show details of the request sent to the Amazon Redshiftendpoint. In the debug output, confirm that you are using the correctAWS access key ID.
A client error (Unknown)occurred
The CLI cannot determine the region in which to execute thecommand. For information on setting a default region, or specifyingthe region on the command line, go to Specifying Your AWSCredentials and Region in the AWS Command Line Interface UserGuide.
You must specify a regionusing the --region optionor in your config file.
API Version 2012-12-0111
Amazon Redshift Command Line ReferenceTroubleshooting
List of Command Line Operationsby Function
Clusters
• create-cluster (p. 19)
• modify-cluster (p. 78)
• describe-clusters (p. 50)
• describe-resize (p. 77)
• reboot-cluster (p. 90)
• delete-cluster (p. 37)
Parameter Groups
• create-cluster-parameter-group (p. 29)
• delete-cluster-parameter-group (p. 40)
• describe-cluster-parameter-groups (p. 45)
• describe-cluster-parameters (p. 47)
• modify-cluster-parameter-group (p. 84)
• reset-cluster-parameter-group (p. 93)
• describe-default-cluster-parameters (p. 64)
Security Groups
• create-cluster-security-group (p. 31)
• authorize-cluster-security-group-ingress (p. 15)
• delete-cluster-security-group (p. 41)
• describe-cluster-security-groups (p. 54)
• revoke-cluster-security-group-ingress (p. 99)
Snapshot Backups
• create-cluster-snapshot (p. 33)
API Version 2012-12-0112
Amazon Redshift Command Line Reference
• delete-cluster-snapshot (p. 42)
• describe-cluster-snapshots (p. 56)
• copy-cluster-snapshot (p. 26)
• restore-from-cluster-snapshot (p. 95)
• authorize-snapshot-access (p. 17)
• revoke-snapshot-access (p. 101)
Reserved Nodes
• describe-reserved-nodes (p. 75)
• describe-reserved-node-offerings (p. 72)
• purchase-reserved-node-offering (p. 88)
Subnet Groups
• create-cluster-subnet-group (p. 36)
• modify-cluster-subnet-group (p. 86)
• describe-cluster-subnet-groups (p. 60)
• delete-cluster-subnet-group (p. 44)
Configuration
• describe-cluster-versions (p. 62)
• describe-orderable-cluster-options (p. 69)
Events
• describe-events (p. 66)
API Version 2012-12-0113
Amazon Redshift Command Line Reference
Command Line Interface (CLI)Reference
Topics
• authorize-cluster-security-group-ingress (p. 15)
• authorize-snapshot-access (p. 17)
• create-cluster (p. 19)
• copy-cluster-snapshot (p. 26)
• create-cluster-parameter-group (p. 29)
• create-cluster-security-group (p. 31)
• create-cluster-snapshot (p. 33)
• create-cluster-subnet-group (p. 36)
• delete-cluster (p. 37)
• delete-cluster-parameter-group (p. 40)
• delete-cluster-security-group (p. 41)
• delete-cluster-snapshot (p. 42)
• delete-cluster-subnet-group (p. 44)
• describe-cluster-parameter-groups (p. 45)
• describe-cluster-parameters (p. 47)
• describe-clusters (p. 50)
• describe-cluster-security-groups (p. 54)
• describe-cluster-snapshots (p. 56)
• describe-cluster-subnet-groups (p. 60)
• describe-cluster-versions (p. 62)
• describe-default-cluster-parameters (p. 64)
• describe-events (p. 66)
• describe-orderable-cluster-options (p. 69)
• describe-reserved-node-offerings (p. 72)
• describe-reserved-nodes (p. 75)
• describe-resize (p. 77)
• modify-cluster (p. 78)
• modify-cluster-parameter-group (p. 84)
API Version 2012-12-0114
Amazon Redshift Command Line Reference
• modify-cluster-subnet-group (p. 86)
• purchase-reserved-node-offering (p. 88)
• reboot-cluster (p. 90)
• reset-cluster-parameter-group (p. 93)
• restore-from-cluster-snapshot (p. 95)
• revoke-cluster-security-group-ingress (p. 99)
• revoke-snapshot-access (p. 101)
authorize-cluster-security-group-ingress
DescriptionAdds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the applicationaccessing your cluster is running on the Internet or an EC2 instance, you can authorize inbound accessto either a Classless Interdomain Routing (CIDR) IP address range or an EC2 security group.You canadd as many as 20 ingress rules to an Amazon Redshift security group.
NoteThe EC2 security group must be defined in the AWS region where the cluster resides.
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 addressesor the EC2 instance are authorized to connect to the cluster. For information about managing securitygroups, go to Working with Security Groups in the Amazon Redshift Management Guide.
Syntaxauthorize-cluster-security-group-ingress
--cluster-security-group-name value
[--cidrip value]
[--ec2-security-group-name value]
[--ec2-security-group-owner-id value]
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name of the security group to which the ingressrule is added.
--cluster-security-group-name
NoThe IP range to be added the Amazon Redshiftsecurity group.
--cidrip
NoThe EC2 security group to be added the AmazonRedshift security group.
--ec2-security-group-name
API Version 2012-12-0115
Amazon Redshift Command Line Referenceauthorize-cluster-security-group-ingress
RequiredDescriptionName
NoThe AWS account number of the owner of thesecurity group specified by theEC2SecurityGroupName parameter. The AWSAccess Key ID is not an acceptable value.
Example: 111122223333
--ec2-security-group-owner-id
OutputThe command returns the following information:
• ClusterSecurityGroup— Describes a security group.
• ClusterSecurityGroup:ClusterSecurityGroupName— The name of the cluster security group towhich the operation was applied.
• ClusterSecurityGroup:Description— A description of the security group.
• ClusterSecurityGroup:EC2SecurityGroups— A list of EC2 security groups that are permitted toaccess clusters associated with this cluster security group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup— Describes an Amazon EC2security group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:Status— The status of the EC2security group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:EC2SecurityGroupName— Thename of the EC2 Security Group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:EC2SecurityGroupOwnerId—The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
• ClusterSecurityGroup:IPRanges— A list of IP ranges (CIDR blocks) that are permitted to accessclusters associated with this cluster security group.
• ClusterSecurityGroup:IPRanges:IPRange— Describes an IP range used in a security group.
• ClusterSecurityGroup:IPRanges:IPRange:Status— The status of the IP range, for example,"authorized".
• ClusterSecurityGroup:IPRanges:IPRange:CIDRIP— The IP range in Classless Inter-Domain Routing(CIDR) notation.
Examples
Authorizing Access to an EC2 Security GroupThis example authorizes access to a named Amazon EC2 security group.
PROMPT> 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.
API Version 2012-12-0116
Amazon Redshift Command Line ReferenceOutput
PROMPT> aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --cidrip 192.168.100.100/32
authorize-snapshot-access
DescriptionAuthorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the AmazonRedshift Management Guide.
Syntaxauthorize-snapshot-access
--snapshot-identifier value
--account-with-restore-access value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe identifier of the AWS customer accountauthorized to restore the specified snapshot.
--account-with-restore-access
YesThe identifier of the snapshot the account isauthorized to restore.
--snapshot-identifier
OutputThe command returns the following information:
• Snapshot— Describes a snapshot.
• Snapshot:SnapshotIdentifier— The snapshot identifier that is provided in the request.
• Snapshot:ClusterIdentifier— The identifier of the cluster for which the snapshot was taken.
• Snapshot:SnapshotCreateTime— The time (UTC) when Amazon Redshift began the snapshot. Asnapshot contains a copy of the cluster data as of this exact time.
• Snapshot:Status— The snapshot status. The value of the status depends on the API operation used.
• create-cluster-snapshot (p. 33) and copy-cluster-snapshot (p. 26) returns status as "creating".
• describe-cluster-snapshots (p. 56) returns status as "creating", "available", or "failed".
• delete-cluster-snapshot (p. 42) returns status as "deleted".
• Snapshot:Port— The port that the cluster is listening on.
• Snapshot:AvailabilityZone— The Availability Zone in which the cluster was created.
API Version 2012-12-0117
Amazon Redshift Command Line Referenceauthorize-snapshot-access
• Snapshot:ClusterCreateTime— The time (UTC) when the cluster was originally created.
• Snapshot:MasterUsername— The master user name for the cluster.
• Snapshot:ClusterVersion— The version ID of the Amazon Redshift engine that is running on thecluster.
• Snapshot:SnapshotType— The snapshot type. Snapshots created using create-cluster-snapshot (p.33)and copy-cluster-snapshot (p. 26) will be of type "manual".
• Snapshot:NodeType— The node type of the nodes in the cluster.
• Snapshot:NumberOfNodes— The number of nodes in the cluster.
• Snapshot:DBName— The name of the database that was created when the cluster was created.
• Snapshot:VpcId— The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,this field is not in the output.
• Snapshot:Encrypted— If true, the data in the snapshot is encrypted at rest.
• Snapshot:AccountsWithRestoreAccess— A list of the AWS customer accounts authorized to restorethe snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess— Describes an AWS customeraccount authorized to restore a snapshot.
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess:AccountId— The identifierof an AWS customer account authorized to restore a snapshot.
• Snapshot:OwnerAccount— For manual snapshots, the AWS customer account used to create orcopy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform allsnapshot actions, such as sharing a manual snapshot.
• Snapshot:TotalBackupSizeInMegaBytes— The size of the complete set of backup data that wouldbe used to restore the instance.
• Snapshot:ActualIncrementalBackupSizeInMegaBytes— The size of the incremental backup.
• Snapshot:BackupProgressInMegaBytes— The number of megabytes that have been transferredto the snapshot backup.
• Snapshot:CurrentBackupRateInMegaBytesPerSecond— The number of megabytes per secondbeing transferred to the snapshot backup. Returns 0 for a completed backup.
• Snapshot:EstimatedSecondsToCompletion— The estimate of the time remaining before the snapshotbackup will complete. Returns 0 for a completed backup.
• Snapshot:ElapsedTimeInSeconds— The amount of time an in-progress snapshot backup has beenrunning, or the amount of time it took a completed backup to finish.
Examples
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.
PROMPT> aws redshift authorize-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666
{ "Snapshot": { "Status": "available", "SnapshotCreateTime": "2013-07-17T22:04:18.947Z", "EstimatedSecondsToCompletion": 0, "AvailabilityZone": "us-east-1a",
API Version 2012-12-0118
Amazon Redshift Command Line ReferenceExamples
"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" }}
create-cluster
DescriptionCreates a new cluster.To create the cluster in virtual private cloud (VPC), you must provide cluster subnetgroup name. If you don't provide a cluster subnet group name or the cluster security group parameter,Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with thecluster. For more information about managing clusters, go to Amazon Redshift Clusters in the AmazonRedshift Management Guide .
Syntaxcreate-cluster
--cluster-identifier value
--node-type value
--master-username value
--master-user-password value
[--db-name value]
[--cluster-type value]
[--cluster-security-groups value]
[--vpc-security-group-ids value]
[--cluster-subnet-group-name value]
[--availability-zone value]
API Version 2012-12-0119
Amazon Redshift Command Line Referencecreate-cluster
[--preferred-maintenance-window value]
[--cluster-parameter-group-name value]
[--automated-snapshot-retention-period value]
[--port value]
[--cluster-version value]
[--allow-version-upgrade]
[--number-of-nodes value]
[--publicly-accessible]
[--encrypted]
Common Options (p. 9)
Options
RequiredDescriptionName
YesA unique identifier for the cluster.You use thisidentifier to refer to the cluster for any subsequentcluster operations such as deleting or modifying.The identifier also appears in the Amazon Redshiftconsole.
Constraints:
• Must contain from 1 to 63 alphanumericcharacters or hyphens.
• Alphabetic characters must be lowercase.
• First character must be a letter.
• Cannot end with a hyphen or contain twoconsecutive hyphens.
• Must be unique for all clusters within an AWSaccount.
Example: myexamplecluster
--cluster-identifier
YesThe password associated with the master useraccount for the cluster that is being created.
Constraints:
• Must be between 8 and 64 characters in length.
• Must contain at least one uppercase letter.
• Must contain at least one lowercase letter.
• Must contain one number.
• Can be any printable ASCII character (ASCIIcode 33 to 126) except ' (single quote), " (doublequote), \, /, @, or space.
--master-user-password
API Version 2012-12-0120
Amazon Redshift Command Line ReferenceOptions
RequiredDescriptionName
YesThe user name associated with the master useraccount for the cluster that is being created.
Constraints:
• Must be 1 - 128 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word. A list of reservedwords can be found in Reserved Words in theAmazon Redshift Developer Guide.
--master-username
YesThe node type to be provisioned for the cluster. Forinformation about node types, go to Working withClusters in the Amazon Redshift ManagementGuide.
Valid Values: dw.hs1.xlarge |dw.hs1.8xlarge.
--node-type
NoIf true, upgrades can be applied during themaintenance window to the Amazon Redshiftengine that is running on the cluster.
When a new version of the Amazon Redshift engineis released, you can request that the serviceautomatically apply upgrades during themaintenance window to the Amazon Redshiftengine that is running on your cluster.
Default: true
--allow-version-upgrade
NoThe number of days that automated snapshots areretained. If the value is 0, automated snapshotsare disabled. Even if automated snapshots aredisabled, you can still create manual snapshotswhen you want with create-cluster-snapshot (p. 33).
Default: 1
Constraints: Must be a value from 0 to 35.
--automated-snapshot-retention-period
NoThe EC2 Availability Zone (AZ) in which you wantAmazon Redshift to provision the cluster. Forexample, if you have several EC2 instances runningin a specific Availability Zone, then you might wantthe cluster to be provisioned in the same zone inorder to decrease network latency.
Default: A random, system-chosen Availability Zonein the region that is specified by the endpoint.
Example: us-east-1d
Constraint:The specified Availability Zone must bein the same region as the current endpoint.
--availability-zone
API Version 2012-12-0121
Amazon Redshift Command Line ReferenceOptions
RequiredDescriptionName
NoThe name of the parameter group to be associatedwith this cluster.
Default: The default Amazon Redshift clusterparameter group. For information about the defaultparameter group, go to Working with AmazonRedshift Parameter Groups
Constraints:
• Must be 1 to 255 alphanumeric characters orhyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain twoconsecutive hyphens.
--cluster-parameter-group-name
NoA list of security groups to be associated with thiscluster.
Default: The default cluster security group forAmazon Redshift.
--cluster-security-groups
NoThe name of a cluster subnet group to beassociated with this cluster.
If this parameter is not provided the resulting clusterwill be deployed outside virtual private cloud (VPC).
--cluster-subnet-group-name
NoThe type of the cluster. When cluster type isspecified as
• single-node, the NumberOfNodes parameteris not required.
• multi-node, the NumberOfNodes parameteris required.
Valid Values: multi-node | single-node
Default: multi-node
--cluster-type
NoThe version of the Amazon Redshift enginesoftware that you want to deploy on the cluster.
The version selected runs on all the nodes in thecluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
--cluster-version
API Version 2012-12-0122
Amazon Redshift Command Line ReferenceOptions
RequiredDescriptionName
NoThe name of the first database to be created whenthe cluster is created.
To create additional databases after the cluster iscreated, connect to the cluster with a SQL clientand use SQL commands to create a database. Formore information, go to Create a Database in theAmazon Redshift Developer Guide.
Default: dev
Constraints:
• Must contain 1 to 64 alphanumeric characters.
• Must contain only lowercase letters.
• Cannot be a word that is reserved by the service.A list of reserved words can be found inReserved Words in the Amazon RedshiftDeveloper Guide.
--db-name
NoIf true, the data in cluster is encrypted at rest.
Default: false
--encrypted
NoThe number of compute nodes in the cluster. Thisparameter is required when the ClusterTypeparameter is specified as multi-node.
For information about determining how many nodesyou need, go to Working with Clusters in theAmazon Redshift Management Guide.
If you don't specify this parameter, you get asingle-node cluster.When requesting a multi-nodecluster, you must specify the number of nodes thatyou want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no morethan 100.
--number-of-nodes
NoThe port number on which the cluster acceptsincoming connections.
The cluster is accessible only via the JDBC andODBC connection strings. Part of the connectionstring requires the port on which the cluster willlisten for incoming connections.
Default: 5439
Valid Values: 1150-65535
--port
API Version 2012-12-0123
Amazon Redshift Command Line ReferenceOptions
RequiredDescriptionName
NoThe weekly time range (in UTC) during whichautomated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at randomfrom an 8-hour block of time per region, occurringon a random day of the week. The following listshows the time blocks for each region from whichthe default maintenance windows are assigned.
• US-East (Northern Virginia) Region:03:00-11:00 UTC
• US-West (Oregon) Region 06:00-14:00 UTC
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
--preferred-maintenance-window
NoIf true, the cluster can be accessed from a publicnetwork.
--publicly-accessible
NoA list of Virtual Private Cloud (VPC) security groupsto be associated with the cluster.
Default: The default VPC security group isassociated with the cluster.
--vpc-security-group-ids
OutputThe command returns the following information:
• Cluster— Describes a cluster.
• Cluster:ClusterIdentifier— The unique identifier of the cluster.
• Cluster:NodeType— The node type for the nodes in the cluster.
• Cluster:ClusterStatus— The current state of this cluster. Possible values include available,creating, deleting, rebooting, and resizing.
• Cluster:ModifyStatus— The status of a modify operation, if any, initiated for the cluster.
• Cluster:MasterUsername— The master user name for the cluster. This name is used to connect tothe database that is specified in DBName.
• Cluster:DBName— The name of the initial database that was created when the cluster was created.This same name is returned for the life of the cluster. If an initial database was not specified, a databasenamed "dev" was created by default.
• Cluster:Endpoint— The connection endpoint.
• Cluster:Endpoint:Address— The DNS address of the Cluster.
• Cluster:Endpoint:Port— The port that the database engine is listening on.
• Cluster:ClusterCreateTime— The date and time that the cluster was created.
• Cluster:AutomatedSnapshotRetentionPeriod— The number of days that automatic cluster snapshotsare retained.
• Cluster:ClusterSecurityGroups— A list of cluster security group that are associated with the cluster.Each security group is represented by an element that contains ClusterSecurityGroup.Name and
API Version 2012-12-0124
Amazon Redshift Command Line ReferenceOutput
ClusterSecurityGroup.Status subelements. Cluster security groups are used when the clusteris not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listedby the VpcSecurityGroups parameter.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup— Describes a security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:ClusterSecurityGroupName— The nameof the cluster security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:Status— The status of the cluster securitygroup.
• Cluster:VpcSecurityGroups— A list of Virtual Private Cloud (VPC) security groups that are associatedwith the cluster. This parameter is returned only if the cluster is in a VPC.
• Cluster:VpcSecurityGroups:VpcSecurityGroup— Describes the members of a VPC security group.
• Cluster:VpcSecurityGroups:VpcSecurityGroup:VpcSecurityGroupId—
• Cluster:VpcSecurityGroups:VpcSecurityGroup:Status—
• Cluster:ClusterParameterGroups— The list of cluster parameter groups that are associated with thiscluster.
• Cluster:ClusterParameterGroups:ClusterParameterGroup— Describes the status of a parametergroup.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterGroupName— The nameof the cluster parameter group.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterApplyStatus— The statusof parameter updates.
• Cluster:ClusterSubnetGroupName— The name of the subnet group that is associated with the cluster.This parameter is valid only when the cluster is in a VPC.
• Cluster:VpcId— The identifier of the VPC the cluster is in, if the cluster is in a VPC.
• Cluster:AvailabilityZone— The name of the Availability Zone in which the cluster is located.
• Cluster:PreferredMaintenanceWindow— The weekly time range (in UTC) during which systemmaintenance can occur.
• Cluster:PendingModifiedValues— If present, changes to the cluster are pending. Specific pendingchanges are identified by subelements.
• Cluster:PendingModifiedValues:MasterUserPassword— The pending or in-progress change of themaster credentials for the cluster.
• Cluster:PendingModifiedValues:NodeType— The pending or in-progress change of the cluster'snode type.
• Cluster:PendingModifiedValues:NumberOfNodes— The pending or in-progress change of thenumber nodes in the cluster.
• Cluster:PendingModifiedValues:ClusterType— The pending or in-progress change of the clustertype.
• Cluster:PendingModifiedValues:ClusterVersion— The pending or in-progress change of the serviceversion.
• Cluster:PendingModifiedValues:AutomatedSnapshotRetentionPeriod— The pending or in-progresschange of the automated snapshot retention period.
• Cluster:ClusterVersion— The version ID of the Amazon Redshift engine that is running on the cluster.
• Cluster:AllowVersionUpgrade— If true, version upgrades will be applied automatically to the clusterduring the maintenance window.
• Cluster:NumberOfNodes— The number of compute nodes in the cluster.
• Cluster:PubliclyAccessible— If true, the cluster can be accessed from a public network.
• Cluster:Encrypted— If true, data in cluster is encrypted at rest.
API Version 2012-12-0125
Amazon Redshift Command Line ReferenceOutput
Examples
Create a Cluster with Minimal ParametersThis example creates a cluster with the minimal set of parameters. By default, the output is in JSONformat.
PROMPT> aws redshift create-cluster --node-type dw.hs1.xlarge --number-of-nodes 2 --master-username adminuser --master-user-password TopSecret1 --cluster-identifier mycluster
{ "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" }
copy-cluster-snapshot
DescriptionCopies the specified automated cluster snapshot to a new manual cluster snapshot. The source must bean automated snapshot and it must be in the available state.
API Version 2012-12-0126
Amazon Redshift Command Line ReferenceExamples
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, whenthe retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want tokeep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manualsnapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the AmazonRedshift Management Guide.
Syntaxcopy-cluster-snapshot
--source-snapshot-identifier value
--target-snapshot-identifier value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe identifier for the source snapshot.
Constraints:
• Must be the identifier for a valid automatedsnapshot whose state is "available".
--source-snapshot-identifier
YesThe identifier given to the new manual snapshot.
Constraints:
• Cannot be null, empty, or blank.
• Must contain from 1 to 255 alphanumericcharacters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain twoconsecutive hyphens.
• Must be unique for the AWS account that ismaking the request.
--target-snapshot-identifier
OutputThe command returns the following information:
• Snapshot— Describes a snapshot.
• Snapshot:SnapshotIdentifier— The snapshot identifier that is provided in the request.
• Snapshot:ClusterIdentifier— The identifier of the cluster for which the snapshot was taken.
• Snapshot:SnapshotCreateTime— The time (UTC) when Amazon Redshift began the snapshot. Asnapshot contains a copy of the cluster data as of this exact time.
API Version 2012-12-0127
Amazon Redshift Command Line ReferenceSyntax
• Snapshot:Status— The snapshot status. The value of the status depends on the API operation used.
• create-cluster-snapshot (p. 33) and copy-cluster-snapshot (p. 26) returns status as "creating".
• describe-cluster-snapshots (p. 56) returns status as "creating", "available", or "failed".
• delete-cluster-snapshot (p. 42) returns status as "deleted".
• Snapshot:Port— The port that the cluster is listening on.
• Snapshot:AvailabilityZone— The Availability Zone in which the cluster was created.
• Snapshot:ClusterCreateTime— The time (UTC) when the cluster was originally created.
• Snapshot:MasterUsername— The master user name for the cluster.
• Snapshot:ClusterVersion— The version ID of the Amazon Redshift engine that is running on thecluster.
• Snapshot:SnapshotType— The snapshot type. Snapshots created using create-cluster-snapshot (p.33)and copy-cluster-snapshot (p. 26) will be of type "manual".
• Snapshot:NodeType— The node type of the nodes in the cluster.
• Snapshot:NumberOfNodes— The number of nodes in the cluster.
• Snapshot:DBName— The name of the database that was created when the cluster was created.
• Snapshot:VpcId— The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,this field is not in the output.
• Snapshot:Encrypted— If true, the data in the snapshot is encrypted at rest.
• Snapshot:AccountsWithRestoreAccess— A list of the AWS customer accounts authorized to restorethe snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess— Describes an AWS customeraccount authorized to restore a snapshot.
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess:AccountId— The identifierof an AWS customer account authorized to restore a snapshot.
• Snapshot:OwnerAccount— For manual snapshots, the AWS customer account used to create orcopy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform allsnapshot actions, such as sharing a manual snapshot.
• Snapshot:TotalBackupSizeInMegaBytes— The size of the complete set of backup data that wouldbe used to restore the instance.
• Snapshot:ActualIncrementalBackupSizeInMegaBytes— The size of the incremental backup.
• Snapshot:BackupProgressInMegaBytes— The number of megabytes that have been transferredto the snapshot backup.
• Snapshot:CurrentBackupRateInMegaBytesPerSecond— The number of megabytes per secondbeing transferred to the snapshot backup. Returns 0 for a completed backup.
• Snapshot:EstimatedSecondsToCompletion— The estimate of the time remaining before the snapshotbackup will complete. Returns 0 for a completed backup.
• Snapshot:ElapsedTimeInSeconds— The amount of time an in-progress snapshot backup has beenrunning, or the amount of time it took a completed backup to finish.
Examples
Get a Description of All Cluster VersionsThis example returns a description of all cluster versions. By default, the output is in JSON format.
PROMPT> aws redshift copy-cluster-snapshot --source-snapshot-identifier cm:ex amplecluster-2013-01-22-19-27-58 --target-snapshot-identifier my-saved-snapshot-copy
API Version 2012-12-0128
Amazon Redshift Command Line ReferenceExamples
{ "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" }}
create-cluster-parameter-group
DescriptionCreates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters.You can associate a cluster with a parametergroup when you create the cluster.You can also associate an existing cluster with a parameter groupafter the cluster is created by using modify-cluster (p. 78).
Parameters in the parameter group define specific behavior that applies to the databases you create onthe cluster. For more information about managing parameter groups, go to Amazon Redshift ParameterGroups in the Amazon Redshift Management Guide.
Syntaxcreate-cluster-parameter-group
--parameter-group-name value
--parameter-group-family value
--description value
Common Options (p. 9)
Options
RequiredDescriptionName
YesA description of the parameter group.--description
API Version 2012-12-0129
Amazon Redshift Command Line Referencecreate-cluster-parameter-group
RequiredDescriptionName
YesThe Amazon Redshift engine version to which thecluster parameter group applies.The cluster engineversion determines the set of parameters.
To get a list of valid parameter group family names,you can calldescribe-cluster-parameter-groups (p. 45). Bydefault, Amazon Redshift returns a list of all theparameter groups that are owned by your AWSaccount, including the default parameter groupsfor each Amazon Redshift engine version. Theparameter group family names associated with thedefault parameter groups provide you the validvalues. For example, a valid family name is"redshift-1.0".
--parameter-group-family
YesThe name of the cluster parameter group.
Constraints:
• Must be 1 to 255 alphanumeric characters orhyphens
• First character must be a letter.
• Cannot end with a hyphen or contain twoconsecutive hyphens.
• Must be unique withing your AWS account.
NoteThis value is stored as a lower-case string.
--parameter-group-name
OutputThe command returns the following information:
• ClusterParameterGroup— Describes a parameter group.
• ClusterParameterGroup:ParameterGroupName— The name of the cluster parameter group.
• ClusterParameterGroup:ParameterGroupFamily— The name of the cluster parameter group familythat this cluster parameter group is compatible with.
• ClusterParameterGroup:Description— The description of the parameter group.
Examples
Create a Cluster Parameter GroupThis example creates a new cluster parameter group.
PROMPT> aws redshift create-cluster-parameter-group --parameter-group-name myc lusterparametergroup --parameter-group-family redshift-1.0 --description "My
API Version 2012-12-0130
Amazon Redshift Command Line ReferenceOutput
first cluster parameter group"
{ "ClusterParameterGroup": { "ParameterGroupFamily": "redshift-1.0", "Description": "My first cluster parameter group", "ParameterGroupName": "myclusterparametergroup" }, "ResponseMetadata": { "RequestId": "739448f0-64cc-11e2-8f7d-3b939af52818" }}
create-cluster-security-group
DescriptionCreates a new Amazon Redshift security group.You use security groups to control access to non-VPCclusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in theAmazon Redshift Management Guide.
Syntaxcreate-cluster-security-group
--cluster-security-group-name value
--description value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name for the security group. Amazon Redshiftstores the value as a lowercase string.
Constraints:
• Must contain no more than 255 alphanumericcharacters or hyphens.
• Must not be "Default".
• Must be unique for all security groups that arecreated by your AWS account.
Example: examplesecuritygroup
--cluster-security-group-name
API Version 2012-12-0131
Amazon Redshift Command Line Referencecreate-cluster-security-group
RequiredDescriptionName
YesA description for the security group.--description
OutputThe command returns the following information:
• ClusterSecurityGroup— Describes a security group.
• ClusterSecurityGroup:ClusterSecurityGroupName— The name of the cluster security group towhich the operation was applied.
• ClusterSecurityGroup:Description— A description of the security group.
• ClusterSecurityGroup:EC2SecurityGroups— A list of EC2 security groups that are permitted toaccess clusters associated with this cluster security group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup— Describes an Amazon EC2security group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:Status— The status of the EC2security group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:EC2SecurityGroupName— Thename of the EC2 Security Group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:EC2SecurityGroupOwnerId—The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
• ClusterSecurityGroup:IPRanges— A list of IP ranges (CIDR blocks) that are permitted to accessclusters associated with this cluster security group.
• ClusterSecurityGroup:IPRanges:IPRange— Describes an IP range used in a security group.
• ClusterSecurityGroup:IPRanges:IPRange:Status— The status of the IP range, for example,"authorized".
• ClusterSecurityGroup:IPRanges:IPRange:CIDRIP— The IP range in Classless Inter-Domain Routing(CIDR) notation.
Examples
Creating a Cluster Security GroupThis example creates a new cluster security group. By default, the output is in JSON format.
PROMPT> aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group"
{ "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": [] } },
API Version 2012-12-0132
Amazon Redshift Command Line ReferenceOutput
"response_metadata": { "request_id": "5df486a0-343a-11e2-b0d8-d15d0ef48549" } }}
You can also obtain the same information in text format using the --output text option.
PROMPT> aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group" --output text
This is my cluster security group 300454760768 mysecuritygroupa0c0bfab-343a-11e2-95d2-c3dc9fe8ab57
create-cluster-snapshot
DescriptionCreates 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 AmazonRedshift Management Guide.
Syntaxcreate-cluster-snapshot
--snapshot-identifier value
--cluster-identifier value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe cluster identifier for which you want a snapshot.--cluster-identifier
API Version 2012-12-0133
Amazon Redshift Command Line Referencecreate-cluster-snapshot
RequiredDescriptionName
YesA unique identifier for the snapshot that you arerequesting. This identifier must be unique for allsnapshots within the AWS account.
Constraints:
• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumericcharacters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain twoconsecutive hyphens
Example: my-snapshot-id
--snapshot-identifier
OutputThe command returns the following information:
• Snapshot— Describes a snapshot.
• Snapshot:SnapshotIdentifier— The snapshot identifier that is provided in the request.
• Snapshot:ClusterIdentifier— The identifier of the cluster for which the snapshot was taken.
• Snapshot:SnapshotCreateTime— The time (UTC) when Amazon Redshift began the snapshot. Asnapshot contains a copy of the cluster data as of this exact time.
• Snapshot:Status— The snapshot status. The value of the status depends on the API operation used.
• create-cluster-snapshot (p. 33) and copy-cluster-snapshot (p. 26) returns status as "creating".
• describe-cluster-snapshots (p. 56) returns status as "creating", "available", or "failed".
• delete-cluster-snapshot (p. 42) returns status as "deleted".
• Snapshot:Port— The port that the cluster is listening on.
• Snapshot:AvailabilityZone— The Availability Zone in which the cluster was created.
• Snapshot:ClusterCreateTime— The time (UTC) when the cluster was originally created.
• Snapshot:MasterUsername— The master user name for the cluster.
• Snapshot:ClusterVersion— The version ID of the Amazon Redshift engine that is running on thecluster.
• Snapshot:SnapshotType— The snapshot type. Snapshots created using create-cluster-snapshot (p.33)and copy-cluster-snapshot (p. 26) will be of type "manual".
• Snapshot:NodeType— The node type of the nodes in the cluster.
• Snapshot:NumberOfNodes— The number of nodes in the cluster.
• Snapshot:DBName— The name of the database that was created when the cluster was created.
• Snapshot:VpcId— The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,this field is not in the output.
• Snapshot:Encrypted— If true, the data in the snapshot is encrypted at rest.
• Snapshot:AccountsWithRestoreAccess— A list of the AWS customer accounts authorized to restorethe snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess— Describes an AWS customeraccount authorized to restore a snapshot.
API Version 2012-12-0134
Amazon Redshift Command Line ReferenceOutput
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess:AccountId— The identifierof an AWS customer account authorized to restore a snapshot.
• Snapshot:OwnerAccount— For manual snapshots, the AWS customer account used to create orcopy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform allsnapshot actions, such as sharing a manual snapshot.
• Snapshot:TotalBackupSizeInMegaBytes— The size of the complete set of backup data that wouldbe used to restore the instance.
• Snapshot:ActualIncrementalBackupSizeInMegaBytes— The size of the incremental backup.
• Snapshot:BackupProgressInMegaBytes— The number of megabytes that have been transferredto the snapshot backup.
• Snapshot:CurrentBackupRateInMegaBytesPerSecond— The number of megabytes per secondbeing transferred to the snapshot backup. Returns 0 for a completed backup.
• Snapshot:EstimatedSecondsToCompletion— The estimate of the time remaining before the snapshotbackup will complete. Returns 0 for a completed backup.
• Snapshot:ElapsedTimeInSeconds— The amount of time an in-progress snapshot backup has beenrunning, or the amount of time it took a completed backup to finish.
Examples
Create a Cluster SnapshotThis example creates a new cluster snapshot. By default, the output is in JSON format.
PROMPT> aws redshift create-cluster-snapshot --cluster-identifier mycluster --snapshot-identifier my-snapshot-id
{ "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" }}
API Version 2012-12-0135
Amazon Redshift Command Line ReferenceExamples
create-cluster-subnet-group
DescriptionCreates a new Amazon Redshift subnet group.You must provide a list of one or more subnets in yourexisting 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 AmazonRedshift Management Guide.
Syntaxcreate-cluster-subnet-group
--cluster-subnet-group-name value
--description value
--subnet-ids value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name for the subnet group. Amazon Redshiftstores the value as a lowercase string.
Constraints:
• Must contain no more than 255 alphanumericcharacters or hyphens.
• Must not be "Default".
• Must be unique for all subnet groups that arecreated by your AWS account.
Example: examplesubnetgroup
--cluster-subnet-group-name
YesA description for the subnet group.--description
YesAn array of VPC subnet IDs. A maximum of 20subnets can be modified in a single request.
--subnet-ids
OutputThe command returns the following information:
• ClusterSubnetGroup— Describes a subnet group.
• ClusterSubnetGroup:ClusterSubnetGroupName— The name of the cluster subnet group.
• ClusterSubnetGroup:Description— The description of the cluster subnet group.
• ClusterSubnetGroup:VpcId— The VPC ID of the cluster subnet group.
API Version 2012-12-0136
Amazon Redshift Command Line Referencecreate-cluster-subnet-group
• ClusterSubnetGroup:SubnetGroupStatus— The status of the cluster subnet group. Possible valuesare Complete, Incomplete and Invalid.
• ClusterSubnetGroup:Subnets— A list of the VPC Subnet elements.
• ClusterSubnetGroup:Subnets:Subnet— Describes a subnet.
• ClusterSubnetGroup:Subnets:Subnet:SubnetIdentifier— The identifier of the subnet.
• ClusterSubnetGroup:Subnets:Subnet:SubnetAvailabilityZone— Describes an availability zone.
• ClusterSubnetGroup:Subnets:Subnet:SubnetAvailabilityZone:Name— The name of the availabilityzone.
• ClusterSubnetGroup:Subnets:Subnet:SubnetStatus— The status of the subnet.
Examples
Create a Cluster Subnet GroupThis example creates a new cluster subnet group.
PROMPT> aws redshift create-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup --description "My subnet group" --subnet-ids subnet-763fdd1c
{ "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" }}
delete-cluster
DescriptionDeletes a previously provisioned cluster. A successful response from the web service indicates that therequest was received correctly. 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 beginsdeleting the cluster. Use describe-clusters (p. 50) to monitor the status of the deletion.The delete operation
API Version 2012-12-0137
Amazon Redshift Command Line ReferenceExamples
cannot be canceled or reverted once submitted. For more information about managing clusters, go toAmazon Redshift Clusters in the Amazon Redshift Management Guide .
Syntaxdelete-cluster
--cluster-identifier value
[--skip-final-cluster-snapshot]
[--final-cluster-snapshot-identifier value]
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe identifier of the cluster to be deleted.
Constraints:
• Must contain lowercase characters.
• Must contain from 1 to 63 alphanumericcharacters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain twoconsecutive hyphens.
--cluster-identifier
NoThe identifier of the final snapshot that is to becreated immediately before deleting the cluster. Ifthis parameter is provided,SkipFinalClusterSnapshot must be false.
Constraints:
• Must be 1 to 255 alphanumeric characters.
• First character must be a letter.
• Cannot end with a hyphen or contain twoconsecutive hyphens.
--final-cluster-snapshot-identifier
NoDetermines whether a final snapshot of the clusteris created before Amazon Redshift deletes thecluster. If true, a final cluster snapshot is notcreated. If false, a final cluster snapshot iscreated before the cluster is deleted.
NoteThe FinalClusterSnapshotIdentifierparameter must be specified ifSkipFinalClusterSnapshot is false.
Default: false
--skip-final-cluster-snapshot
API Version 2012-12-0138
Amazon Redshift Command Line ReferenceSyntax
OutputThe command returns the following information:
• Cluster— Describes a cluster.
• Cluster:ClusterIdentifier— The unique identifier of the cluster.
• Cluster:NodeType— The node type for the nodes in the cluster.
• Cluster:ClusterStatus— The current state of this cluster. Possible values include available,creating, deleting, rebooting, and resizing.
• Cluster:ModifyStatus— The status of a modify operation, if any, initiated for the cluster.
• Cluster:MasterUsername— The master user name for the cluster. This name is used to connect tothe database that is specified in DBName.
• Cluster:DBName— The name of the initial database that was created when the cluster was created.This same name is returned for the life of the cluster. If an initial database was not specified, a databasenamed "dev" was created by default.
• Cluster:Endpoint— The connection endpoint.
• Cluster:Endpoint:Address— The DNS address of the Cluster.
• Cluster:Endpoint:Port— The port that the database engine is listening on.
• Cluster:ClusterCreateTime— The date and time that the cluster was created.
• Cluster:AutomatedSnapshotRetentionPeriod— The number of days that automatic cluster snapshotsare retained.
• Cluster:ClusterSecurityGroups— A list of cluster security group that are associated with the cluster.Each security group is represented by an element that contains ClusterSecurityGroup.Name andClusterSecurityGroup.Status subelements. Cluster security groups are used when the clusteris not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listedby the VpcSecurityGroups parameter.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup— Describes a security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:ClusterSecurityGroupName— The nameof the cluster security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:Status— The status of the cluster securitygroup.
• Cluster:VpcSecurityGroups— A list of Virtual Private Cloud (VPC) security groups that are associatedwith the cluster. This parameter is returned only if the cluster is in a VPC.
• Cluster:VpcSecurityGroups:VpcSecurityGroup— Describes the members of a VPC security group.
• Cluster:VpcSecurityGroups:VpcSecurityGroup:VpcSecurityGroupId—
• Cluster:VpcSecurityGroups:VpcSecurityGroup:Status—
• Cluster:ClusterParameterGroups— The list of cluster parameter groups that are associated with thiscluster.
• Cluster:ClusterParameterGroups:ClusterParameterGroup— Describes the status of a parametergroup.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterGroupName— The nameof the cluster parameter group.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterApplyStatus— The statusof parameter updates.
• Cluster:ClusterSubnetGroupName— The name of the subnet group that is associated with the cluster.This parameter is valid only when the cluster is in a VPC.
• Cluster:VpcId— The identifier of the VPC the cluster is in, if the cluster is in a VPC.
• Cluster:AvailabilityZone— The name of the Availability Zone in which the cluster is located.
• Cluster:PreferredMaintenanceWindow— The weekly time range (in UTC) during which systemmaintenance can occur.
API Version 2012-12-0139
Amazon Redshift Command Line ReferenceOutput
• Cluster:PendingModifiedValues— If present, changes to the cluster are pending. Specific pendingchanges are identified by subelements.
• Cluster:PendingModifiedValues:MasterUserPassword— The pending or in-progress change of themaster credentials for the cluster.
• Cluster:PendingModifiedValues:NodeType— The pending or in-progress change of the cluster'snode type.
• Cluster:PendingModifiedValues:NumberOfNodes— The pending or in-progress change of thenumber nodes in the cluster.
• Cluster:PendingModifiedValues:ClusterType— The pending or in-progress change of the clustertype.
• Cluster:PendingModifiedValues:ClusterVersion— The pending or in-progress change of the serviceversion.
• Cluster:PendingModifiedValues:AutomatedSnapshotRetentionPeriod— The pending or in-progresschange of the automated snapshot retention period.
• Cluster:ClusterVersion— The version ID of the Amazon Redshift engine that is running on the cluster.
• Cluster:AllowVersionUpgrade— If true, version upgrades will be applied automatically to the clusterduring the maintenance window.
• Cluster:NumberOfNodes— The number of compute nodes in the cluster.
• Cluster:PubliclyAccessible— If true, the cluster can be accessed from a public network.
• Cluster:Encrypted— If true, data in cluster is encrypted at rest.
Examples
Delete a Cluster with No Final Cluster SnapshotThis example deletes a cluster, forcing data deletion so no final cluster snapshot is created.
PROMPT> 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.
PROMPT> aws redshift delete-cluster --cluster-identifier mycluster --final-cluster-snapshot-identifier myfinalsnapshot
delete-cluster-parameter-group
DescriptionDeletes a specified Amazon Redshift parameter group.
NoteYou cannot delete a parameter group if it is associated with a cluster.
API Version 2012-12-0140
Amazon Redshift Command Line ReferenceExamples
Syntaxdelete-cluster-parameter-group
--parameter-group-name value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name of the parameter group to be deleted.
Constraints:
• Must be the name of an existing clusterparameter group.
• Cannot delete a default cluster parameter group.
--parameter-group-name
OutputThe command returns the following information:
Examples
Delete a Cluster Parameter GroupThis example deletes a cluster parameter group.
PROMPT> aws redshift delete-cluster-parameter-group --parameter-group-name myc lusterparametergroup
delete-cluster-security-group
DescriptionDeletes an Amazon Redshift security group.
NoteYou cannot delete a security group that is associated with any clusters.You cannot delete thedefault security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in theAmazon Redshift Management Guide.
API Version 2012-12-0141
Amazon Redshift Command Line ReferenceSyntax
Syntaxdelete-cluster-security-group
--cluster-security-group-name value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name of the cluster security group to bedeleted.
--cluster-security-group-name
OutputThe command returns the following information:
Examples
Delete a Cluster Security GroupThis example deletes a cluster security group.
PROMPT> aws redshift delete-cluster-security-group --cluster-security-group-name mysecuritygroup
delete-cluster-snapshot
DescriptionDeletes the specified manual snapshot.The snapshot must be in the "available" state, with no other usersauthorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. AmazonRedshift does not delete your manual snapshots.You must delete manual snapshot explicitly to avoidgetting charged. If other accounts are authorized to access the snapshot, you must revoke all of theauthorizations before you can delete the snapshot.
Syntaxdelete-cluster-snapshot
--snapshot-identifier value
Common Options (p. 9)
API Version 2012-12-0142
Amazon Redshift Command Line ReferenceSyntax
Options
RequiredDescriptionName
YesThe unique identifier of the manual snapshot to bedeleted.
Constraints: Must be the name of an existingsnapshot that is in the available state.
--snapshot-identifier
OutputThe command returns the following information:
• Snapshot— Describes a snapshot.
• Snapshot:SnapshotIdentifier— The snapshot identifier that is provided in the request.
• Snapshot:ClusterIdentifier— The identifier of the cluster for which the snapshot was taken.
• Snapshot:SnapshotCreateTime— The time (UTC) when Amazon Redshift began the snapshot. Asnapshot contains a copy of the cluster data as of this exact time.
• Snapshot:Status— The snapshot status. The value of the status depends on the API operation used.
• create-cluster-snapshot (p. 33) and copy-cluster-snapshot (p. 26) returns status as "creating".
• describe-cluster-snapshots (p. 56) returns status as "creating", "available", or "failed".
• delete-cluster-snapshot (p. 42) returns status as "deleted".
• Snapshot:Port— The port that the cluster is listening on.
• Snapshot:AvailabilityZone— The Availability Zone in which the cluster was created.
• Snapshot:ClusterCreateTime— The time (UTC) when the cluster was originally created.
• Snapshot:MasterUsername— The master user name for the cluster.
• Snapshot:ClusterVersion— The version ID of the Amazon Redshift engine that is running on thecluster.
• Snapshot:SnapshotType— The snapshot type. Snapshots created using create-cluster-snapshot (p.33)and copy-cluster-snapshot (p. 26) will be of type "manual".
• Snapshot:NodeType— The node type of the nodes in the cluster.
• Snapshot:NumberOfNodes— The number of nodes in the cluster.
• Snapshot:DBName— The name of the database that was created when the cluster was created.
• Snapshot:VpcId— The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,this field is not in the output.
• Snapshot:Encrypted— If true, the data in the snapshot is encrypted at rest.
• Snapshot:AccountsWithRestoreAccess— A list of the AWS customer accounts authorized to restorethe snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess— Describes an AWS customeraccount authorized to restore a snapshot.
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess:AccountId— The identifierof an AWS customer account authorized to restore a snapshot.
• Snapshot:OwnerAccount— For manual snapshots, the AWS customer account used to create orcopy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform allsnapshot actions, such as sharing a manual snapshot.
• Snapshot:TotalBackupSizeInMegaBytes— The size of the complete set of backup data that wouldbe used to restore the instance.
• Snapshot:ActualIncrementalBackupSizeInMegaBytes— The size of the incremental backup.
API Version 2012-12-0143
Amazon Redshift Command Line ReferenceOptions
• Snapshot:BackupProgressInMegaBytes— The number of megabytes that have been transferredto the snapshot backup.
• Snapshot:CurrentBackupRateInMegaBytesPerSecond— The number of megabytes per secondbeing transferred to the snapshot backup. Returns 0 for a completed backup.
• Snapshot:EstimatedSecondsToCompletion— The estimate of the time remaining before the snapshotbackup will complete. Returns 0 for a completed backup.
• Snapshot:ElapsedTimeInSeconds— The amount of time an in-progress snapshot backup has beenrunning, or the amount of time it took a completed backup to finish.
Examples
Delete a Cluster SnapshotThis example deletes a cluster snapshot.
PROMPT> aws redshift delete-cluster-snapshot --snapshot-identifier my-snapshot-id
delete-cluster-subnet-group
DescriptionDeletes the specified cluster subnet group.
Syntaxdelete-cluster-subnet-group
--cluster-subnet-group-name value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name of the cluster subnet group name to bedeleted.
--cluster-subnet-group-name
OutputThe command returns the following information:
API Version 2012-12-0144
Amazon Redshift Command Line ReferenceExamples
Examples
Delete a Cluster subnet GroupThis example deletes a cluster subnet group.
PROMPT> aws redshift delete-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup{ "ResponseMetadata": { "RequestId": "253fbffd-6993-11e2-bc3a-47431073908a" }}
describe-cluster-parameter-groups
DescriptionReturns a list of Amazon Redshift parameter groups, including parameter groups you created and thedefault 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 descriptionof a specific parameter group.
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups inthe Amazon Redshift Management Guide.
Syntaxdescribe-cluster-parameter-groups
[--parameter-group-name value]
[--max-records value]
[--marker value]
Common Options (p. 9)
Options
RequiredDescriptionName
NoAn optional marker returned by a previousdescribe-cluster-parameter-groups (p. 45) requestto indicate the first parameter group that the currentrequest will return.
--marker
API Version 2012-12-0145
Amazon Redshift Command Line ReferenceExamples
RequiredDescriptionName
NoThe maximum number of parameter group recordsto include in the response. If more records existthan the specified MaxRecords value, the responseincludes a marker that you can use in a subsequentdescribe-cluster-parameter-groups (p. 45) requestto retrieve the next set of records.
Default: 100
Constraints:Value must be at least 20 and no morethan 100.
--max-records
NoThe name of a specific parameter group for whichto return details. By default, details about allparameter groups and the default parameter groupare returned.
--parameter-group-name
OutputThe command returns the following information:
• Marker— A marker at which to continue listing cluster parameter groups in a new request.The responsereturns a marker if there are more parameter groups to list than returned in the response.
• ParameterGroups— A list of ClusterParameterGroup instances. Each instance describes one clusterparameter group.
• ParameterGroups:ClusterParameterGroup— Describes a parameter group.
• ParameterGroups:ClusterParameterGroup:ParameterGroupName— The name of the clusterparameter group.
• ParameterGroups:ClusterParameterGroup:ParameterGroupFamily— The name of the clusterparameter group family that this cluster parameter group is compatible with.
• ParameterGroups:ClusterParameterGroup:Description— The description of the parameter group.
Examples
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.
PROMPT> aws redshift describe-cluster-parameter-groups{ "ParameterGroups": [ { "ParameterGroupFamily": "redshift-1.0", "Description": "My first cluster parameter group", "ParameterGroupName": "myclusterparametergroup" } ], "ResponseMetadata": {
API Version 2012-12-0146
Amazon Redshift Command Line ReferenceOutput
"RequestId": "8ceb8f6f-64cc-11e2-bea9-49e0ce183f07" }}
You can also obtain the same information in text format using the --output text option.
PROMPT> aws redshift describe-cluster-parameter-groups --output text
redshift-1.0 My first cluster parameter group myclusterparametergroupRESPONSEMETADATA 9e665a36-64cc-11e2-8f7d-3b939af52818
describe-cluster-parameters
DescriptionReturns 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 retrieveparameters that were modified by a user action such as from modify-cluster-parameter-group (p. 84),you can specify source equal to user.
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups inthe Amazon Redshift Management Guide.
Syntaxdescribe-cluster-parameters
--parameter-group-name value
[--source value]
[--max-records value]
[--marker value]
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name of a cluster parameter group for whichto return details.
--parameter-group-name
API Version 2012-12-0147
Amazon Redshift Command Line Referencedescribe-cluster-parameters
RequiredDescriptionName
NoAn optional marker returned from a previousdescribe-cluster-parameters request. If thisparameter is specified, the response includes onlyrecords beyond the specified marker, up to thevalue specified by MaxRecords.
--marker
NoThe maximum number of records to include in theresponse. If more records exist than the specifiedMaxRecords value, response includes a markerthat you can specify in your subsequent request toretrieve remaining result.
Default: 100
Constraints:Value must be at least 20 and no morethan 100.
--max-records
NoThe parameter types to return. Specify user toshow parameters that are different form the default.Similarly, specify engine-default to showparameters that are the same as the defaultparameter group.
Default: All parameter types returned.
Valid Values: user | engine-default
--source
OutputThe command returns the following information:
• Parameters— A list of Parameter instances. Each instance lists the parameters of one cluster parametergroup.
• Parameters:Parameter— Describes a parameter in a cluster parameter group.
• Parameters:Parameter:ParameterName— The name of the parameter.
• Parameters:Parameter:ParameterValue— The value of the parameter.
• Parameters:Parameter:Description— A description of the parameter.
• Parameters:Parameter:Source— The source of the parameter value, such as "engine-default" or"user".
• Parameters:Parameter:DataType— The data type of the parameter.
• Parameters:Parameter:AllowedValues— The valid range of values for the parameter.
• Parameters:Parameter:IsModifiable— If true, the parameter can be modified. Some parametershave security or operational implications that prevent them from being changed.
• Parameters:Parameter:MinimumEngineVersion— The earliest engine version to which the parametercan apply.
• Marker— A marker that indicates the first parameter group that a subsequentdescribe-cluster-parameter-groups (p. 45) request will return. The response returns a marker only ifthere are more parameter groups details to list than the current response can return.
API Version 2012-12-0148
Amazon Redshift Command Line ReferenceOutput
Examples
Retrieve the Parameters for a Specified Cluster ParameterGroupThis example retrieves the parameters for the named parameter group. By default, the output is in JSONformat.
PROMPT> aws redshift describe-cluster-parameters --parameter-group-name mycluster
parametergroup
{ "ResponseMetadata": { "RequestId": "c2ae881a-64cc-11e2-9e70-918437dd236d" }, "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.
PROMPT> aws redshift describe-cluster-parameters --parameter-group-name mycluster
parametergroup --output text
RESPONSEMETADATA cdac40aa-64cc-11e2-9e70-918437dd236dSets the display format for date and time values. string True engine-default ISO, MDY datestyleSets the number of digits displayed for floating-point values integer True -15-2 engine-default 0 extra_float_digitsThis parameter applies a user-defined label to a group of queries that are run
API Version 2012-12-0149
Amazon Redshift Command Line ReferenceExamples
during the same session.. string True engine-default default query_grouprequire ssl for all databaseconnections boolean True true,false engine-default false require_sslSets the schema search order for names that are not schema-qualified. string True engine-default $user, public search_pathAborts any statement that takes over the specified number of milliseconds. in teger True engine-default 0 statement_timeoutwlm json configuration string True engine-default [{"query_concurrency":5}] wlm_json_configuration
describe-clusters
DescriptionReturns properties of provisioned clusters including general cluster properties, cluster database properties,maintenance and backup properties, and security and access properties. This operation supportspagination. For more information about managing clusters, go to Amazon Redshift Clusters in the AmazonRedshift Management Guide .
Syntaxdescribe-clusters
[--cluster-identifier value]
[--max-records value]
[--marker value]
Common Options (p. 9)
Options
RequiredDescriptionName
NoThe unique identifier of a cluster whose propertiesyou are requesting. This parameter isn't casesensitive.
The default is that all clusters defined for anaccount are returned.
--cluster-identifier
NoAn optional marker returned by a previousdescribe-clusters request to indicate the firstcluster that the current describe-clusters requestwill return.
You can specify either a Marker parameter or aClusterIdentifier parameter in a describe-clustersrequest, but not both.
--marker
API Version 2012-12-0150
Amazon Redshift Command Line Referencedescribe-clusters
RequiredDescriptionName
NoThe maximum number of records that the responsecan include. If more records exist than the specifiedMaxRecords value, a marker is included in theresponse that can be used in a newdescribe-clusters request to continue listingresults.
Default: 100
Constraints:Value must be at least 20 and no morethan 100.
--max-records
OutputThe command returns the following information:
• Marker— A marker at which to continue listing clusters in a new request. A marker is returned if thereare more clusters to list than were returned in the response.
• Clusters— A list of Cluster objects, where each object describes one cluster.
• Clusters:Cluster— Describes a cluster.
• Clusters:Cluster:ClusterIdentifier— The unique identifier of the cluster.
• Clusters:Cluster:NodeType— The node type for the nodes in the cluster.
• Clusters:Cluster:ClusterStatus— The current state of this cluster. Possible values include available,creating, deleting, rebooting, and resizing.
• Clusters:Cluster:ModifyStatus— The status of a modify operation, if any, initiated for the cluster.
• Clusters:Cluster:MasterUsername— The master user name for the cluster. This name is used toconnect to the database that is specified in DBName.
• Clusters:Cluster:DBName— The name of the initial database that was created when the cluster wascreated. This same name is returned for the life of the cluster. If an initial database was not specified,a database named "dev" was created by default.
• Clusters:Cluster:Endpoint— The connection endpoint.
• Clusters:Cluster:Endpoint:Address— The DNS address of the Cluster.
• Clusters:Cluster:Endpoint:Port— The port that the database engine is listening on.
• Clusters:Cluster:ClusterCreateTime— The date and time that the cluster was created.
• Clusters:Cluster:AutomatedSnapshotRetentionPeriod— The number of days that automatic clustersnapshots are retained.
• Clusters:Cluster:ClusterSecurityGroups— A list of cluster security group that are associated withthe cluster. Each security group is represented by an element that containsClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster securitygroups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPCsecurity groups, which are listed by the VpcSecurityGroups parameter.
• Clusters:Cluster:ClusterSecurityGroups:ClusterSecurityGroup— Describes a security group.
• Clusters:Cluster:ClusterSecurityGroups:ClusterSecurityGroup:ClusterSecurityGroupName—The name of the cluster security group.
• Clusters:Cluster:ClusterSecurityGroups:ClusterSecurityGroup:Status— The status of the clustersecurity group.
• Clusters:Cluster:VpcSecurityGroups— A list of Virtual Private Cloud (VPC) security groups that areassociated with the cluster. This parameter is returned only if the cluster is in a VPC.
API Version 2012-12-0151
Amazon Redshift Command Line ReferenceOutput
• Clusters:Cluster:VpcSecurityGroups:VpcSecurityGroup— Describes the members of a VPCsecurity group.
• Clusters:Cluster:VpcSecurityGroups:VpcSecurityGroup:VpcSecurityGroupId—
• Clusters:Cluster:VpcSecurityGroups:VpcSecurityGroup:Status—
• Clusters:Cluster:ClusterParameterGroups— The list of cluster parameter groups that are associatedwith this cluster.
• Clusters:Cluster:ClusterParameterGroups:ClusterParameterGroup— Describes the status of aparameter group.
• Clusters:Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterGroupName—The name of the cluster parameter group.
• Clusters:Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterApplyStatus—The status of parameter updates.
• Clusters:Cluster:ClusterSubnetGroupName— The name of the subnet group that is associated withthe cluster. This parameter is valid only when the cluster is in a VPC.
• Clusters:Cluster:VpcId— The identifier of the VPC the cluster is in, if the cluster is in a VPC.
• Clusters:Cluster:AvailabilityZone— The name of the Availability Zone in which the cluster is located.
• Clusters:Cluster:PreferredMaintenanceWindow— The weekly time range (in UTC) during whichsystem maintenance can occur.
• Clusters:Cluster:PendingModifiedValues— If present, changes to the cluster are pending. Specificpending changes are identified by subelements.
• Clusters:Cluster:PendingModifiedValues:MasterUserPassword— The pending or in-progresschange of the master credentials for the cluster.
• Clusters:Cluster:PendingModifiedValues:NodeType— The pending or in-progress change of thecluster's node type.
• Clusters:Cluster:PendingModifiedValues:NumberOfNodes— The pending or in-progress changeof the number nodes in the cluster.
• Clusters:Cluster:PendingModifiedValues:ClusterType— The pending or in-progress change of thecluster type.
• Clusters:Cluster:PendingModifiedValues:ClusterVersion— The pending or in-progress change ofthe service version.
• Clusters:Cluster:PendingModifiedValues:AutomatedSnapshotRetentionPeriod— The pendingor in-progress change of the automated snapshot retention period.
• Clusters:Cluster:ClusterVersion— The version ID of the Amazon Redshift engine that is running onthe cluster.
• Clusters:Cluster:AllowVersionUpgrade— If true, version upgrades will be applied automatically tothe cluster during the maintenance window.
• Clusters:Cluster:NumberOfNodes— The number of compute nodes in the cluster.
• Clusters:Cluster:PubliclyAccessible— If true, the cluster can be accessed from a public network.
• Clusters:Cluster:Encrypted— If true, data in cluster is encrypted at rest.
Examples
Get a Description of All ClustersThis example returns a description of all clusters for the account. By default, the output is in JSON format.
PROMPT> aws redshift describe-clusters
API Version 2012-12-0152
Amazon Redshift Command Line ReferenceExamples
{ "Clusters": [ { "NodeType": "dw.hs1.xlarge", "Endpoint": { "Port": 5439, "Address": "mycluster.coqoarplqhsn.us-east-1.redshift.amazon aws.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.
PROMPT> aws redshift describe-clusters --output text
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 2ENDPOINT 5439 mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.comin-sync default.redshift-1.0active defaultPENDINGMODIFIEDVALUESRESPONSEMETADATA 934281a8-64df-11e2-b07c-f7fbdd006c67
API Version 2012-12-0153
Amazon Redshift Command Line ReferenceExamples
describe-cluster-security-groups
DescriptionReturns 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 theAmazon Redshift Management Guide.
Syntaxdescribe-cluster-security-groups
[--cluster-security-group-name value]
[--max-records value]
[--marker value]
Common Options (p. 9)
Options
RequiredDescriptionName
NoThe name of a cluster security group for which youare requesting details.You can specify either theMarker parameter or aClusterSecurityGroupName parameter, but notboth.
Example: securitygroup1
--cluster-security-group-name
NoAn optional marker returned by a previousdescribe-cluster-security-groups (p. 54) request toindicate the first security group that the currentrequest will return.You can specify either theMarker parameter or aClusterSecurityGroupName parameter, but notboth.
--marker
NoThe maximum number of records to be included inthe response. If more records exist than thespecified MaxRecords value, a marker is includedin the response, which you can use in a subsequentdescribe-cluster-security-groups (p. 54) request.
Default: 100
Constraints:Value must be at least 20 and no morethan 100.
--max-records
API Version 2012-12-0154
Amazon Redshift Command Line Referencedescribe-cluster-security-groups
OutputThe command returns the following information:
• Marker— A marker at which to continue listing cluster security groups in a new request. The responsereturns a marker if there are more security groups to list than could be returned in the response.
• ClusterSecurityGroups— A list of ClusterSecurityGroup instances.
• ClusterSecurityGroups:ClusterSecurityGroup— Describes a security group.
• ClusterSecurityGroups:ClusterSecurityGroup:ClusterSecurityGroupName— The name of thecluster security group to which the operation was applied.
• ClusterSecurityGroups:ClusterSecurityGroup:Description— A description of the security group.
• ClusterSecurityGroups:ClusterSecurityGroup:EC2SecurityGroups— A list of EC2 security groupsthat are permitted to access clusters associated with this cluster security group.
• ClusterSecurityGroups:ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup— Describesan Amazon EC2 security group.
• ClusterSecurityGroups:ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:Status—The status of the EC2 security group.
• ClusterSecurityGroups:ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:EC2SecurityGroupName—The name of the EC2 Security Group.
• ClusterSecurityGroups:ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:EC2SecurityGroupOwnerId—The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
• ClusterSecurityGroups:ClusterSecurityGroup:IPRanges— A list of IP ranges (CIDR blocks) thatare permitted to access clusters associated with this cluster security group.
• ClusterSecurityGroups:ClusterSecurityGroup:IPRanges:IPRange— Describes an IP range usedin a security group.
• ClusterSecurityGroups:ClusterSecurityGroup:IPRanges:IPRange:Status— The status of the IPrange, for example, "authorized".
• ClusterSecurityGroups:ClusterSecurityGroup:IPRanges:IPRange:CIDRIP— The IP range inClassless Inter-Domain Routing (CIDR) notation.
Examples
Get a Description of All Cluster Security GroupsThis example returns a description of all cluster security groups for the account. By default, the output isin JSON format.
PROMPT> aws redshift describe-cluster-security-groups{ "ClusterSecurityGroups": [ { "OwnerId": "100447751468", "Description": "default", "ClusterSecurityGroupName": "default", "EC2SecurityGroups": [], "IPRanges": [ { "Status": "authorized", "CIDRIP": "0.0.0.0/0" }
API Version 2012-12-0155
Amazon Redshift Command Line ReferenceOutput
] }, { "OwnerId": "100447751468", "Description": "This is my cluster security group", "ClusterSecurityGroupName": "mysecuritygroup", "EC2SecurityGroups": [], "IPRanges": [] },
(...remaining output omitted...)
describe-cluster-snapshots
DescriptionReturns 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 you AWS customeraccount. No information is returned for snapshots owned by inactive AWS customer accounts.
Syntaxdescribe-cluster-snapshots
[--cluster-identifier value]
[--snapshot-identifier value]
[--snapshot-type value]
[--start-time value]
[--end-time value]
[--max-records value]
[--marker value]
[--owner-account value]
Common Options (p. 9)
Options
RequiredDescriptionName
NoThe identifier of the cluster for which informationabout snapshots is requested.
--cluster-identifier
API Version 2012-12-0156
Amazon Redshift Command Line Referencedescribe-cluster-snapshots
RequiredDescriptionName
NoA time value that requests only snapshots createdat or before the specified time. The time value isspecified in ISO 8601 format. For more informationabout ISO 8601, go to the ISO8601 Wikipediapage.
Example: 2012-07-16T18:00:00Z
--end-time
NoAn optional marker returned by a previousdescribe-cluster-snapshots (p. 56) request toindicate the first snapshot that the request willreturn.
--marker
NoThe maximum number of snapshot records toinclude in the response. If more records exist thanthe specified MaxRecords value, the responsereturns a marker that you can use in a subsequentdescribe-cluster-snapshots (p. 56) request in orderto retrieve the next set of snapshot records.
Default: 100
Constraints: Must be at least 20 and no more than100.
--max-records
NoThe AWS customer account used to create or copythe snapshot. Use this field to filter the results tosnapshots owned by a particular account. Todescribe snapshots you own, either specify yourAWS customer account, or do not specify theparameter.
--owner-account
NoThe snapshot identifier of the snapshot about whichto return information.
--snapshot-identifier
NoThe type of snapshots for which you are requestinginformation. By default, snapshots of all types arereturned.
Valid Values: automated | manual
--snapshot-type
NoA value that requests only snapshots created at orafter the specified time.The time value is specifiedin ISO 8601 format. For more information aboutISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
--start-time
OutputThe command returns the following information:
• Marker— A marker that indicates the first snapshot that a subsequent describe-cluster-snapshots (p. 56)request will return. The response returns a marker only if there are more snapshots to list than thecurrent response can return.
• Snapshots— A list of Snapshot instances.
API Version 2012-12-0157
Amazon Redshift Command Line ReferenceOutput
• Snapshots:Snapshot— Describes a snapshot.
• Snapshots:Snapshot:SnapshotIdentifier— The snapshot identifier that is provided in the request.
• Snapshots:Snapshot:ClusterIdentifier— The identifier of the cluster for which the snapshot wastaken.
• Snapshots:Snapshot:SnapshotCreateTime— The time (UTC) when Amazon Redshift began thesnapshot. A snapshot contains a copy of the cluster data as of this exact time.
• Snapshots:Snapshot:Status— The snapshot status. The value of the status depends on the APIoperation used.
• create-cluster-snapshot (p. 33) and copy-cluster-snapshot (p. 26) returns status as "creating".
• describe-cluster-snapshots (p. 56) returns status as "creating", "available", or "failed".
• delete-cluster-snapshot (p. 42) returns status as "deleted".
• Snapshots:Snapshot:Port— The port that the cluster is listening on.
• Snapshots:Snapshot:AvailabilityZone— The Availability Zone in which the cluster was created.
• Snapshots:Snapshot:ClusterCreateTime— The time (UTC) when the cluster was originally created.
• Snapshots:Snapshot:MasterUsername— The master user name for the cluster.
• Snapshots:Snapshot:ClusterVersion— The version ID of the Amazon Redshift engine that is runningon the cluster.
• Snapshots:Snapshot:SnapshotType— The snapshot type. Snapshots created usingcreate-cluster-snapshot (p. 33) and copy-cluster-snapshot (p. 26) will be of type "manual".
• Snapshots:Snapshot:NodeType— The node type of the nodes in the cluster.
• Snapshots:Snapshot:NumberOfNodes— The number of nodes in the cluster.
• Snapshots:Snapshot:DBName— The name of the database that was created when the cluster wascreated.
• Snapshots:Snapshot:VpcId— The VPC identifier of the cluster if the snapshot is from a cluster in aVPC. Otherwise, this field is not in the output.
• Snapshots:Snapshot:Encrypted— If true, the data in the snapshot is encrypted at rest.
• Snapshots:Snapshot:AccountsWithRestoreAccess— A list of the AWS customer accounts authorizedto restore the snapshot. Returns null if no accounts are authorized.Visible only to the snapshot owner.
• Snapshots:Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess— Describes anAWS customer account authorized to restore a snapshot.
• Snapshots:Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess:AccountId—The identifier of an AWS customer account authorized to restore a snapshot.
• Snapshots:Snapshot:OwnerAccount— For manual snapshots, the AWS customer account used tocreate or copy the snapshot. For automatic snapshots, the owner of the cluster.The owner can performall snapshot actions, such as sharing a manual snapshot.
• Snapshots:Snapshot:TotalBackupSizeInMegaBytes— The size of the complete set of backup datathat would be used to restore the instance.
• Snapshots:Snapshot:ActualIncrementalBackupSizeInMegaBytes— The size of the incrementalbackup.
• Snapshots:Snapshot:BackupProgressInMegaBytes— The number of megabytes that have beentransferred to the snapshot backup.
• Snapshots:Snapshot:CurrentBackupRateInMegaBytesPerSecond— The number of megabytesper second being transferred to the snapshot backup. Returns 0 for a completed backup.
• Snapshots:Snapshot:EstimatedSecondsToCompletion— The estimate of the time remaining beforethe snapshot backup will complete. Returns 0 for a completed backup.
• Snapshots:Snapshot:ElapsedTimeInSeconds— The amount of time an in-progress snapshot backuphas been running, or the amount of time it took a completed backup to finish.
API Version 2012-12-0158
Amazon Redshift Command Line ReferenceOutput
Examples
Get a Description of All Cluster SnapshotsThis example returns a description of all cluster snapshots for the account. By default, the output is inJSON format.
PROMPT> aws redshift describe-cluster-snapshots
{ "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",
API Version 2012-12-0159
Amazon Redshift Command Line ReferenceExamples
"AvailabilityZone": "us-east-1a", "NodeType": "dw.hs1.xlarge", "Encrypted": false, "SnapshotType": "manual", "Port": 5439, "SnapshotIdentifier": "my-snapshot-id" } ]}
(...remaining output omitted...)
describe-cluster-subnet-groups
DescriptionReturns one or more cluster subnet group objects, which contain metadata about your cluster subnetgroups. By default, this operation returns information about all cluster subnet groups that are defined inyou AWS account.
Syntaxdescribe-cluster-subnet-groups
[--cluster-subnet-group-name value]
[--max-records value]
[--marker value]
Common Options (p. 9)
Options
RequiredDescriptionName
NoThe name of the cluster subnet group for whichinformation is requested.
--cluster-subnet-group-name
NoAn optional marker returned by a previousdescribe-cluster-subnet-groups (p. 60) request toindicate the first cluster subnet group that thecurrent request will return.
--marker
API Version 2012-12-0160
Amazon Redshift Command Line Referencedescribe-cluster-subnet-groups
RequiredDescriptionName
NoThe maximum number of cluster subnet grouprecords to include in the response. If more recordsexist than the specified MaxRecords value, theresponse returns a marker that you can use in asubsequent describe-cluster-subnet-groups (p. 60)request in order to retrieve the next set of clustersubnet group records.
Default: 100
Constraints: Must be at least 20 and no more than100.
--max-records
OutputThe command returns the following information:
• Marker— A marker at which to continue listing cluster subnet groups in a new request. A marker isreturned if there are more cluster subnet groups to list than were returned in the response.
• ClusterSubnetGroups— A list of ClusterSubnetGroup instances.
• ClusterSubnetGroups:ClusterSubnetGroup— Describes a subnet group.
• ClusterSubnetGroups:ClusterSubnetGroup:ClusterSubnetGroupName— The name of the clustersubnet group.
• ClusterSubnetGroups:ClusterSubnetGroup:Description— The description of the cluster subnetgroup.
• ClusterSubnetGroups:ClusterSubnetGroup:VpcId— The VPC ID of the cluster subnet group.
• ClusterSubnetGroups:ClusterSubnetGroup:SubnetGroupStatus— The status of the cluster subnetgroup. Possible values are Complete, Incomplete and Invalid.
• ClusterSubnetGroups:ClusterSubnetGroup:Subnets— A list of the VPC Subnet elements.
• ClusterSubnetGroups:ClusterSubnetGroup:Subnets:Subnet— Describes a subnet.
• ClusterSubnetGroups:ClusterSubnetGroup:Subnets:Subnet:SubnetIdentifier— The identifier ofthe subnet.
• ClusterSubnetGroups:ClusterSubnetGroup:Subnets:Subnet:SubnetAvailabilityZone— Describesan availability zone.
• ClusterSubnetGroups:ClusterSubnetGroup:Subnets:Subnet:SubnetAvailabilityZone:Name—The name of the availability zone.
• ClusterSubnetGroups:ClusterSubnetGroup:Subnets:Subnet:SubnetStatus— The status of thesubnet.
Examples
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.
PROMPT> aws redshift describe-cluster-subnet-groups{
API Version 2012-12-0161
Amazon Redshift Command Line ReferenceOutput
"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" }}
describe-cluster-versions
DescriptionReturns descriptions of the available Amazon Redshift cluster versions.You can call this operation evenbefore creating any clusters to learn more about the Amazon Redshift versions. For more informationabout managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide
Syntaxdescribe-cluster-versions
[--cluster-version value]
[--cluster-parameter-group-family value]
[--max-records value]
[--marker value]
Common Options (p. 9)
API Version 2012-12-0162
Amazon Redshift Command Line Referencedescribe-cluster-versions
Options
RequiredDescriptionName
NoThe name of a specific cluster parameter groupfamily to return details for.
Constraints:
• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain twoconsecutive hyphens
--cluster-parameter-group-family
NoThe specific cluster version to return.
Example: 1.0
--cluster-version
NoThe marker returned from a previous request. Ifthis parameter is specified, the response includesrecords beyond the marker only, up toMaxRecords.
--marker
NoThe maximum number of records to include in theresponse. If more than the MaxRecords value isavailable, a marker is included in the response sothat the following results can be retrieved.
Default: 100
Constraints:Value must be at least 20 and no morethan 100.
--max-records
OutputThe command returns the following information:
• Marker— The identifier returned to allow retrieval of paginated results.
• ClusterVersions— A list of Version elements.
• ClusterVersions:ClusterVersion— Describes a cluster version, including the parameter group familyand description of the version.
• ClusterVersions:ClusterVersion:ClusterVersion— The version number used by the cluster.
• ClusterVersions:ClusterVersion:ClusterParameterGroupFamily— The name of the cluster parametergroup family for the cluster.
• ClusterVersions:ClusterVersion:Description— The description of the cluster version.
Examples
Get a Description of All Cluster VersionsThis example returns a description of all cluster versions. By default, the output is in JSON format.
API Version 2012-12-0163
Amazon Redshift Command Line ReferenceOptions
PROMPT> aws redshift describe-cluster-versions
{ "ClusterVersions": [ { "ClusterVersion": "1.0", "Description": "Initial release", "ClusterParameterGroupFamily": "redshift-1.0" } ], "ResponseMetadata": { "RequestId": "16a53de3-64cc-11e2-bec0-17624ad140dd" }}
describe-default-cluster-parameters
DescriptionReturns a list of parameter settings for the specified parameter group family.
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups inthe Amazon Redshift Management Guide.
Syntaxdescribe-default-cluster-parameters
--parameter-group-family value
[--max-records value]
[--marker value]
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name of the cluster parameter group family.--parameter-group-family
NoAn optional marker returned from a previousdescribe-default-cluster-parameters request. Ifthis parameter is specified, the response includesonly records beyond the marker, up to the valuespecified by MaxRecords.
--marker
API Version 2012-12-0164
Amazon Redshift Command Line Referencedescribe-default-cluster-parameters
RequiredDescriptionName
NoThe maximum number of records to include in theresponse. If more records exist than the specifiedMaxRecords value, a marker is included in theresponse so that the remaining results may beretrieved.
Default: 100
Constraints:Value must be at least 20 and no morethan 100.
--max-records
OutputThe command returns the following information:
• DefaultClusterParameters— Describes the default cluster parameters for a parameter group family.
• DefaultClusterParameters:ParameterGroupFamily— The name of the cluster parameter groupfamily to which the engine default parameters apply.
• DefaultClusterParameters:Marker— An identifier to allow retrieval of paginated results.
• DefaultClusterParameters:Parameters— The list of cluster default parameters.
• DefaultClusterParameters:Parameters:Parameter— Describes a parameter in a cluster parametergroup.
• DefaultClusterParameters:Parameters:Parameter:ParameterName— The name of the parameter.
• DefaultClusterParameters:Parameters:Parameter:ParameterValue— The value of the parameter.
• DefaultClusterParameters:Parameters:Parameter:Description— A description of the parameter.
• DefaultClusterParameters:Parameters:Parameter:Source— The source of the parameter value,such as "engine-default" or "user".
• DefaultClusterParameters:Parameters:Parameter:DataType— The data type of the parameter.
• DefaultClusterParameters:Parameters:Parameter:AllowedValues— The valid range of values forthe parameter.
• DefaultClusterParameters:Parameters:Parameter:IsModifiable— If true, the parameter can bemodified. Some parameters have security or operational implications that prevent them from beingchanged.
• DefaultClusterParameters:Parameters:Parameter:MinimumEngineVersion— The earliest engineversion to which the parameter can apply.
Examples
Get a Description of Default Cluster ParametersThis example returns a description of the default cluster parameters for the redshift-1.0 family. Bydefault, the output is in JSON format.
PROMPT> aws redshift describe-default-cluster-parameters --parameter-group-family redshift-1.0
{
API Version 2012-12-0165
Amazon Redshift Command Line ReferenceOutput
"DefaultClusterParameters": { "ParameterGroupFamily": "redshift-1.0", "Parameters": [ { "Description": "Sets the display format for date and time val ues.", "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...)
TipTo see a list of valid parameter group families, use the describe-cluster-parameter-groupscommand.
describe-events
DescriptionReturns events related to clusters, security groups, snapshots, and parameter groups for the past 14days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtainedby providing the name as a parameter. By default, the past hour of events are returned.
Syntaxdescribe-events
[--source-identifier value]
[--source-type value]
[--start-time value]
[--end-time value]
[--duration value]
[--max-records value]
API Version 2012-12-0166
Amazon Redshift Command Line Referencedescribe-events
[--marker value]
Common Options (p. 9)
Options
RequiredDescriptionName
NoThe number of minutes prior to the time of therequest for which to retrieve events. For example,if the request is sent at 18:00 and you specify aduration of 60, then only events which haveoccurred after 17:00 will be returned.
Default: 60
--duration
NoThe end of the time interval for which to retrieveevents, specified in ISO 8601 format. For moreinformation about ISO 8601, go to the ISO8601Wikipedia page.
Example: 2009-07-08T18:00Z
--end-time
NoAn optional marker returned from a previousdescribe-events request. If this parameter isspecified, the response includes only recordsbeyond the marker, up to the value specified byMaxRecords.
--marker
NoThe maximum number of records to include in theresponse. If more records exist than the specifiedMaxRecords value, a marker is included in theresponse so that the remaining results may beretrieved.
Default: 100
Constraints:Value must be at least 20 and no morethan 100.
--max-records
NoThe identifier of the event source for which eventswill be returned. If this parameter is not specified,then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType mustalso be provided.
• Specify a cluster identifier when SourceType iscluster.
• Specify a cluster security group name whenSourceType is cluster-security-group.
• Specify a cluster parameter group name whenSourceType is cluster-parameter-group.
• Specify a cluster snapshot identifier whenSourceType is cluster-snapshot.
--source-identifier
API Version 2012-12-0167
Amazon Redshift Command Line ReferenceOptions
RequiredDescriptionName
NoThe event source to retrieve events for. If no valueis specified, all events are returned.
Constraints:
If SourceType is supplied, SourceIdentifier mustalso be provided.
• Specify cluster when SourceIdentifier is acluster identifier.
• Specify cluster-security-group whenSourceIdentifier is a cluster security group name.
• Specify cluster-parameter-group whenSourceIdentifier is a cluster parameter groupname.
• Specify cluster-snapshot whenSourceIdentifier is a cluster snapshot identifier.
--source-type
NoThe beginning of the time interval to retrieve eventsfor, specified in ISO 8601 format. For moreinformation about ISO 8601, go to the ISO8601Wikipedia page.
Example: 2009-07-08T18:00Z
--start-time
OutputThe command returns the following information:
• Marker— A marker at which to continue listing events in a new request.The response returns a markerif there are more events to list than returned in the response.
• Events— A list of Event instances.
• Events:Event— Describes an event.
• Events:Event:SourceIdentifier— The identifier for the source of the event.
• Events:Event:SourceType— The source type for this event.
• Events:Event:Message— The text of this event.
• Events:Event:Date— The date and time of the event.
Examples
Describe All EventsThis example returns all events. By default, the output is in JSON format.
PROMPT> aws redshift describe-events{ "Events": [
API Version 2012-12-0168
Amazon Redshift Command Line ReferenceOutput
{ "Date": "2013-01-22T19:17:03.640Z", "SourceIdentifier": "myclusterparametergroup", "Message": "Cluster parameter group myclusterparametergroup has been created.", "SourceType": "cluster-parameter-group" } ], "ResponseMetadata": { "RequestId": "9f056111-64c9-11e2-9390-ff04f2c1e638" }}
You can also obtain the same information in text format using the --output text option.
PROMPT> aws redshift describe-events --output text
2013-01-22T19:17:03.640Z myclusterparametergroup Cluster parameter group myc lusterparametergroup has been created. cluster-parameter-groupRESPONSEMETADATA 8e5fe765-64c9-11e2-bce3-e56f52c50e17
describe-orderable-cluster-options
DescriptionReturns a list of orderable cluster options. Before you create a new cluster you can use this operation tofind what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region thatyou 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 specificregion and specify values when creating a cluster. For more information about managing clusters, go toAmazon Redshift Clusters in the Amazon Redshift Management Guide
Syntaxdescribe-orderable-cluster-options
[--cluster-version value]
[--node-type value]
[--max-records value]
[--marker value]
Common Options (p. 9)
API Version 2012-12-0169
Amazon Redshift Command Line Referencedescribe-orderable-cluster-options
Options
RequiredDescriptionName
NoThe version filter value. Specify this parameter toshow only the available offerings matching thespecified version.
Default: All versions.
Constraints: Must be one of the version returnedfrom describe-cluster-versions (p. 62).
--cluster-version
NoAn optional marker returned from a previousdescribe-orderable-cluster-options request. Ifthis parameter is specified, the response includesonly records beyond the marker, up to the valuespecified by MaxRecords.
--marker
NoThe maximum number of records to include in theresponse. If more records exist than the specifiedMaxRecords value, a marker is included in theresponse so that the remaining results may beretrieved.
Default: 100
Constraints: minimum 20, maximum 100.
--max-records
NoThe node type filter value. Specify this parameterto show only the available offerings matching thespecified node type.
--node-type
OutputThe command returns the following information:
• OrderableClusterOptions— An OrderableClusterOption structure containing information aboutorderable options for the Cluster.
• OrderableClusterOptions:OrderableClusterOption— Describes an orderable cluster option.
• OrderableClusterOptions:OrderableClusterOption:ClusterVersion— The version of the orderablecluster.
• OrderableClusterOptions:OrderableClusterOption:ClusterType— The cluster type, for examplemulti-node.
• OrderableClusterOptions:OrderableClusterOption:NodeType— The node type for the orderablecluster.
• OrderableClusterOptions:OrderableClusterOption:AvailabilityZones— A list of availability zonesfor the orderable cluster.
• OrderableClusterOptions:OrderableClusterOption:AvailabilityZones:AvailabilityZone— Describesan availability zone.
• OrderableClusterOptions:OrderableClusterOption:AvailabilityZones:AvailabilityZone:Name—The name of the availability zone.
• Marker— A marker that can be used to retrieve paginated results.
API Version 2012-12-0170
Amazon Redshift Command Line ReferenceOptions
Examples
Describing All Orderable Cluster OptionsThis example returns descriptions of all orderable cluster options. By default, the output is in JSON format.
PROMPT> aws redshift describe-orderable-cluster-options
{ "OrderableClusterOptions": [ { "NodeType": "dw.hs1.8xlarge", "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" } ], "ClusterVersion": "1.0", "ClusterType": "multi-node" }, { "NodeType": "dw.hs1.xlarge", "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" } ], "ClusterVersion": "1.0", "ClusterType": "multi-node" }, { "NodeType": "dw.hs1.xlarge", "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" } ],
API Version 2012-12-0171
Amazon Redshift Command Line ReferenceExamples
"ClusterVersion": "1.0", "ClusterType": "single-node" } ], "ResponseMetadata": { "RequestId": "f6000035-64cb-11e2-9135-ff82df53a51a" }}
You can also obtain the same information in text format using the --output text option.
PROMPT> aws redshift describe-orderable-cluster-options --output text
dw.hs1.8xlarge 1.0 multi-nodeus-east-1aus-east-1bus-east-1cdw.hs1.xlarge 1.0 multi-nodeus-east-1aus-east-1bus-east-1cdw.hs1.xlarge 1.0 single-nodeus-east-1aus-east-1bus-east-1cRESPONSEMETADATA e648696b-64cb-11e2-bec0-17624ad140dd
describe-reserved-node-offerings
DescriptionReturns a list of the available reserved node offerings by Amazon Redshift with their descriptions includingthe node type, the fixed and recurring costs of reserving the node and duration the node will be reservedfor you. These descriptions help you determine which reserve node offering you want to purchase.Youthen use the unique offering ID in you call to purchase-reserved-node-offering (p. 88) to reserve one ormore nodes for your Amazon Redshift cluster.
For more information about managing parameter groups, go to Purchasing Reserved Nodes in the AmazonRedshift Management Guide.
Syntaxdescribe-reserved-node-offerings
[--reserved-node-offering-id value]
[--max-records value]
[--marker value]
API Version 2012-12-0172
Amazon Redshift Command Line Referencedescribe-reserved-node-offerings
Common Options (p. 9)
Options
RequiredDescriptionName
NoAn optional marker returned by a previousdescribe-reserved-node-offerings (p. 72) requestto indicate the first offering that the request willreturn.
You can specify either a Marker parameter or aClusterIdentifier parameter in adescribe-clusters (p. 50) request, but not both.
--marker
NoThe maximum number of records to include in theresponse. If more records exist than the specifiedMaxRecords value, a marker is included in theresponse so that the remaining results may beretrieved.
Default: 100
Constraints: minimum 20, maximum 100.
--max-records
NoThe unique identifier for the offering.--reserved-node-offering-id
OutputThe command returns the following information:
• Marker— An optional marker returned by a previous describe-reserved-node-offerings (p. 72) requestto indicate the first reserved node offering that the request will return.
• ReservedNodeOfferings— A list of reserved node offerings.
• ReservedNodeOfferings:ReservedNodeOffering— Describes a reserved node offering.
• ReservedNodeOfferings:ReservedNodeOffering:ReservedNodeOfferingId— The offering identifier.
• ReservedNodeOfferings:ReservedNodeOffering:NodeType— The node type offered by the reservednode offering.
• ReservedNodeOfferings:ReservedNodeOffering:Duration— The duration, in seconds, for whichthe offering will reserve the node.
• ReservedNodeOfferings:ReservedNodeOffering:FixedPrice— The upfront fixed charge you willpay to purchase the specific reserved node offering.
• ReservedNodeOfferings:ReservedNodeOffering:UsagePrice— The rate you are charged for eachhour the cluster that is using the offering is running.
• ReservedNodeOfferings:ReservedNodeOffering:CurrencyCode— The currency code for thecompute nodes offering.
• ReservedNodeOfferings:ReservedNodeOffering:OfferingType— The anticipated utilization of thereserved node, as defined in the reserved node offering.
• ReservedNodeOfferings:ReservedNodeOffering:RecurringCharges— The charge to your accountregardless of whether you are creating any clusters using the node offering. Recurring charges areonly in effect for heavy-utilization reserved nodes.
• ReservedNodeOfferings:ReservedNodeOffering:RecurringCharges:RecurringCharge— Describesa recurring charge.
API Version 2012-12-0173
Amazon Redshift Command Line ReferenceOptions
• ReservedNodeOfferings:ReservedNodeOffering:RecurringCharges:RecurringCharge:RecurringChargeAmount—The amount charged per the period of time specified by the recurring charge frequency.
• ReservedNodeOfferings:ReservedNodeOffering:RecurringCharges:RecurringCharge:RecurringChargeFrequency—The frequency at which the recurring charge amount is applied.
Examples
Describe Reserved Node OfferingsThis example shows all of the reserved node offerings that are available for purchase.
PROMPT> aws redshift describe-reserved-node-offerings
{ "ReservedNodeOfferings": [ { "OfferingType": "Heavy Utilization", "FixedPrice": "", "NodeType": "dw.hs1.xlarge", "UsagePrice": "", "RecurringCharges": [ { "RecurringChargeAmount": "", "RecurringChargeFrequency": "Hourly" } ], "Duration": 31536000, "ReservedNodeOfferingId": "ceb6a579-cf4c-4343-be8b-d832c45ab51c" }, { "OfferingType": "Heavy Utilization", "FixedPrice": "", "NodeType": "dw.hs1.8xlarge", "UsagePrice": "", "RecurringCharges": [ { "RecurringChargeAmount": "", "RecurringChargeFrequency": "Hourly" } ], "Duration": 31536000, "ReservedNodeOfferingId": "e5a2ff3b-352d-4a9c-ad7d-373c4cab5dd2" }, ...remaining output omitted... ], "ResponseMetadata": { "RequestId": "8b1a1a43-75ff-11e2-9666-e142fe91ddd1" }}
If you want to purchase a reserved node offering, you can call purchase-reserved-node-offeringusing a valid ReservedNodeOfferingId.
API Version 2012-12-0174
Amazon Redshift Command Line ReferenceExamples
describe-reserved-nodes
DescriptionReturns the descriptions of the reserved nodes.
Syntaxdescribe-reserved-nodes
[--reserved-node-id value]
[--max-records value]
[--marker value]
Common Options (p. 9)
Options
RequiredDescriptionName
NoAn optional marker returned by a previousdescribe-reserved-nodes (p. 75) request to indicatethe first parameter group that the current requestwill return.
--marker
NoThe maximum number of records to include in theresponse. If more records exist than the specifiedMaxRecords value, a marker is included in theresponse so that the remaining results may beretrieved.
Default: 100
Constraints: minimum 20, maximum 100.
--max-records
NoIdentifier for the node reservation.--reserved-node-id
OutputThe command returns the following information:
• Marker— A marker that can be used to retrieve paginated results.
• ReservedNodes— The list of reserved nodes.
• ReservedNodes:ReservedNode— Describes a reserved node.
• ReservedNodes:ReservedNode:ReservedNodeId— The unique identifier for the reservation.
• ReservedNodes:ReservedNode:ReservedNodeOfferingId— The identifier for the reserved nodeoffering.
• ReservedNodes:ReservedNode:NodeType— The node type of the reserved node.
• ReservedNodes:ReservedNode:StartTime— The time the reservation started.You purchase areserved node offering for a duration. This is the start time of that duration.
API Version 2012-12-0175
Amazon Redshift Command Line Referencedescribe-reserved-nodes
• ReservedNodes:ReservedNode:Duration— The duration of the node reservation in seconds.
• ReservedNodes:ReservedNode:FixedPrice— The fixed cost Amazon Redshift charged you for thisreserved node.
• ReservedNodes:ReservedNode:UsagePrice— The hourly rate Amazon Redshift charge you for thisreserved node.
• ReservedNodes:ReservedNode:CurrencyCode— The currency code for the reserved cluster.
• ReservedNodes:ReservedNode:NodeCount— The number of reserved compute nodes.
• ReservedNodes:ReservedNode:State— The state of the reserved Compute Node. Possible Values:
• pending-payment-This reserved node has recently been purchased, and the sale has been approved,but payment has not yet been confirmed.
• active-This reserved node is owned by the caller and is available for use.
• payment-failed-Payment failed for the purchase attempt.
• ReservedNodes:ReservedNode:OfferingType— The anticipated utilization of the reserved node, asdefined in the reserved node offering.
• ReservedNodes:ReservedNode:RecurringCharges— The recurring charges for the reserved node.
• ReservedNodes:ReservedNode:RecurringCharges:RecurringCharge— Describes a recurringcharge.
• ReservedNodes:ReservedNode:RecurringCharges:RecurringCharge:RecurringChargeAmount—The amount charged per the period of time specified by the recurring charge frequency.
• ReservedNodes:ReservedNode:RecurringCharges:RecurringCharge:RecurringChargeFrequency—The frequency at which the recurring charge amount is applied.
Examples
Describe Reserved NodesThis example shows a reserved node offering that has been purchased.
PROMPT> aws redshift describe-reserved-nodes
{ "ResponseMetadata": { "RequestId": "bc29ce2e-7600-11e2-9949-4b361e7420b7" }, "ReservedNodes": [ { "OfferingType": "Heavy Utilization", "FixedPrice": "", "NodeType": "dw.hs1.xlarge", "ReservedNodeId": "1ba8e2e3-bc01-4d65-b35d-a4a3e931547e", "UsagePrice": "", "RecurringCharges": [ { "RecurringChargeAmount": "", "RecurringChargeFrequency": "Hourly" } ], "NodeCount": 1, "State": "payment-pending", "StartTime": "2013-02-13T17:08:39.051Z", "Duration": 31536000, "ReservedNodeOfferingId": "ceb6a579-cf4c-4343-be8b-d832c45ab51c"
API Version 2012-12-0176
Amazon Redshift Command Line ReferenceExamples
} ]}
describe-resize
DescriptionReturns information about the last resize operation for the specified cluster. If no resize operation hasever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiatedand completed, the status of the resize remains as SUCCEEDED until the next resize.
A resize operation can be requested using modify-cluster (p. 78) and specifying a different number ortype of nodes for the cluster.
Syntaxdescribe-resize
--cluster-identifier value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe unique identifier of a cluster whose resizeprogress you are requesting. This parameter isn'tcase-sensitive.
By default, resize operations for all clusters definedfor an AWS account are returned.
--cluster-identifier
OutputThe command returns the following information:
• TargetNodeType— The node type that the cluster will have after the resize is complete.
• TargetNumberOfNodes— The number of nodes that the cluster will have after the resize is complete.
• TargetClusterType— The cluster type after the resize is complete. Valid Values: multi-node |single-node
• Status— The status of the resize operation.Valid Values:NONE | IN_PROGRESS | FAILED | SUCCEEDED
• ImportTablesCompleted— The names of tables that have been completely imported . Valid Values:List of table names.
• ImportTablesCompleted:—
• ImportTablesInProgress— The names of tables that are being currently imported. Valid Values: Listof table names.
• ImportTablesInProgress:—
API Version 2012-12-0177
Amazon Redshift Command Line Referencedescribe-resize
• ImportTablesNotStarted— The names of tables that have not been yet imported. Valid Values: Listof table names
• ImportTablesNotStarted:—
Examples
Describe ResizeThis example describes the latest resize of a cluster. The request was for 3 nodes of typedw.hs1.8xlarge.
aws redshift describe-resize --cluster-identifier mycluster
{ "Status": "NONE", "TargetClusterType": "multi-node", "TargetNodeType": "dw.hs1.8xlarge", "ResponseMetadata": { "RequestId": "9f52b0b4-7733-11e2-aa9b-318b2909bd27" }, "TargetNumberOfNodes": "3"}
modify-cluster
DescriptionModifies the settings for a cluster. For example, you can add another security or parameter group, updatethe preferred maintenance window, or change the master user password. Resetting a cluster passwordor modifying the security groups associated with a cluster do not need a reboot. However, modifyingparameter group requires a reboot for parameters to take effect. For more information about managingclusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide
You can also change node type and the number of nodes to scale up or down the cluster. When resizinga cluster, you must specify both the number of nodes and the node type even if one of the parametersdoes not change. If you specify the same number of nodes and node type that are already configured forthe cluster, an error is returned.
Syntaxmodify-cluster
--cluster-identifier value
[--cluster-type value]
[--node-type value]
[--number-of-nodes value]
[--cluster-security-groups value]
API Version 2012-12-0178
Amazon Redshift Command Line ReferenceExamples
[--vpc-security-group-ids value]
[--master-user-password value]
[--cluster-parameter-group-name value]
[--automated-snapshot-retention-period value]
[--preferred-maintenance-window value]
[--cluster-version value]
[--allow-version-upgrade]
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe unique identifier of the cluster to be modified.
Example: examplecluster
--cluster-identifier
NoIf true, upgrades will be applied automatically tothe cluster during the maintenance window.
Default: false
--allow-version-upgrade
NoThe number of days that automated snapshots areretained. If the value is 0, automated snapshotsare disabled. Even if automated snapshots aredisabled, you can still create manual snapshotswhen you want with create-cluster-snapshot (p. 33).
If you decrease the automated snapshot retentionperiod from its current value, existing automatedsnapshots which fall outside of the new retentionperiod will be immediately deleted.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
--automated-snapshot-retention-period
NoThe name of the cluster parameter group to applyto this cluster.This change is applied only after thecluster is rebooted. To reboot a cluster usereboot-cluster (p. 90).
Default: Uses existing setting.
Constraints: The cluster parameter group must bein the same parameter group family that matchesthe cluster version.
--cluster-parameter-group-name
API Version 2012-12-0179
Amazon Redshift Command Line ReferenceOptions
RequiredDescriptionName
NoA list of cluster security groups to be authorized onthis cluster.This change is asynchronously appliedas soon as possible.
Security groups currently associated with thecluster and not in the list of groups to apply, will berevoked from the cluster.
Constraints:
• Must be 1 to 255 alphanumeric characters orhyphens
• First character must be a letter
• Cannot end with a hyphen or contain twoconsecutive hyphens
--cluster-security-groups
NoThe new cluster type.
When you submit your cluster resize request, yourexisting cluster goes into a read-only mode. AfterAmazon Redshift provisions a new cluster basedon your resize requirements, there will be outagefor a period while the old cluster is deleted and yourconnection is switched to the new cluster.You canuse describe-resize (p. 77) to track the progressof the resize request.
Valid Values: multi-node | single-node
--cluster-type
NoThe new version number of the Amazon Redshiftengine to upgrade to.
For major version upgrades, if a non-default clusterparameter group is currently in use, a new clusterparameter group in the cluster parameter groupfamily for the new version must be specified. Thenew cluster parameter group can be the default forthat cluster parameter group family. For moreinformation about managing parameter groups, goto Amazon Redshift Parameter Groups in theAmazon Redshift Management Guide.
Example: 1.0
--cluster-version
API Version 2012-12-0180
Amazon Redshift Command Line ReferenceOptions
RequiredDescriptionName
NoThe new password for the cluster master user.Thischange is asynchronously applied as soon aspossible. Between the time of the request and thecompletion of the request, theMasterUserPassword element exists in thePendingModifiedValues element of theoperation response.
NoteOperations never return the password, sothis operation provides a way to regainaccess to the master user account for acluster if the password is lost.
Default: Uses existing setting.
Constraints:
• Must be between 8 and 64 characters in length.
• Must contain at least one uppercase letter.
• Must contain at least one lowercase letter.
• Must contain one number.
• Can be any printable ASCII character (ASCIIcode 33 to 126) except ' (single quote), " (doublequote), \, /, @, or space.
--master-user-password
NoThe new node type of the cluster. If you specify anew node type, you must also specify the numberof nodes parameter also.
When you submit your request to resize a cluster,Amazon Redshift sets access permissions for thecluster to read-only. After Amazon Redshiftprovisions a new cluster according to your resizerequirements, there will be a temporary outagewhile the old cluster is deleted and your connectionis switched to the new cluster. When the newconnection is complete, the original accesspermissions for the cluster are restored.You canuse the describe-resize (p. 77) to track the progressof the resize request.
Valid Values: dw.hs1.xlarge |dw.hs1.8xlarge
--node-type
API Version 2012-12-0181
Amazon Redshift Command Line ReferenceOptions
RequiredDescriptionName
NoThe new number of nodes of the cluster. If youspecify a new number of nodes, you must alsospecify the node type parameter also.
When you submit your request to resize a cluster,Amazon Redshift sets access permissions for thecluster to read-only. After Amazon Redshiftprovisions a new cluster according to your resizerequirements, there will be a temporary outagewhile the old cluster is deleted and your connectionis switched to the new cluster. When the newconnection is complete, the original accesspermissions for the cluster are restored.You canuse describe-resize (p. 77) to track the progressof the resize request.
Valid Values: Integer greater than 0.
--number-of-nodes
NoThe weekly time range (in UTC) during whichsystem maintenance can occur, if necessary. Ifsystem maintenance is necessary during thewindow, it may result in an outage.
This maintenance window change is madeimmediately. If the new maintenance windowindicates the current time, there must be at least120 minutes between the current time and end ofthe window in order to ensure that pending changesare applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi, for examplewed:07:30-wed:08:00.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
--preferred-maintenance-window
NoA list of Virtual Private Cloud (VPC) security groupsto be associated with the cluster.
--vpc-security-group-ids
OutputThe command returns the following information:
• Cluster— Describes a cluster.
• Cluster:ClusterIdentifier— The unique identifier of the cluster.
• Cluster:NodeType— The node type for the nodes in the cluster.
• Cluster:ClusterStatus— The current state of this cluster. Possible values include available,creating, deleting, rebooting, and resizing.
• Cluster:ModifyStatus— The status of a modify operation, if any, initiated for the cluster.
• Cluster:MasterUsername— The master user name for the cluster. This name is used to connect tothe database that is specified in DBName.
API Version 2012-12-0182
Amazon Redshift Command Line ReferenceOutput
• Cluster:DBName— The name of the initial database that was created when the cluster was created.This same name is returned for the life of the cluster. If an initial database was not specified, a databasenamed "dev" was created by default.
• Cluster:Endpoint— The connection endpoint.
• Cluster:Endpoint:Address— The DNS address of the Cluster.
• Cluster:Endpoint:Port— The port that the database engine is listening on.
• Cluster:ClusterCreateTime— The date and time that the cluster was created.
• Cluster:AutomatedSnapshotRetentionPeriod— The number of days that automatic cluster snapshotsare retained.
• Cluster:ClusterSecurityGroups— A list of cluster security group that are associated with the cluster.Each security group is represented by an element that contains ClusterSecurityGroup.Name andClusterSecurityGroup.Status subelements. Cluster security groups are used when the clusteris not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listedby the VpcSecurityGroups parameter.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup— Describes a security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:ClusterSecurityGroupName— The nameof the cluster security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:Status— The status of the cluster securitygroup.
• Cluster:VpcSecurityGroups— A list of Virtual Private Cloud (VPC) security groups that are associatedwith the cluster. This parameter is returned only if the cluster is in a VPC.
• Cluster:VpcSecurityGroups:VpcSecurityGroup— Describes the members of a VPC security group.
• Cluster:VpcSecurityGroups:VpcSecurityGroup:VpcSecurityGroupId—
• Cluster:VpcSecurityGroups:VpcSecurityGroup:Status—
• Cluster:ClusterParameterGroups— The list of cluster parameter groups that are associated with thiscluster.
• Cluster:ClusterParameterGroups:ClusterParameterGroup— Describes the status of a parametergroup.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterGroupName— The nameof the cluster parameter group.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterApplyStatus— The statusof parameter updates.
• Cluster:ClusterSubnetGroupName— The name of the subnet group that is associated with the cluster.This parameter is valid only when the cluster is in a VPC.
• Cluster:VpcId— The identifier of the VPC the cluster is in, if the cluster is in a VPC.
• Cluster:AvailabilityZone— The name of the Availability Zone in which the cluster is located.
• Cluster:PreferredMaintenanceWindow— The weekly time range (in UTC) during which systemmaintenance can occur.
• Cluster:PendingModifiedValues— If present, changes to the cluster are pending. Specific pendingchanges are identified by subelements.
• Cluster:PendingModifiedValues:MasterUserPassword— The pending or in-progress change of themaster credentials for the cluster.
• Cluster:PendingModifiedValues:NodeType— The pending or in-progress change of the cluster'snode type.
• Cluster:PendingModifiedValues:NumberOfNodes— The pending or in-progress change of thenumber nodes in the cluster.
• Cluster:PendingModifiedValues:ClusterType— The pending or in-progress change of the clustertype.
• Cluster:PendingModifiedValues:ClusterVersion— The pending or in-progress change of the serviceversion.
API Version 2012-12-0183
Amazon Redshift Command Line ReferenceOutput
• Cluster:PendingModifiedValues:AutomatedSnapshotRetentionPeriod— The pending or in-progresschange of the automated snapshot retention period.
• Cluster:ClusterVersion— The version ID of the Amazon Redshift engine that is running on the cluster.
• Cluster:AllowVersionUpgrade— If true, version upgrades will be applied automatically to the clusterduring the maintenance window.
• Cluster:NumberOfNodes— The number of compute nodes in the cluster.
• Cluster:PubliclyAccessible— If true, the cluster can be accessed from a public network.
• Cluster:Encrypted— If true, data in cluster is encrypted at rest.
Examples
Associate a Security Group with a ClusterThis example shows how to associate a cluster security group with the specified cluster.
PROMPT> aws redshift modify-cluster --cluster-identifier mycluster --cluster-security-groups mysecuritygroup
Modify the Maintenance Window for a ClusterThis shows how to change the weekly preferred maintenance window for a cluster to be the minimumfour hour window starting Sundays at 11:15 PM, and ending Mondays at 3:15 AM.
PROMPT> aws redshift modify-cluster --cluster-identifier mycluster --preferred-maintenance-window Sun:23:15-Mon:03:15
Change the Master Password for the ClusterThis example shows how to change the master password for a cluster.
PROMPT> aws redshift modify-cluster --cluster-identifier mycluster --master-user-password A1b2c3d4
modify-cluster-parameter-group
DescriptionModifies the parameters of a parameter group.
API Version 2012-12-0184
Amazon Redshift Command Line ReferenceExamples
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups inthe Amazon Redshift Management Guide.
Syntaxmodify-cluster-parameter-group
--parameter-group-name value
--parameters value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name of the parameter group to be modified.--parameter-group-name
YesAn array of parameters to be modified. A maximumof 20 parameters can be modified in a singlerequest.
For each parameter to be modified, you mustsupply at least the parameter name and parametervalue; other name-value pairs of the parameter areoptional.
Describes a parameter in a cluster parametergroup.
parameter_name (string)The name of the parameter.
parameter_value (string)The value of the parameter.
description (string)A description of the parameter.
source (string)The source of the parameter value, such as"engine-default" or "user".
data_type (string)The data type of the parameter.
allowed_values (string)The valid range of values for the parameter.
is_modifiable (boolean)If true, the parameter can be modified. Someparameters have security or operationalimplications that prevent them from beingchanged.
minimum_engine_version (string)The earliest engine version to which theparameter can apply.
--parameters
API Version 2012-12-0185
Amazon Redshift Command Line ReferenceSyntax
OutputThe command returns the following information:
• ParameterGroupName— The name of the cluster parameter group.
• ParameterGroupStatus— The status of the parameter group. For example, if you made a change toa parameter group name-value pair, then the change could be pending a reboot of an associatedcluster.
Examples
Modify a Parameter in a Parameter GroupThis example shows how to modify the wlm_json_configuration parameter for workload management.
PROMPT> aws redshift modify-cluster-parameter-group --parameter-group-name myc lusterparametergroup --parameters '{"parameter_name":"wlm_json_configura tion","parameter_value":"[{\"user_group\":[\"ex ample_user_group1\"],\"query_group\":[\"example_query_group1\"],\"query_concur rency\":7},{\"query_concurrency\":5}]"}'
{ "ParameterGroupStatus": "Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters.", "ParameterGroupName": "myclusterparametergroup", "ResponseMetadata": { "RequestId": "09974cc0-64cd-11e2-bea9-49e0ce183f07" }}
modify-cluster-subnet-group
DescriptionModifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces theexisting list of subnets with the new list of subnets.
Syntaxmodify-cluster-subnet-group
--cluster-subnet-group-name value
--subnet-ids value
[--description value]
Common Options (p. 9)
API Version 2012-12-0186
Amazon Redshift Command Line ReferenceOutput
Options
RequiredDescriptionName
YesThe name of the subnet group to be modified.--cluster-subnet-group-name
YesAn array of VPC subnet IDs. A maximum of 20subnets can be modified in a single request.
--subnet-ids
NoA text description of the subnet group to bemodified.
--description
OutputThe command returns the following information:
• ClusterSubnetGroup— Describes a subnet group.
• ClusterSubnetGroup:ClusterSubnetGroupName— The name of the cluster subnet group.
• ClusterSubnetGroup:Description— The description of the cluster subnet group.
• ClusterSubnetGroup:VpcId— The VPC ID of the cluster subnet group.
• ClusterSubnetGroup:SubnetGroupStatus— The status of the cluster subnet group. Possible valuesare Complete, Incomplete and Invalid.
• ClusterSubnetGroup:Subnets— A list of the VPC Subnet elements.
• ClusterSubnetGroup:Subnets:Subnet— Describes a subnet.
• ClusterSubnetGroup:Subnets:Subnet:SubnetIdentifier— The identifier of the subnet.
• ClusterSubnetGroup:Subnets:Subnet:SubnetAvailabilityZone— Describes an availability zone.
• ClusterSubnetGroup:Subnets:Subnet:SubnetAvailabilityZone:Name— The name of the availabilityzone.
• ClusterSubnetGroup:Subnets:Subnet:SubnetStatus— The status of the subnet.
Examples
Modify the Subnets in a Cluster Subnet GroupThis example shows how to modify the list of subnets in a cache subnet group. By default, the output isin JSON format.
PROMPT> aws redshift modify-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup --subnet-ids subnet-763fdd1 subnet-ac830e9
{ "ClusterSubnetGroup": { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-763fdd1c", "SubnetAvailabilityZone": { "Name": "us-east-1a" },
API Version 2012-12-0187
Amazon Redshift Command Line ReferenceOptions
{ "SubnetStatus": "Active", "SubnetIdentifier": "subnet-ac830e9", "SubnetAvailabilityZone": { "Name": "us-east-1b" } } ], "VpcId": "vpc-7e3fdd14", "SubnetGroupStatus": "Complete", "Description": "My subnet group", "ClusterSubnetGroupName": "mysubnetgroup" }, "ResponseMetadata": { "RequestId": "8da93e89-8372-f936-93a8-873918938197a" }}
purchase-reserved-node-offering
DescriptionAllows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved nodeofferings.You can purchase one of the offerings.You can call the describe-reserved-node-offerings (p. 72)API to obtain the available reserved node offerings.You can call this API by providing a specific reservednode offering and the number of nodes you want to reserve.
For more information about managing parameter groups, go to Purchasing Reserved Nodes in the AmazonRedshift Management Guide.
Syntaxpurchase-reserved-node-offering
--reserved-node-offering-id value
[--node-count value]
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe unique identifier of the reserved node offeringyou want to purchase.
--reserved-node-offering-id
NoThe number of reserved nodes you want topurchase.
Default: 1
--node-count
API Version 2012-12-0188
Amazon Redshift Command Line Referencepurchase-reserved-node-offering
OutputThe command returns the following information:
• ReservedNode— Describes a reserved node.
• ReservedNode:ReservedNodeId— The unique identifier for the reservation.
• ReservedNode:ReservedNodeOfferingId— The identifier for the reserved node offering.
• ReservedNode:NodeType— The node type of the reserved node.
• ReservedNode:StartTime— The time the reservation started.You purchase a reserved node offeringfor a duration. This is the start time of that duration.
• ReservedNode:Duration— The duration of the node reservation in seconds.
• ReservedNode:FixedPrice— The fixed cost Amazon Redshift charged you for this reserved node.
• ReservedNode:UsagePrice— The hourly rate Amazon Redshift charge you for this reserved node.
• ReservedNode:CurrencyCode— The currency code for the reserved cluster.
• ReservedNode:NodeCount— The number of reserved compute nodes.
• ReservedNode:State— The state of the reserved Compute Node. Possible Values:
• pending-payment-This reserved node has recently been purchased, and the sale has been approved,but payment has not yet been confirmed.
• active-This reserved node is owned by the caller and is available for use.
• payment-failed-Payment failed for the purchase attempt.
• ReservedNode:OfferingType— The anticipated utilization of the reserved node, as defined in thereserved node offering.
• ReservedNode:RecurringCharges— The recurring charges for the reserved node.
• ReservedNode:RecurringCharges:RecurringCharge— Describes a recurring charge.
• ReservedNode:RecurringCharges:RecurringCharge:RecurringChargeAmount— The amountcharged per the period of time specified by the recurring charge frequency.
• ReservedNode:RecurringCharges:RecurringCharge:RecurringChargeFrequency— The frequencyat which the recurring charge amount is applied.
Examples
Purchase a Reserved NodeThis example shows how to purchase a reserved node offering. The reserved-node-offering-idis obtained by calling describe-reserved-node-offerings.
PROMPT> aws redshift purchase-reserved-node-offering --reserved-node-offering-id ceb6a579-cf4c-4343-be8b-d832c45ab51c
{ "ReservedNode": { "OfferingType": "Heavy Utilization", "FixedPrice": "", "NodeType": "dw.hs1.xlarge", "ReservedNodeId": "1ba8e2e3-bc01-4d65-b35d-a4a3e931547e", "UsagePrice": "", "RecurringCharges": [ { "RecurringChargeAmount": "", "RecurringChargeFrequency": "Hourly"
API Version 2012-12-0189
Amazon Redshift Command Line ReferenceOutput
} ], "NodeCount": 1, "State": "payment-pending", "StartTime": "2013-02-13T17:08:39.051Z", "Duration": 31536000, "ReservedNodeOfferingId": "ceb6a579-cf4c-4343-be8b-d832c45ab51c" }, "ResponseMetadata": { "RequestId": "01bda7bf-7600-11e2-b605-2568d7396e7f" }}
reboot-cluster
DescriptionReboots a cluster.This action is taken as soon as possible. It results in a momentary outage to the cluster,during which the cluster status is set to rebooting. A cluster event is created when the reboot iscompleted. Any pending cluster modifications (see modify-cluster (p. 78)) are applied at this reboot. Formore information about managing clusters, go to Amazon Redshift Clusters in the Amazon RedshiftManagement Guide
Syntaxreboot-cluster
--cluster-identifier value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe cluster identifier.--cluster-identifier
OutputThe command returns the following information:
• Cluster— Describes a cluster.
• Cluster:ClusterIdentifier— The unique identifier of the cluster.
• Cluster:NodeType— The node type for the nodes in the cluster.
• Cluster:ClusterStatus— The current state of this cluster. Possible values include available,creating, deleting, rebooting, and resizing.
• Cluster:ModifyStatus— The status of a modify operation, if any, initiated for the cluster.
• Cluster:MasterUsername— The master user name for the cluster. This name is used to connect tothe database that is specified in DBName.
API Version 2012-12-0190
Amazon Redshift Command Line Referencereboot-cluster
• Cluster:DBName— The name of the initial database that was created when the cluster was created.This same name is returned for the life of the cluster. If an initial database was not specified, a databasenamed "dev" was created by default.
• Cluster:Endpoint— The connection endpoint.
• Cluster:Endpoint:Address— The DNS address of the Cluster.
• Cluster:Endpoint:Port— The port that the database engine is listening on.
• Cluster:ClusterCreateTime— The date and time that the cluster was created.
• Cluster:AutomatedSnapshotRetentionPeriod— The number of days that automatic cluster snapshotsare retained.
• Cluster:ClusterSecurityGroups— A list of cluster security group that are associated with the cluster.Each security group is represented by an element that contains ClusterSecurityGroup.Name andClusterSecurityGroup.Status subelements. Cluster security groups are used when the clusteris not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listedby the VpcSecurityGroups parameter.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup— Describes a security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:ClusterSecurityGroupName— The nameof the cluster security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:Status— The status of the cluster securitygroup.
• Cluster:VpcSecurityGroups— A list of Virtual Private Cloud (VPC) security groups that are associatedwith the cluster. This parameter is returned only if the cluster is in a VPC.
• Cluster:VpcSecurityGroups:VpcSecurityGroup— Describes the members of a VPC security group.
• Cluster:VpcSecurityGroups:VpcSecurityGroup:VpcSecurityGroupId—
• Cluster:VpcSecurityGroups:VpcSecurityGroup:Status—
• Cluster:ClusterParameterGroups— The list of cluster parameter groups that are associated with thiscluster.
• Cluster:ClusterParameterGroups:ClusterParameterGroup— Describes the status of a parametergroup.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterGroupName— The nameof the cluster parameter group.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterApplyStatus— The statusof parameter updates.
• Cluster:ClusterSubnetGroupName— The name of the subnet group that is associated with the cluster.This parameter is valid only when the cluster is in a VPC.
• Cluster:VpcId— The identifier of the VPC the cluster is in, if the cluster is in a VPC.
• Cluster:AvailabilityZone— The name of the Availability Zone in which the cluster is located.
• Cluster:PreferredMaintenanceWindow— The weekly time range (in UTC) during which systemmaintenance can occur.
• Cluster:PendingModifiedValues— If present, changes to the cluster are pending. Specific pendingchanges are identified by subelements.
• Cluster:PendingModifiedValues:MasterUserPassword— The pending or in-progress change of themaster credentials for the cluster.
• Cluster:PendingModifiedValues:NodeType— The pending or in-progress change of the cluster'snode type.
• Cluster:PendingModifiedValues:NumberOfNodes— The pending or in-progress change of thenumber nodes in the cluster.
• Cluster:PendingModifiedValues:ClusterType— The pending or in-progress change of the clustertype.
• Cluster:PendingModifiedValues:ClusterVersion— The pending or in-progress change of the serviceversion.
API Version 2012-12-0191
Amazon Redshift Command Line ReferenceOutput
• Cluster:PendingModifiedValues:AutomatedSnapshotRetentionPeriod— The pending or in-progresschange of the automated snapshot retention period.
• Cluster:ClusterVersion— The version ID of the Amazon Redshift engine that is running on the cluster.
• Cluster:AllowVersionUpgrade— If true, version upgrades will be applied automatically to the clusterduring the maintenance window.
• Cluster:NumberOfNodes— The number of compute nodes in the cluster.
• Cluster:PubliclyAccessible— If true, the cluster can be accessed from a public network.
• Cluster:Encrypted— If true, data in cluster is encrypted at rest.
Examples
Reboot a ClusterThis example reboots a cluster. By default, the output is in JSON format.
PROMPT> aws redshift reboot-cluster --cluster-identifier mycluster
{ "Cluster": { "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": "sun:23:15-mon:03:15", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "rebooting", "ClusterIdentifier": "mycluster", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": {} }, "ResponseMetadata": {
API Version 2012-12-0192
Amazon Redshift Command Line ReferenceExamples
"RequestId": "61c8b564-64e8-11e2-8f7d-3b939af52818" }}
reset-cluster-parameter-group
DescriptionSets one or more parameters of the specified parameter group to their default values and sets the sourcevalues of the parameters to "engine-default". To reset the entire parameter group specify theResetAllParameters parameter. For parameter changes to take effect you must reboot any associatedclusters.
Syntaxreset-cluster-parameter-group
--parameter-group-name value
[--reset-all-parameters]
[--parameters value]
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name of the cluster parameter group to bereset.
--parameter-group-name
API Version 2012-12-0193
Amazon Redshift Command Line Referencereset-cluster-parameter-group
RequiredDescriptionName
NoAn array of names of parameters to be reset. IfResetAllParameters option is not used, then atleast one parameter name must be supplied.
Constraints: A maximum of 20 parameters can bereset in a single request.
Describes a parameter in a cluster parametergroup.
parameter_name (string)The name of the parameter.
parameter_value (string)The value of the parameter.
description (string)A description of the parameter.
source (string)The source of the parameter value, such as"engine-default" or "user".
data_type (string)The data type of the parameter.
allowed_values (string)The valid range of values for the parameter.
is_modifiable (boolean)If true, the parameter can be modified. Someparameters have security or operationalimplications that prevent them from beingchanged.
minimum_engine_version (string)The earliest engine version to which theparameter can apply.
--parameters
NoIf true, all parameters in the specified parametergroup will be reset to their default values.
Default: true
--reset-all-parameters
OutputThe command returns the following information:
• ParameterGroupName— The name of the cluster parameter group.
• ParameterGroupStatus— The status of the parameter group. For example, if you made a change toa parameter group name-value pair, then the change could be pending a reboot of an associatedcluster.
API Version 2012-12-0194
Amazon Redshift Command Line ReferenceOutput
Examples
Reset Parameters in a Parameter GroupThis example shows how to reset all of the parameters in a parameter group.
PROMPT> aws redshift reset-cluster-parameter-group --parameter-group-name myc lusterparametergroup --reset-all-parameters
restore-from-cluster-snapshot
DescriptionCreates a new cluster from a snapshot. Amazon Redshift creates the resulting cluster with the sameconfiguration as the original cluster from which the snapshot was created, except that the new cluster iscreated with the default cluster security and parameter group. After Amazon Redshift creates the clusteryou can use the modify-cluster (p. 78) API to associate a different security group and different parametergroup with the restored cluster.
If a snapshot is taken of a cluster in VPC, you can restore it only in VPC. In this case, you must providea cluster subnet group where you want the cluster restored. If snapshot is taken of a cluster outside VPC,then you can restore it only outside VPC.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the AmazonRedshift Management Guide.
Syntaxrestore-from-cluster-snapshot
--cluster-identifier value
--snapshot-identifier value
[--port value]
[--availability-zone value]
[--allow-version-upgrade]
[--cluster-subnet-group-name value]
[--publicly-accessible]
[--owner-account value]
Common Options (p. 9)
API Version 2012-12-0195
Amazon Redshift Command Line ReferenceExamples
Options
RequiredDescriptionName
YesThe identifier of the cluster that will be created fromrestoring the snapshot.
Constraints:
• Must contain from 1 to 63 alphanumericcharacters or hyphens.
• Alphabetic characters must be lowercase.
• First character must be a letter.
• Cannot end with a hyphen or contain twoconsecutive hyphens.
• Must be unique for all clusters within an AWSaccount.
--cluster-identifier
YesThe name of the snapshot from which to create thenew cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
--snapshot-identifier
NoIf true, upgrades can be applied during themaintenance window to the Amazon Redshiftengine that is running on the cluster.
Default: true
--allow-version-upgrade
NoThe Amazon EC2 Availability Zone in which torestore the cluster.
Default: A random, system-chosen AvailabilityZone.
Example: us-east-1a
--availability-zone
NoThe name of the subnet group where you want tocluster restored.
A snapshot of cluster in VPC can be restored onlyin VPC. Therefore, you must provide subnet groupname where you want the cluster restored.
--cluster-subnet-group-name
NoThe AWS customer account used to create or copythe snapshot. Required if you are restoring asnapshot you do not own, optional if you own thesnapshot.
--owner-account
NoThe port number on which the cluster acceptsconnections.
Default: The same port as the original cluster.
Constraints: Must be between 1115 and 65535.
--port
API Version 2012-12-0196
Amazon Redshift Command Line ReferenceOptions
RequiredDescriptionName
NoIf true, the cluster can be accessed from a publicnetwork.
--publicly-accessible
OutputThe command returns the following information:
• Cluster— Describes a cluster.
• Cluster:ClusterIdentifier— The unique identifier of the cluster.
• Cluster:NodeType— The node type for the nodes in the cluster.
• Cluster:ClusterStatus— The current state of this cluster. Possible values include available,creating, deleting, rebooting, and resizing.
• Cluster:ModifyStatus— The status of a modify operation, if any, initiated for the cluster.
• Cluster:MasterUsername— The master user name for the cluster. This name is used to connect tothe database that is specified in DBName.
• Cluster:DBName— The name of the initial database that was created when the cluster was created.This same name is returned for the life of the cluster. If an initial database was not specified, a databasenamed "dev" was created by default.
• Cluster:Endpoint— The connection endpoint.
• Cluster:Endpoint:Address— The DNS address of the Cluster.
• Cluster:Endpoint:Port— The port that the database engine is listening on.
• Cluster:ClusterCreateTime— The date and time that the cluster was created.
• Cluster:AutomatedSnapshotRetentionPeriod— The number of days that automatic cluster snapshotsare retained.
• Cluster:ClusterSecurityGroups— A list of cluster security group that are associated with the cluster.Each security group is represented by an element that contains ClusterSecurityGroup.Name andClusterSecurityGroup.Status subelements. Cluster security groups are used when the clusteris not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listedby the VpcSecurityGroups parameter.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup— Describes a security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:ClusterSecurityGroupName— The nameof the cluster security group.
• Cluster:ClusterSecurityGroups:ClusterSecurityGroup:Status— The status of the cluster securitygroup.
• Cluster:VpcSecurityGroups— A list of Virtual Private Cloud (VPC) security groups that are associatedwith the cluster. This parameter is returned only if the cluster is in a VPC.
• Cluster:VpcSecurityGroups:VpcSecurityGroup— Describes the members of a VPC security group.
• Cluster:VpcSecurityGroups:VpcSecurityGroup:VpcSecurityGroupId—
• Cluster:VpcSecurityGroups:VpcSecurityGroup:Status—
• Cluster:ClusterParameterGroups— The list of cluster parameter groups that are associated with thiscluster.
• Cluster:ClusterParameterGroups:ClusterParameterGroup— Describes the status of a parametergroup.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterGroupName— The nameof the cluster parameter group.
• Cluster:ClusterParameterGroups:ClusterParameterGroup:ParameterApplyStatus— The statusof parameter updates.
API Version 2012-12-0197
Amazon Redshift Command Line ReferenceOutput
• Cluster:ClusterSubnetGroupName— The name of the subnet group that is associated with the cluster.This parameter is valid only when the cluster is in a VPC.
• Cluster:VpcId— The identifier of the VPC the cluster is in, if the cluster is in a VPC.
• Cluster:AvailabilityZone— The name of the Availability Zone in which the cluster is located.
• Cluster:PreferredMaintenanceWindow— The weekly time range (in UTC) during which systemmaintenance can occur.
• Cluster:PendingModifiedValues— If present, changes to the cluster are pending. Specific pendingchanges are identified by subelements.
• Cluster:PendingModifiedValues:MasterUserPassword— The pending or in-progress change of themaster credentials for the cluster.
• Cluster:PendingModifiedValues:NodeType— The pending or in-progress change of the cluster'snode type.
• Cluster:PendingModifiedValues:NumberOfNodes— The pending or in-progress change of thenumber nodes in the cluster.
• Cluster:PendingModifiedValues:ClusterType— The pending or in-progress change of the clustertype.
• Cluster:PendingModifiedValues:ClusterVersion— The pending or in-progress change of the serviceversion.
• Cluster:PendingModifiedValues:AutomatedSnapshotRetentionPeriod— The pending or in-progresschange of the automated snapshot retention period.
• Cluster:ClusterVersion— The version ID of the Amazon Redshift engine that is running on the cluster.
• Cluster:AllowVersionUpgrade— If true, version upgrades will be applied automatically to the clusterduring the maintenance window.
• Cluster:NumberOfNodes— The number of compute nodes in the cluster.
• Cluster:PubliclyAccessible— If true, the cluster can be accessed from a public network.
• Cluster:Encrypted— If true, data in cluster is encrypted at rest.
Examples
Restore a Cluster From a SnapshotThis example restores a cluster from a snapshot.
PROMPT> aws redshift restore-from-cluster-snapshot --cluster-identifier myc luster-clone --snapshot-identifier my-snapshot-id
{ "Cluster": { "NodeType": "dw.hs1.xlarge", "ClusterVersion": "1.0", "PubliclyAccessible": "true", "MasterUsername": "adminuser", "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ {
API Version 2012-12-0198
Amazon Redshift Command Line ReferenceExamples
"Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": [], "PreferredMaintenanceWindow": "sun:23:15-mon:03:15", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "creating", "ClusterIdentifier": "mycluster-clone", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": {} }, "ResponseMetadata": { "RequestId": "77fd512b-64e3-11e2-8f5b-e90bd6c77476" }}
revoke-cluster-security-group-ingress
DescriptionRevokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range orAmazon EC2 security group.To add an ingress rule, see authorize-cluster-security-group-ingress (p. 15).For information about managing security groups, go to Amazon Redshift Cluster Security Groups in theAmazon Redshift Management Guide.
Syntaxrevoke-cluster-security-group-ingress
--cluster-security-group-name value
[--cidrip value]
[--ec2-security-group-name value]
[--ec2-security-group-owner-id value]
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe name of the security Group from which torevoke the ingress rule.
--cluster-security-group-name
API Version 2012-12-0199
Amazon Redshift Command Line Referencerevoke-cluster-security-group-ingress
RequiredDescriptionName
NoThe IP range for which to revoke access. Thisrange must be a valid Classless Inter-DomainRouting (CIDR) block of IP addresses. If CIDRIPis specified, EC2SecurityGroupName andEC2SecurityGroupOwnerId cannot be provided.
--cidrip
NoThe name of the EC2 Security Group whose accessis to be revoked. If EC2SecurityGroupName isspecified, EC2SecurityGroupOwnerId must alsobe provided and CIDRIP cannot be provided.
--ec2-security-group-name
NoThe AWS account number of the owner of thesecurity group specified in theEC2SecurityGroupName parameter. The AWSaccess key ID is not an acceptable value. IfEC2SecurityGroupOwnerId is specified,EC2SecurityGroupName must also be provided.and CIDRIP cannot be provided.
Example: 111122223333
--ec2-security-group-owner-id
OutputThe command returns the following information:
• ClusterSecurityGroup— Describes a security group.
• ClusterSecurityGroup:ClusterSecurityGroupName— The name of the cluster security group towhich the operation was applied.
• ClusterSecurityGroup:Description— A description of the security group.
• ClusterSecurityGroup:EC2SecurityGroups— A list of EC2 security groups that are permitted toaccess clusters associated with this cluster security group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup— Describes an Amazon EC2security group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:Status— The status of the EC2security group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:EC2SecurityGroupName— Thename of the EC2 Security Group.
• ClusterSecurityGroup:EC2SecurityGroups:EC2SecurityGroup:EC2SecurityGroupOwnerId—The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
• ClusterSecurityGroup:IPRanges— A list of IP ranges (CIDR blocks) that are permitted to accessclusters associated with this cluster security group.
• ClusterSecurityGroup:IPRanges:IPRange— Describes an IP range used in a security group.
• ClusterSecurityGroup:IPRanges:IPRange:Status— The status of the IP range, for example,"authorized".
• ClusterSecurityGroup:IPRanges:IPRange:CIDRIP— The IP range in Classless Inter-Domain Routing(CIDR) notation.
API Version 2012-12-01100
Amazon Redshift Command Line ReferenceOutput
Examples
Revoke Access from an EC2 Security GroupThis example revokes access to a named Amazon EC2 security group.
PROMPT> aws redshift revoke-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --ec2-security-group-name myec2securitygroup --ec2-security-group-owner-id 123445677890
Revoking Access to a CIDR rangeThis example revokes access to a CIDR range.
PROMPT> aws redshift revoke-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --cidrip 192.168.100.100/32
revoke-snapshot-access
DescriptionRemoves the ability of the specified AWS customer account to restore the specified snapshot. If theaccount is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the AmazonRedshift Management Guide.
Syntaxrevoke-snapshot-access
--snapshot-identifier value
--account-with-restore-access value
Common Options (p. 9)
Options
RequiredDescriptionName
YesThe identifier of the AWS customer account thatcan no longer restore the specified snapshot.
--account-with-restore-access
YesThe identifier of the snapshot that the account canno longer access.
--snapshot-identifier
API Version 2012-12-01101
Amazon Redshift Command Line ReferenceExamples
OutputThe command returns the following information:
• Snapshot— Describes a snapshot.
• Snapshot:SnapshotIdentifier— The snapshot identifier that is provided in the request.
• Snapshot:ClusterIdentifier— The identifier of the cluster for which the snapshot was taken.
• Snapshot:SnapshotCreateTime— The time (UTC) when Amazon Redshift began the snapshot. Asnapshot contains a copy of the cluster data as of this exact time.
• Snapshot:Status— The snapshot status. The value of the status depends on the API operation used.
• create-cluster-snapshot (p. 33) and copy-cluster-snapshot (p. 26) returns status as "creating".
• describe-cluster-snapshots (p. 56) returns status as "creating", "available", or "failed".
• delete-cluster-snapshot (p. 42) returns status as "deleted".
• Snapshot:Port— The port that the cluster is listening on.
• Snapshot:AvailabilityZone— The Availability Zone in which the cluster was created.
• Snapshot:ClusterCreateTime— The time (UTC) when the cluster was originally created.
• Snapshot:MasterUsername— The master user name for the cluster.
• Snapshot:ClusterVersion— The version ID of the Amazon Redshift engine that is running on thecluster.
• Snapshot:SnapshotType— The snapshot type. Snapshots created using create-cluster-snapshot (p.33)and copy-cluster-snapshot (p. 26) will be of type "manual".
• Snapshot:NodeType— The node type of the nodes in the cluster.
• Snapshot:NumberOfNodes— The number of nodes in the cluster.
• Snapshot:DBName— The name of the database that was created when the cluster was created.
• Snapshot:VpcId— The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,this field is not in the output.
• Snapshot:Encrypted— If true, the data in the snapshot is encrypted at rest.
• Snapshot:AccountsWithRestoreAccess— A list of the AWS customer accounts authorized to restorethe snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess— Describes an AWS customeraccount authorized to restore a snapshot.
• Snapshot:AccountsWithRestoreAccess:AccountWithRestoreAccess:AccountId— The identifierof an AWS customer account authorized to restore a snapshot.
• Snapshot:OwnerAccount— For manual snapshots, the AWS customer account used to create orcopy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform allsnapshot actions, such as sharing a manual snapshot.
• Snapshot:TotalBackupSizeInMegaBytes— The size of the complete set of backup data that wouldbe used to restore the instance.
• Snapshot:ActualIncrementalBackupSizeInMegaBytes— The size of the incremental backup.
• Snapshot:BackupProgressInMegaBytes— The number of megabytes that have been transferredto the snapshot backup.
• Snapshot:CurrentBackupRateInMegaBytesPerSecond— The number of megabytes per secondbeing transferred to the snapshot backup. Returns 0 for a completed backup.
• Snapshot:EstimatedSecondsToCompletion— The estimate of the time remaining before the snapshotbackup will complete. Returns 0 for a completed backup.
• Snapshot:ElapsedTimeInSeconds— The amount of time an in-progress snapshot backup has beenrunning, or the amount of time it took a completed backup to finish.
API Version 2012-12-01102
Amazon Redshift Command Line ReferenceOutput
Examples
Revoke the Authorization of an AWS Account to Restore aSnapshotThis example revokes the authorization of the AWS account 444455556666 to restore the snapshotmy-snapshot-id. By default, the output is in JSON format.
PROMPT> aws redshift revoke-snapshot-access --snapshot-id my-snapshot-id --ac count-with-restore-access 444455556666
{ "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" }}
API Version 2012-12-01103
Amazon Redshift Command Line ReferenceExamples
Document History
This documentation is associated with the 2012-12-01 version of Amazon Redshift. This guide was lastupdated on April 2, 2013.
The following table describes the important changes since the last release of the Amazon RedshiftCommand Line Reference.
Release DateDescriptionChange
14 February 2013This is the first release of Amazon Redshift Command LineReference.
New Guide
API Version 2012-12-01104
Amazon Redshift Command Line Reference
top related