Icon

AWS Redshift (version v1.*.*)

accept_reserved_node_exchange

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.

Parameters

$body

Type: object

{
"TargetReservedNodeOfferingId" : "The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings ",
"ReservedNodeId" : "A string representing the node identifier of the DC1 Reserved Node to be exchanged."
}

authorize_cluster_security_group_ingress

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"CIDRIP" : "The IP range to be added the Amazon Redshift security group.",
"EC2SecurityGroupName" : "The EC2 security group to be added the Amazon Redshift security group.",
"EC2SecurityGroupOwnerId" : "The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. \nExample: 111122223333 ",
"ClusterSecurityGroupName" : "The name of the security group to which the ingress rule is added."
}

authorize_snapshot_access

Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"AccountWithRestoreAccess" : "The identifier of the AWS customer account authorized to restore the specified snapshot. \nTo share a snapshot with AWS support, specify amazon-redshift-support.",
"SnapshotIdentifier" : "The identifier of the snapshot the account is authorized to restore.",
"SnapshotClusterIdentifier" : "The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name."
}

batch_delete_cluster_snapshots

Deletes a set of cluster snapshots.

Parameters

$body

Type: object

{
"Identifiers" : [ {
"DeleteClusterSnapshotMessage" : {
"SnapshotIdentifier" : "The unique identifier of the manual snapshot to be deleted. \nConstraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.",
"SnapshotClusterIdentifier" : "The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. \nConstraints: Must be the name of valid cluster."
}
} ]
}

batch_modify_cluster_snapshots

Modifies the settings for a list of snapshots.

Parameters

$body

Type: object

{
"Force" : "A boolean value indicating whether to override an exception if the retention period has passed. ",
"SnapshotIdentifierList" : [ {
"String" : "string"
} ],
"ManualSnapshotRetentionPeriod" : "The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely. \nThe number must be either -1 or an integer between 1 and 3,653. \nIf you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option. "
}

cancel_resize

Cancels a resize operation.

Parameters

$body

Type: object

{
"ClusterIdentifier" : "The unique identifier for the cluster that you want to cancel a resize operation for."
}

copy_cluster_snapshot

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"SourceSnapshotIdentifier" : "The identifier for the source snapshot. \nConstraints: \n Must be the identifier for a valid automated snapshot whose state is available. ",
"TargetSnapshotIdentifier" : "The identifier given to the new manual snapshot. \nConstraints: \n Cannot be null, empty, or blank. \n Must contain from 1 to 255 alphanumeric characters or hyphens. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. \n Must be unique for the AWS account that is making the request. ",
"SourceSnapshotClusterIdentifier" : "The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. \nConstraints: \n Must be the identifier for a valid cluster. ",
"ManualSnapshotRetentionPeriod" : "The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. \nThe value must be either -1 or an integer between 1 and 3,653. \nThe default value is -1."
}

create_cluster

Creates a new cluster.
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"HsmClientCertificateIdentifier" : "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.",
"ElasticIp" : "The Elastic IP (EIP) address for the cluster. \nConstraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.",
"AutomatedSnapshotRetentionPeriod" : "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. \nDefault: 1 \nConstraints: Must be a value from 0 to 35.",
"Encrypted" : "If true, the data in the cluster is encrypted at rest. \nDefault: false",
"Port" : "The port number on which the cluster accepts incoming connections. \nThe cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. \nDefault: 5439 \nValid Values: 1150-65535 ",
"NumberOfNodes" : "The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. \nFor information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. \nIf you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. \nDefault: 1 \nConstraints: Value must be at least 1 and no more than 100.",
"EnhancedVpcRouting" : "An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. \nIf this option is true, enhanced VPC routing is enabled. \nDefault: false",
"ClusterParameterGroupName" : "The name of the parameter group to be associated with this cluster. \nDefault: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups \nConstraints: \n Must be 1 to 255 alphanumeric characters or hyphens. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. ",
"AllowVersionUpgrade" : "If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. \nWhen a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. \nDefault: true ",
"VpcSecurityGroupIds" : [ {
"VpcSecurityGroupId" : "string"
} ],
"SnapshotScheduleIdentifier" : "A unique identifier for the snapshot schedule.",
"MaintenanceTrackName" : "An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.",
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ],
"AdditionalInfo" : "Reserved.",
"IamRoles" : [ {
"IamRoleArn" : "string"
} ],
"ClusterVersion" : "The version of the Amazon Redshift engine software that you want to deploy on the cluster. \nThe version selected runs on all the nodes in the cluster. \nConstraints: Only version 1.0 is currently available. \nExample: 1.0 ",
"HsmConfigurationIdentifier" : "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.",
"KmsKeyId" : "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.",
"AvailabilityZone" : "The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. \nDefault: A random, system-chosen Availability Zone in the region that is specified by the endpoint. \nExample: us-east-1d \nConstraint: The specified Availability Zone must be in the same region as the current endpoint.",
"PreferredMaintenanceWindow" : "The weekly time range (in UTC) during which automated cluster maintenance can occur. \n Format: ddd:hh24:mi-ddd:hh24:mi \n Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. \nValid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun \nConstraints: Minimum 30-minute window.",
"ClusterType" : "The type of the cluster. When cluster type is specified as \n single-node, the NumberOfNodes parameter is not required. \n multi-node, the NumberOfNodes parameter is required. \nValid Values: multi-node | single-node \nDefault: multi-node ",
"ClusterSecurityGroups" : [ {
"ClusterSecurityGroupName" : "string"
} ],
"ClusterIdentifier" : "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. \nConstraints: \n Must contain from 1 to 63 alphanumeric characters or hyphens. \n Alphabetic characters must be lowercase. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. \n Must be unique for all clusters within an AWS account. \nExample: myexamplecluster ",
"MasterUserPassword" : "The password associated with the master user account for the cluster that is being created. \nConstraints: \n Must be between 8 and 64 characters in length. \n Must contain at least one uppercase letter. \n Must contain at least one lowercase letter. \n Must contain one number. \n Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space. ",
"ClusterSubnetGroupName" : "The name of a cluster subnet group to be associated with this cluster. \nIf this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).",
"NodeType" : "The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. \nValid Values: ds2.xlarge | ds2.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge ",
"MasterUsername" : "The user name associated with the master user account for the cluster that is being created. \nConstraints: \n Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC. \n First character must be a letter. \n Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. ",
"DBName" : "The name of the first database to be created when the cluster is created. \nTo create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. \nDefault: dev \nConstraints: \n Must contain 1 to 64 alphanumeric characters. \n Must contain only lowercase letters. \n Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. ",
"PubliclyAccessible" : "If true, the cluster can be accessed from a public network. ",
"ManualSnapshotRetentionPeriod" : "The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. \nThe value must be either -1 or an integer between 1 and 3,653."
}

create_cluster_parameter_group

Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"Description" : "A description of the parameter group.",
"ParameterGroupName" : "The name of the cluster parameter group. \nConstraints: \n Must be 1 to 255 alphanumeric characters or hyphens \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. \n Must be unique withing your AWS account. \nThis value is stored as a lower-case string.",
"ParameterGroupFamily" : "The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. \nTo get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is \"redshift-1.0\". ",
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

create_cluster_security_group

Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"Description" : "A description for the security group.",
"ClusterSecurityGroupName" : "The name for the security group. Amazon Redshift stores the value as a lowercase string. \nConstraints: \n Must contain no more than 255 alphanumeric characters or hyphens. \n Must not be \"Default\". \n Must be unique for all security groups that are created by your AWS account. \nExample: examplesecuritygroup ",
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

create_cluster_snapshot

Creates a manual snapshot of the specified cluster. The cluster must be in the available state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"SnapshotIdentifier" : "A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account. \nConstraints: \n Cannot be null, empty, or blank \n Must contain from 1 to 255 alphanumeric characters or hyphens \n First character must be a letter \n Cannot end with a hyphen or contain two consecutive hyphens \nExample: my-snapshot-id ",
"ClusterIdentifier" : "The cluster identifier for which you want a snapshot.",
"ManualSnapshotRetentionPeriod" : "The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. \nThe value must be either -1 or an integer between 1 and 3,653. \nThe default value is -1.",
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

create_cluster_subnet_group

Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"Description" : "A description for the subnet group.",
"ClusterSubnetGroupName" : "The name for the subnet group. Amazon Redshift stores the value as a lowercase string. \nConstraints: \n Must contain no more than 255 alphanumeric characters or hyphens. \n Must not be \"Default\". \n Must be unique for all subnet groups that are created by your AWS account. \nExample: examplesubnetgroup ",
"SubnetIds" : [ {
"SubnetIdentifier" : "string"
} ],
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

create_event_subscription

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.

Parameters

$body

Type: object

{
"SourceType" : "The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. \nValid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.",
"EventCategories" : [ {
"EventCategory" : "string"
} ],
"Enabled" : "A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. ",
"Severity" : "Specifies the Amazon Redshift event severity to be published by the event notification subscription. \nValues: ERROR, INFO",
"SubscriptionName" : "The name of the event subscription to be created. \nConstraints: \n Cannot be null, empty, or blank. \n Must contain from 1 to 255 alphanumeric characters or hyphens. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. ",
"SnsTopicArn" : "The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.",
"SourceIds" : [ {
"SourceId" : "string"
} ],
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

create_hsm_client_certificate

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"HsmClientCertificateIdentifier" : "The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.",
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

create_hsm_configuration

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"Description" : "A text description of the HSM configuration to be created.",
"HsmConfigurationIdentifier" : "The identifier to be assigned to the new Amazon Redshift HSM configuration.",
"HsmIpAddress" : "The IP address that the Amazon Redshift cluster must use to access the HSM.",
"HsmPartitionName" : "The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.",
"HsmServerPublicCertificate" : "The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.",
"HsmPartitionPassword" : "The password required to access the HSM partition.",
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

create_snapshot_copy_grant

Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Parameters

$body

The result of the CreateSnapshotCopyGrant action.

Type: object

{
"KmsKeyId" : "The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.",
"SnapshotCopyGrantName" : "The name of the snapshot copy grant. This name must be unique in the region for the AWS account. \nConstraints: \n Must contain from 1 to 63 alphanumeric characters or hyphens. \n Alphabetic characters must be lowercase. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. \n Must be unique for all clusters within an AWS account. ",
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

create_snapshot_schedule

Creates a new snapshot schedule.

Parameters

$body

Type: object

{
"ScheduleDescription" : "The description of the snapshot schedule.",
"ScheduleDefinitions" : [ {
"ScheduleDefinition" : "string"
} ],
"DryRun" : "boolean",
"ScheduleIdentifier" : "A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.",
"NextInvocations" : "integer",
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

create_tags

Adds one or more tags to a specified resource.
A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.

Parameters

$body

Contains the output from the CreateTags action.

Type: object

{
"ResourceName" : "The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1. ",
"Tags" : [ {
"Tag" : {
"Value" : "The value for the resource tag.",
"Key" : "The key, or name, for the resource tag."
}
} ]
}

delete_cluster

Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"FinalClusterSnapshotIdentifier" : "The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false. \nConstraints: \n Must be 1 to 255 alphanumeric characters. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. ",
"SkipFinalClusterSnapshot" : "Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. \nThe FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false. \nDefault: false ",
"FinalClusterSnapshotRetentionPeriod" : "The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. \nThe value must be either -1 or an integer between 1 and 3,653. \nThe default value is -1.",
"ClusterIdentifier" : "The identifier of the cluster to be deleted. \nConstraints: \n Must contain lowercase characters. \n Must contain from 1 to 63 alphanumeric characters or hyphens. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. "
}

delete_cluster_parameter_group

Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.

Parameters

$body

Type: object

{
"ParameterGroupName" : "The name of the parameter group to be deleted. \nConstraints: \n Must be the name of an existing cluster parameter group. \n Cannot delete a default cluster parameter group. "
}

delete_cluster_security_group

Deletes an Amazon Redshift security group.
You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"ClusterSecurityGroupName" : "The name of the cluster security group to be deleted."
}

delete_cluster_snapshot

Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.

Parameters

$body

Type: object

{
"SnapshotIdentifier" : "The unique identifier of the manual snapshot to be deleted. \nConstraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.",
"SnapshotClusterIdentifier" : "The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. \nConstraints: Must be the name of valid cluster."
}

delete_cluster_subnet_group

Deletes the specified cluster subnet group.

Parameters

$body

Type: object

{
"ClusterSubnetGroupName" : "The name of the cluster subnet group name to be deleted."
}

delete_event_subscription

Deletes an Amazon Redshift event notification subscription.

Parameters

$body

Type: object

{
"SubscriptionName" : "The name of the Amazon Redshift event notification subscription to be deleted."
}

delete_hsm_client_certificate

Deletes the specified HSM client certificate.

Parameters

$body

Type: object

{
"HsmClientCertificateIdentifier" : "The identifier of the HSM client certificate to be deleted."
}

delete_hsm_configuration

Deletes the specified Amazon Redshift HSM configuration.

Parameters

$body

Type: object

{
"HsmConfigurationIdentifier" : "The identifier of the Amazon Redshift HSM configuration to be deleted."
}

delete_snapshot_copy_grant

Deletes the specified snapshot copy grant.

Parameters

$body

The result of the DeleteSnapshotCopyGrant action.

Type: object

{
"SnapshotCopyGrantName" : "The name of the snapshot copy grant to delete."
}

delete_snapshot_schedule

Deletes a snapshot schedule.

Parameters

$body

Type: object

{
"ScheduleIdentifier" : "A unique identifier of the snapshot schedule to delete."
}

delete_tags

Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.

Parameters

$body

Contains the output from the DeleteTags action.

Type: object

{
"ResourceName" : "The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1. ",
"TagKeys" : [ {
"TagKey" : "string"
} ]
}

describe_account_attributes

Returns a list of attributes attached to an account

Parameters

$body

Type: object

{
"AttributeNames" : [ {
"AttributeName" : "string"
} ]
}

describe_cluster_db_revisions

Returns an array of ClusterDbRevision objects.

Parameters

$body

Type: object

{
"ClusterIdentifier" : "A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default."
}

describe_cluster_parameter_groups

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

Parameters

$body

Type: object

{
"ParameterGroupName" : "The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_cluster_parameters

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"ParameterGroupName" : "The name of a cluster parameter group for which to return details.",
"Source" : "The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group. \nDefault: All parameter types returned. \nValid Values: user | engine-default "
}

describe_cluster_security_groups

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.

Parameters

$body

Type: object

{
"ClusterSecurityGroupName" : "The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both. \n Example: securitygroup1 ",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_cluster_snapshots

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.

Parameters

$body

Type: object

{
"EndTime" : "A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. \nExample: 2012-07-16T18:00:00Z ",
"SnapshotIdentifier" : "The snapshot identifier of the snapshot about which to return information.",
"StartTime" : "A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. \nExample: 2012-07-16T18:00:00Z ",
"SnapshotType" : "The type of snapshots for which you are requesting information. By default, snapshots of all types are returned. \nValid Values: automated | manual ",
"OwnerAccount" : "The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.",
"ClusterIdentifier" : "The identifier of the cluster which generated the requested snapshots.",
"ClusterExists" : "A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows: \n If ClusterExists is set to true, ClusterIdentifier is required. \n If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned. \n If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned. \n If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned. ",
"SortingEntities" : [ {
"SnapshotSortingEntity" : {
"Attribute" : "The category for sorting the snapshots.",
"SortOrder" : "The order for listing the attributes."
}
} ],
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_cluster_subnet_groups

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.

Parameters

$body

Type: object

{
"ClusterSubnetGroupName" : "The name of the cluster subnet group for which information is requested.",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_cluster_tracks

Returns a list of all the available maintenance tracks.

Parameters

$body

Type: object

{
"MaintenanceTrackName" : "The name of the maintenance track. "
}

describe_cluster_versions

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"ClusterVersion" : "The specific cluster version to return. \nExample: 1.0 ",
"ClusterParameterGroupFamily" : "The name of a specific cluster parameter group family to return details for. \nConstraints: \n Must be 1 to 255 alphanumeric characters \n First character must be a letter \n Cannot end with a hyphen or contain two consecutive hyphens "
}

describe_clusters

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.

Parameters

$body

Type: object

{
"ClusterIdentifier" : "The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. \nThe default is that all clusters defined for an account are returned.",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_default_cluster_parameters

Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"ParameterGroupFamily" : "The name of the cluster parameter group family."
}

describe_event_categories

Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.

Parameters

$body

Type: object

{
"SourceType" : "The source type, such as cluster or parameter group, to which the described event categories apply. \nValid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group."
}

describe_event_subscriptions

Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.

Parameters

$body

Type: object

{
"SubscriptionName" : "The name of the Amazon Redshift event notification subscription to be described.",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_events

Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Parameters

$body

Type: object

{
"EndTime" : "The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. \nExample: 2009-07-08T18:00Z ",
"SourceType" : "The event source to retrieve events for. If no value is specified, all events are returned. \nConstraints: \nIf SourceType is supplied, SourceIdentifier must also be provided. \n Specify cluster when SourceIdentifier is a cluster identifier. \n Specify cluster-security-group when SourceIdentifier is a cluster security group name. \n Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name. \n Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier. ",
"SourceIdentifier" : "The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response. \nConstraints: \nIf SourceIdentifier is supplied, SourceType must also be provided. \n Specify a cluster identifier when SourceType is cluster. \n Specify a cluster security group name when SourceType is cluster-security-group. \n Specify a cluster parameter group name when SourceType is cluster-parameter-group. \n Specify a cluster snapshot identifier when SourceType is cluster-snapshot. ",
"StartTime" : "The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. \nExample: 2009-07-08T18:00Z ",
"Duration" : "The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. \nDefault: 60 "
}

describe_hsm_client_certificates

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.

Parameters

$body

Type: object

{
"HsmClientCertificateIdentifier" : "The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_hsm_configurations

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.

Parameters

$body

Type: object

{
"HsmConfigurationIdentifier" : "The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_logging_status

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

Parameters

$body

Type: object

{
"ClusterIdentifier" : "The identifier of the cluster from which to get the logging status. \nExample: examplecluster "
}

describe_node_configuration_options

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

Parameters

$body

Type: object

{
"ActionType" : "The action type to evaluate for possible node configurations. Currently, it must be \"restore-cluster\".",
"Filter" : [ {
"NodeConfigurationOptionsFilter" : {
"Operator" : "The filter operator. If filter Name is NodeType only the 'in' operator is supported. Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. Provide two values to evaluate for 'between'. Provide a list of values for 'in'.",
"Value" : [ {
"item" : "string"
} ],
"Name" : "The name of the element to filter."
}
} ],
"SnapshotIdentifier" : "The identifier of the snapshot to evaluate for possible node configurations.",
"OwnerAccount" : "The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot."
}

describe_orderable_cluster_options

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"ClusterVersion" : "The version filter value. Specify this parameter to show only the available offerings matching the specified version. \nDefault: All versions. \nConstraints: Must be one of the version returned from DescribeClusterVersions.",
"NodeType" : "The node type filter value. Specify this parameter to show only the available offerings matching the specified node type."
}

describe_reserved_node_offerings

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"ReservedNodeOfferingId" : "The unique identifier for the offering."
}

describe_reserved_nodes

Returns the descriptions of the reserved nodes.

Parameters

$body

Type: object

{
"ReservedNodeId" : "Identifier for the node reservation."
}

describe_resize

Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.

Parameters

$body

Type: object

{
"ClusterIdentifier" : "The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. \nBy default, resize operations for all clusters defined for an AWS account are returned."
}

describe_snapshot_copy_grants

Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Parameters

$body

The result of the DescribeSnapshotCopyGrants action.

Type: object

{
"SnapshotCopyGrantName" : "The name of the snapshot copy grant.",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_snapshot_schedules

Returns a list of snapshot schedules.

Parameters

$body

Type: object

{
"ScheduleIdentifier" : "A unique identifier for a snapshot schedule.",
"ClusterIdentifier" : "The unique identifier for the cluster whose snapshot schedules you want to view.",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

describe_storage

Returns the total amount of snapshot usage and provisioned storage in megabytes.

This operation has no parameters

describe_table_restore_status

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.

Parameters

$body

Type: object

{
"TableRestoreRequestId" : "The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.",
"ClusterIdentifier" : "The Amazon Redshift cluster that the table is being restored to."
}

describe_tags

Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

Parameters

$body

Type: object

{
"ResourceName" : "The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1. ",
"ResourceType" : "The type of resource with which you want to view tags. Valid resource types are: \n Cluster \n CIDR/IP \n EC2 security group \n Snapshot \n Cluster security group \n Subnet group \n HSM connection \n HSM certificate \n Parameter group \n Snapshot copy grant \nFor more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide. ",
"TagKeys" : [ {
"TagKey" : "string"
} ],
"TagValues" : [ {
"TagValue" : "string"
} ]
}

disable_logging

Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Parameters

$body

Type: object

{
"ClusterIdentifier" : "The identifier of the cluster on which logging is to be stopped. \nExample: examplecluster "
}

disable_snapshot_copy

Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.

Parameters

$body

Type: object

{
"ClusterIdentifier" : "The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region. \nConstraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled."
}

enable_logging

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Parameters

$body

Type: object

{
"BucketName" : "The name of an existing S3 bucket where the log files are to be stored. \nConstraints: \n Must be in the same region as the cluster \n The cluster must have read bucket and put object permissions ",
"S3KeyPrefix" : "The prefix applied to the log file names. \nConstraints: \n Cannot exceed 512 characters \n Cannot contain spaces( ), double quotes (\"), single quotes ('), a backslash (\\), or control characters. The hexadecimal codes for invalid characters are: x00 to x20 x22 x27 x5c x7f or larger ",
"ClusterIdentifier" : "The identifier of the cluster on which logging is to be started. \nExample: examplecluster "
}

enable_snapshot_copy

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

Parameters

$body

Type: object

{
"SnapshotCopyGrantName" : "The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.",
"DestinationRegion" : "The destination AWS Region that you want to copy snapshots to. \nConstraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference. ",
"ClusterIdentifier" : "The unique identifier of the source cluster to copy snapshots from. \nConstraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.",
"RetentionPeriod" : "The number of days to retain automated snapshots in the destination region after they are copied from the source region. \nDefault: 7. \nConstraints: Must be at least 1 and no more than 35.",
"ManualSnapshotRetentionPeriod" : "The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely. \nThe value must be either -1 or an integer between 1 and 3,653."
}

get_cluster_credentials

Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups.
In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege.
If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

Parameters

$body

The request parameters to get cluster credentials.

Type: object

{
"DbGroups" : [ {
"DbGroup" : "string"
} ],
"AutoCreate" : "Create a database user with the name specified for the user named in DbUser if one does not exist.",
"DbName" : "The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database. \nConstraints: \n Must be 1 to 64 alphanumeric characters or hyphens \n Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. \n First character must be a letter. \n Must not contain a colon ( : ) or slash ( / ). \n Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. ",
"DurationSeconds" : "The number of seconds until the returned temporary password expires. \nConstraint: minimum 900, maximum 3600. \nDefault: 900",
"ClusterIdentifier" : "The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.",
"DbUser" : "The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database. \nFor more information, see CREATE USER in the Amazon Redshift Database Developer Guide. \nConstraints: \n Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be PUBLIC. \n Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. \n First character must be a letter. \n Must not contain a colon ( : ) or slash ( / ). \n Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. "
}

get_reserved_node_exchange_offerings

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.

Parameters

$body

Type: object

{
"ReservedNodeId" : "A string representing the node identifier for the DC1 Reserved Node to be exchanged."
}

modify_cluster

Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.

Parameters

$body

Type: object

{
"HsmClientCertificateIdentifier" : "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.",
"ElasticIp" : "The Elastic IP (EIP) address for the cluster. \nConstraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.",
"AutomatedSnapshotRetentionPeriod" : "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. \nIf you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted. \nDefault: Uses existing setting. \nConstraints: Must be a value from 0 to 35.",
"ClusterVersion" : "The new version number of the Amazon Redshift engine to upgrade to. \nFor major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. \nExample: 1.0 ",
"HsmConfigurationIdentifier" : "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.",
"NewClusterIdentifier" : "The new identifier for the cluster. \nConstraints: \n Must contain from 1 to 63 alphanumeric characters or hyphens. \n Alphabetic characters must be lowercase. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. \n Must be unique for all clusters within an AWS account. \nExample: examplecluster ",
"KmsKeyId" : "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.",
"Encrypted" : "Indicates whether the cluster is encrypted. If the cluster is encrypted and you provide a value for the KmsKeyId parameter, we will encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we will encrypt with the default key. In the China region we will use legacy encryption if you specify that the cluster is encrypted.",
"NumberOfNodes" : "The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter. \nWhen you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request. \nValid Values: Integer greater than 0.",
"PreferredMaintenanceWindow" : "The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage. \nThis maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied. \nDefault: Uses existing setting. \nFormat: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00. \nValid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun \nConstraints: Must be at least 30 minutes.",
"EnhancedVpcRouting" : "An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. \nIf this option is true, enhanced VPC routing is enabled. \nDefault: false",
"ClusterType" : "The new cluster type. \nWhen you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request. \nValid Values: multi-node | single-node ",
"ClusterSecurityGroups" : [ {
"ClusterSecurityGroupName" : "string"
} ],
"ClusterIdentifier" : "The unique identifier of the cluster to be modified. \nExample: examplecluster ",
"ClusterParameterGroupName" : "The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster. \nDefault: Uses existing setting. \nConstraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.",
"MasterUserPassword" : "The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. \nOperations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost. \nDefault: Uses existing setting. \nConstraints: \n Must be between 8 and 64 characters in length. \n Must contain at least one uppercase letter. \n Must contain at least one lowercase letter. \n Must contain one number. \n Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space. ",
"AllowVersionUpgrade" : "If true, major version upgrades will be applied automatically to the cluster during the maintenance window. \nDefault: false ",
"VpcSecurityGroupIds" : [ {
"VpcSecurityGroupId" : "string"
} ],
"NodeType" : "The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. \nWhen you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request. \nValid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge ",
"MaintenanceTrackName" : "The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.",
"PubliclyAccessible" : "If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.",
"ManualSnapshotRetentionPeriod" : "The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots. \nThe value must be either -1 or an integer between 1 and 3,653. \nThe default value is -1."
}

modify_cluster_db_revision

Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.

Parameters

$body

Type: object

{
"RevisionTarget" : "The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.",
"ClusterIdentifier" : "The unique identifier of a cluster whose database revision you want to modify. \nExample: examplecluster "
}

modify_cluster_iam_roles

Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
A cluster can have up to 10 IAM roles associated at any time.

Parameters

$body

Type: object

{
"RemoveIamRoles" : [ {
"IamRoleArn" : "string"
} ],
"ClusterIdentifier" : "The unique identifier of the cluster for which you want to associate or disassociate IAM roles.",
"AddIamRoles" : [ {
"IamRoleArn" : "string"
} ]
}

modify_cluster_maintenance

Modifies the maintenance settings of a cluster. For example, you can defer a maintenance window. You can also update or cancel a deferment.

Parameters

$body

Type: object

{
"DeferMaintenance" : "A boolean indicating whether to enable the deferred maintenance window. ",
"DeferMaintenanceDuration" : "An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.",
"DeferMaintenanceStartTime" : "A timestamp indicating the start time for the deferred maintenance window.",
"ClusterIdentifier" : "A unique identifier for the cluster.",
"DeferMaintenanceIdentifier" : "A unique identifier for the deferred maintenance window.",
"DeferMaintenanceEndTime" : "A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration."
}

modify_cluster_parameter_group

Modifies the parameters of a parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"Parameters" : [ {
"Parameter" : {
"IsModifiable" : "If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. ",
"ApplyType" : "Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.",
"Description" : "A description of the parameter.",
"AllowedValues" : "The valid range of values for the parameter.",
"ParameterValue" : "The value of the parameter.",
"DataType" : "The data type of the parameter.",
"MinimumEngineVersion" : "The earliest engine version to which the parameter can apply.",
"ParameterName" : "The name of the parameter.",
"Source" : "The source of the parameter value, such as \"engine-default\" or \"user\"."
}
} ],
"ParameterGroupName" : "The name of the parameter group to be modified."
}

modify_cluster_snapshot

Modifies the settings for a snapshot.

Parameters

$body

Type: object

{
"Force" : "A Boolean option to override an exception if the retention period has already passed.",
"SnapshotIdentifier" : "The identifier of the snapshot whose setting you want to modify.",
"ManualSnapshotRetentionPeriod" : "The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. \nIf the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot. \nThe value must be either -1 or an integer between 1 and 3,653."
}

modify_cluster_snapshot_schedule

Modifies a snapshot schedule for a cluster.

Parameters

$body

Type: object

{
"DisassociateSchedule" : "A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.",
"ScheduleIdentifier" : "A unique alphanumeric identifier for the schedule that you want to associate with the cluster.",
"ClusterIdentifier" : "A unique identifier for the cluster whose snapshot schedule you want to modify. "
}

modify_cluster_subnet_group

Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.

Parameters

$body

Type: object

{
"Description" : "A text description of the subnet group to be modified.",
"ClusterSubnetGroupName" : "The name of the subnet group to be modified.",
"SubnetIds" : [ {
"SubnetIdentifier" : "string"
} ]
}

modify_event_subscription

Modifies an existing Amazon Redshift event notification subscription.

Parameters

$body

Type: object

{
"SourceType" : "The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. \nValid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.",
"EventCategories" : [ {
"EventCategory" : "string"
} ],
"Enabled" : "A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled ",
"Severity" : "Specifies the Amazon Redshift event severity to be published by the event notification subscription. \nValues: ERROR, INFO",
"SubscriptionName" : "The name of the modified Amazon Redshift event notification subscription.",
"SnsTopicArn" : "The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.",
"SourceIds" : [ {
"SourceId" : "string"
} ]
}

modify_snapshot_copy_retention_period

Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

Parameters

$body

Type: object

{
"Manual" : "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.",
"ClusterIdentifier" : "The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region. \nConstraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.",
"RetentionPeriod" : "The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region. \nBy default, this only changes the retention period of copied automated snapshots. \nIf you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period. \nConstraints: Must be at least 1 and no more than 35 for automated snapshots. \nIf you specify the manual option, only newly copied manual snapshots will have the new retention period. \nIf you specify the value of -1 newly copied manual snapshots are retained indefinitely. \nConstraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots."
}

modify_snapshot_schedule

Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.

Parameters

$body

Type: object

{
"ScheduleDefinitions" : [ {
"ScheduleDefinition" : "string"
} ],
"ScheduleIdentifier" : "A unique alphanumeric identifier of the schedule to modify."
}

purchase_reserved_node_offering

Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"NodeCount" : "The number of reserved nodes that you want to purchase. \nDefault: 1 ",
"ReservedNodeOfferingId" : "The unique identifier of the reserved node offering you want to purchase."
}

reboot_cluster

Reboots 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 is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"ClusterIdentifier" : "The cluster identifier."
}

reset_cluster_parameter_group

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

Parameters

$body

Type: object

{
"Parameters" : [ {
"Parameter" : {
"IsModifiable" : "If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. ",
"ApplyType" : "Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.",
"Description" : "A description of the parameter.",
"AllowedValues" : "The valid range of values for the parameter.",
"ParameterValue" : "The value of the parameter.",
"DataType" : "The data type of the parameter.",
"MinimumEngineVersion" : "The earliest engine version to which the parameter can apply.",
"ParameterName" : "The name of the parameter.",
"Source" : "The source of the parameter value, such as \"engine-default\" or \"user\"."
}
} ],
"ParameterGroupName" : "The name of the cluster parameter group to be reset.",
"ResetAllParameters" : "If true, all parameters in the specified parameter group will be reset to their default values. \nDefault: true "
}

resize_cluster

Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.
Elastic resize operations have the following restrictions:
You can only resize clusters of the following types: dc2.large dc2.8xlarge ds2.xlarge ds2.8xlarge
The type of nodes that you add must match the node type for the cluster.

Parameters

$body

Type: object

{
"NodeType" : "The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.",
"NumberOfNodes" : "The new number of nodes for the cluster.",
"ClusterType" : "The new cluster type for the specified cluster.",
"Classic" : "A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic. ",
"ClusterIdentifier" : "The unique identifier for the cluster to resize."
}

restore_from_cluster_snapshot

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.
If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"HsmClientCertificateIdentifier" : "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.",
"ElasticIp" : "The elastic IP (EIP) address for the cluster.",
"AutomatedSnapshotRetentionPeriod" : "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. \nDefault: The value selected for the cluster from which the snapshot was taken. \nConstraints: Must be a value from 0 to 35.",
"SnapshotIdentifier" : "The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. \nExample: my-snapshot-id ",
"Port" : "The port number on which the cluster accepts connections. \nDefault: The same port as the original cluster. \nConstraints: Must be between 1115 and 65535.",
"NumberOfNodes" : "The number of nodes specified when provisioning the restored cluster.",
"EnhancedVpcRouting" : "An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. \nIf this option is true, enhanced VPC routing is enabled. \nDefault: false",
"ClusterParameterGroupName" : "The name of the parameter group to be associated with this cluster. \nDefault: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups. \nConstraints: \n Must be 1 to 255 alphanumeric characters or hyphens. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. ",
"AllowVersionUpgrade" : "If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. \nDefault: true ",
"VpcSecurityGroupIds" : [ {
"VpcSecurityGroupId" : "string"
} ],
"SnapshotScheduleIdentifier" : "A unique identifier for the snapshot schedule.",
"MaintenanceTrackName" : "The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.",
"OwnerAccount" : "The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.",
"SnapshotClusterIdentifier" : "The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.",
"AdditionalInfo" : "Reserved.",
"IamRoles" : [ {
"IamRoleArn" : "string"
} ],
"HsmConfigurationIdentifier" : "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.",
"KmsKeyId" : "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.",
"AvailabilityZone" : "The Amazon EC2 Availability Zone in which to restore the cluster. \nDefault: A random, system-chosen Availability Zone. \nExample: us-east-1a ",
"PreferredMaintenanceWindow" : "The weekly time range (in UTC) during which automated cluster maintenance can occur. \n Format: ddd:hh24:mi-ddd:hh24:mi \n Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. \nValid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun \nConstraints: Minimum 30-minute window.",
"ClusterSecurityGroups" : [ {
"ClusterSecurityGroupName" : "string"
} ],
"ClusterIdentifier" : "The identifier of the cluster that will be created from restoring the snapshot. \nConstraints: \n Must contain from 1 to 63 alphanumeric characters or hyphens. \n Alphabetic characters must be lowercase. \n First character must be a letter. \n Cannot end with a hyphen or contain two consecutive hyphens. \n Must be unique for all clusters within an AWS account. ",
"ClusterSubnetGroupName" : "The name of the subnet group where you want to cluster restored. \nA snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.",
"NodeType" : "The node type that the restored cluster will be provisioned with. \nDefault: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlareg cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide. ",
"PubliclyAccessible" : "If true, the cluster can be accessed from a public network. ",
"ManualSnapshotRetentionPeriod" : "The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. \nThe value must be either -1 or an integer between 1 and 3,653."
}

restore_table_from_cluster_snapshot

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.
You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.

Parameters

$body

Type: object

{
"SourceTableName" : "The name of the source table to restore from.",
"TargetDatabaseName" : "The name of the database to restore the table to.",
"SourceSchemaName" : "The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.",
"SnapshotIdentifier" : "The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.",
"SourceDatabaseName" : "The name of the source database that contains the table to restore from.",
"TargetSchemaName" : "The name of the schema to restore the table to.",
"ClusterIdentifier" : "The identifier of the Amazon Redshift cluster to restore the table to.",
"NewTableName" : "The name of the table to create as a result of the current request."
}

revoke_cluster_security_group_ingress

Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"CIDRIP" : "The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided. ",
"EC2SecurityGroupName" : "The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided. ",
"EC2SecurityGroupOwnerId" : "The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided. \nExample: 111122223333 ",
"ClusterSecurityGroupName" : "The name of the security Group from which to revoke the ingress rule."
}

revoke_snapshot_access

Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account 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 Amazon Redshift Cluster Management Guide.

Parameters

$body

Type: object

{
"AccountWithRestoreAccess" : "The identifier of the AWS customer account that can no longer restore the specified snapshot.",
"SnapshotIdentifier" : "The identifier of the snapshot that the account can no longer access.",
"SnapshotClusterIdentifier" : "The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name."
}

rotate_encryption_key

Rotates the encryption keys for a cluster.

Parameters

$body

Type: object

{
"ClusterIdentifier" : "The unique identifier of the cluster that you want to rotate the encryption keys for. \nConstraints: Must be the name of valid cluster that has encryption enabled."
}