2014/10/16 - Amazon Redshift - 53 new api methods
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 Management Guide .
Request Syntax
client.copy_cluster_snapshot(
SourceSnapshotIdentifier='string',
SourceSnapshotClusterIdentifier='string',
TargetSnapshotIdentifier='string'
)
string
[REQUIRED]
The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available .
string
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.
Constraints:
Must be the identifier for a valid cluster.
string
[REQUIRED]
The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string'
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true , the data in the snapshot is encrypted at rest.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
Request Syntax
client.describe_logging_status(
ClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster to get the logging status from.
Example: examplecluster
dict
Response Syntax
{
'LoggingEnabled': True|False,
'BucketName': 'string',
'S3KeyPrefix': 'string',
'LastSuccessfulDeliveryTime': datetime(2015, 1, 1),
'LastFailureTime': datetime(2015, 1, 1),
'LastFailureMessage': 'string'
}
Response Structure
(dict) --
Describes the status of logging for a cluster.
LoggingEnabled (boolean) --
true if logging is on, false if logging is off.
BucketName (string) --
The name of the S3 bucket where the log files are stored.
S3KeyPrefix (string) --
The prefix applied to the log file names.
LastSuccessfulDeliveryTime (datetime) --
The last time when logs were delivered.
LastFailureTime (datetime) --
The last time when logs failed to be delivered.
LastFailureMessage (string) --
The message indicating that logs failed to be delivered.
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.
Request Syntax
client.modify_cluster_subnet_group(
ClusterSubnetGroupName='string',
Description='string',
SubnetIds=[
'string',
]
)
string
[REQUIRED]
The name of the subnet group to be modified.
string
A text description of the subnet group to be modified.
list
[REQUIRED]
An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
(string) --
dict
Response Syntax
{
'ClusterSubnetGroup': {
'ClusterSubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
}
}
Response Structure
(dict) --
Describes a subnet group.
ClusterSubnetGroup (dict) --
Describes a subnet group.
ClusterSubnetGroupName (string) --
The name of the cluster subnet group.
Description (string) --
The description of the cluster subnet group.
VpcId (string) --
The VPC ID of the cluster subnet group.
SubnetGroupStatus (string) --
The status of the cluster subnet group. Possible values are Complete , Incomplete and Invalid .
Subnets (list) --
A list of the VPC Subnet elements.
(dict) --
Describes a subnet.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Describes an availability zone.
Name (string) --
The name of the availability zone.
SubnetStatus (string) --
The status of the subnet.
Modifies the parameters of a parameter group.
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide .
Request Syntax
client.modify_cluster_parameter_group(
ParameterGroupName='string',
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
]
)
string
[REQUIRED]
The name of the parameter group to be modified.
list
[REQUIRED]
An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
(dict) --
Describes a parameter in a cluster parameter group.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value, such as "engine-default" or "user".
DataType (string) --
The data type of the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
IsModifiable (boolean) --
If true , the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
dict
Response Syntax
{
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string'
}
Response Structure
(dict) --
Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterGroupStatus (string) --
The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
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.
Request Syntax
client.describe_resize(
ClusterIdentifier='string'
)
string
[REQUIRED]
The unique identifier of a cluster whose resize progress you are requesting. This parameter isn't case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.
dict
Response Syntax
{
'TargetNodeType': 'string',
'TargetNumberOfNodes': 123,
'TargetClusterType': 'string',
'Status': 'string',
'ImportTablesCompleted': [
'string',
],
'ImportTablesInProgress': [
'string',
],
'ImportTablesNotStarted': [
'string',
],
'AvgResizeRateInMegaBytesPerSecond': 123.0,
'TotalResizeDataInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
}
Response Structure
(dict) --
Describes the result of a cluster resize operation.
TargetNodeType (string) --
The node type that the cluster will have after the resize operation is complete.
TargetNumberOfNodes (integer) --
The number of nodes that the cluster will have after the resize operation is complete.
TargetClusterType (string) --
The cluster type after the resize operation is complete.
Valid Values: multi-node | single-node
Status (string) --
The status of the resize operation.
Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED
ImportTablesCompleted (list) --
The names of tables that have been completely imported .
Valid Values: List of table names.
(string) --
ImportTablesInProgress (list) --
The names of tables that are being currently imported.
Valid Values: List of table names.
(string) --
ImportTablesNotStarted (list) --
The names of tables that have not been yet imported.
Valid Values: List of table names
(string) --
AvgResizeRateInMegaBytesPerSecond (float) --
The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.
TotalResizeDataInMegaBytes (integer) --
The estimated total amount of data, in megabytes, on the cluster before the resize operation began.
ProgressInMegaBytes (integer) --
While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).
ElapsedTimeInSeconds (integer) --
The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.
EstimatedTimeToCompletionInSeconds (integer) --
The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.
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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide .
Request Syntax
client.create_cluster_parameter_group(
ParameterGroupName='string',
ParameterGroupFamily='string',
Description='string'
)
string
[REQUIRED]
The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
Note
This value is stored as a lower-case string.
string
[REQUIRED]
The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To 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".
string
[REQUIRED]
A description of the parameter group.
dict
Response Syntax
{
'ClusterParameterGroup': {
'ParameterGroupName': 'string',
'ParameterGroupFamily': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
Describes a parameter group.
ClusterParameterGroup (dict) --
Describes a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterGroupFamily (string) --
The name of the cluster parameter group family that this cluster parameter group is compatible with.
Description (string) --
The description of the parameter 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 Management Guide .
Request Syntax
client.create_cluster_security_group(
ClusterSecurityGroupName='string',
Description='string'
)
string
[REQUIRED]
The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup
string
[REQUIRED]
A description for the security group.
dict
Response Syntax
{
'ClusterSecurityGroup': {
'ClusterSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'IPRanges': [
{
'Status': 'string',
'CIDRIP': 'string'
},
]
}
}
Response Structure
(dict) --
Describes a security group.
ClusterSecurityGroup (dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group to which the operation was applied.
Description (string) --
A description of the security group.
EC2SecurityGroups (list) --
A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
(dict) --
Describes an Amazon EC2 security group.
Status (string) --
The status of the EC2 security group.
EC2SecurityGroupName (string) --
The name of the EC2 Security Group.
EC2SecurityGroupOwnerId (string) --
The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
IPRanges (list) --
A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
(dict) --
Describes an IP range used in a security group.
Status (string) --
The status of the IP range, for example, "authorized".
CIDRIP (string) --
The IP range in Classless Inter-Domain Routing (CIDR) notation.
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.
Request Syntax
client.describe_cluster_snapshots(
ClusterIdentifier='string',
SnapshotIdentifier='string',
SnapshotType='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxRecords=123,
Marker='string',
OwnerAccount='string'
)
string
The identifier of the cluster for which information about snapshots is requested.
string
The snapshot identifier of the snapshot about which to return information.
string
The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.
Valid Values: automated | manual
datetime
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.
Example: 2012-07-16T18:00:00Z
datetime
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.
Example: 2012-07-16T18:00:00Z
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
string
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.
dict
Response Syntax
{
'Marker': 'string',
'Snapshots': [
{
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string'
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeClusterSnapshots action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Snapshots (list) --
A list of Snapshot instances.
(dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true , the data in the snapshot is encrypted at rest.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Deletes a specified Amazon Redshift parameter group.
Note
You cannot delete a parameter group if it is associated with a cluster.
Request Syntax
client.delete_cluster_parameter_group(
ParameterGroupName='string'
)
string
[REQUIRED]
The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group.
None
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 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. If you specify the same number of nodes and node type that are already configured for the cluster, an error is returned.
Request Syntax
client.modify_cluster(
ClusterIdentifier='string',
ClusterType='string',
NodeType='string',
NumberOfNodes=123,
ClusterSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
MasterUserPassword='string',
ClusterParameterGroupName='string',
AutomatedSnapshotRetentionPeriod=123,
PreferredMaintenanceWindow='string',
ClusterVersion='string',
AllowVersionUpgrade=True|False,
HsmClientCertificateIdentifier='string',
HsmConfigurationIdentifier='string',
NewClusterIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the cluster to be modified.
Example: examplecluster
string
The new cluster type.
When 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.
Valid Values: multi-node | single-node
string
The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter also.
When 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 the DescribeResize to track the progress of the resize request.
Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge .
integer
The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter also.
When 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.
Valid Values: Integer greater than 0 .
list
A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.
Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
(string) --
list
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
(string) --
string
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.
Note
Operations 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.
Default: Uses existing setting.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), , /, @, or space.
string
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.
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
integer
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.
If 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.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
string
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.
This 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.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00 .
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
string
The new version number of the Amazon Redshift engine to upgrade to.
For 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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide .
Example: 1.0
boolean
If true , upgrades will be applied automatically to the cluster during the maintenance window.
Default: false
string
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
string
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.
string
The new identifier for the cluster.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: examplecluster
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one 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 managing parameter groups, go to Purchasing Reserved Nodes in the Amazon Redshift Management Guide .
Request Syntax
client.purchase_reserved_node_offering(
ReservedNodeOfferingId='string',
NodeCount=123
)
string
[REQUIRED]
The unique identifier of the reserved node offering you want to purchase.
integer
The number of reserved nodes you want to purchase.
Default: 1
dict
Response Syntax
{
'ReservedNode': {
'ReservedNodeId': 'string',
'ReservedNodeOfferingId': 'string',
'NodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'NodeCount': 123,
'State': 'string',
'OfferingType': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
}
}
Response Structure
(dict) --
Describes a reserved node.
ReservedNode (dict) --
Describes a reserved node.
ReservedNodeId (string) --
The unique identifier for the reservation.
ReservedNodeOfferingId (string) --
The identifier for the reserved node offering.
NodeType (string) --
The node type of the reserved node.
StartTime (datetime) --
The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.
Duration (integer) --
The duration of the node reservation in seconds.
FixedPrice (float) --
The fixed cost Amazon Redshift charged you for this reserved node.
UsagePrice (float) --
The hourly rate Amazon Redshift charge you for this reserved node.
CurrencyCode (string) --
The currency code for the reserved cluster.
NodeCount (integer) --
The number of reserved compute nodes.
State (string) --
The state of the reserved Compute Node.
Possible Values:
pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.
active-This reserved node is owned by the caller and is available for use.
payment-failed-Payment failed for the purchase attempt.
OfferingType (string) --
The anticipated utilization of the reserved node, as defined in the reserved node offering.
RecurringCharges (list) --
The recurring charges for the reserved node.
(dict) --
Describes a recurring charge.
RecurringChargeAmount (float) --
The amount charged per the period of time specified by the recurring charge frequency.
RecurringChargeFrequency (string) --
The frequency at which the recurring charge amount is applied.
Creates a new cluster from a snapshot. 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 group. 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 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 Management Guide .
Request Syntax
client.restore_from_cluster_snapshot(
ClusterIdentifier='string',
SnapshotIdentifier='string',
SnapshotClusterIdentifier='string',
Port=123,
AvailabilityZone='string',
AllowVersionUpgrade=True|False,
ClusterSubnetGroupName='string',
PubliclyAccessible=True|False,
OwnerAccount='string',
HsmClientCertificateIdentifier='string',
HsmConfigurationIdentifier='string',
ElasticIp='string',
ClusterParameterGroupName='string',
ClusterSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
AutomatedSnapshotRetentionPeriod=123
)
string
[REQUIRED]
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
string
[REQUIRED]
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
string
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.
integer
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between 1115 and 65535 .
string
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
boolean
If true , upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
Default: true
string
The name of the subnet group where you want to cluster restored.
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
boolean
If true , the cluster can be accessed from a public network.
string
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.
string
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
string
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.
string
The elastic IP (EIP) address for the cluster.
string
The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
list
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
(string) --
list
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
(string) --
string
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. The following list shows the time blocks for each region from which the default maintenance windows are assigned.
US-East (Northern Virginia) Region: 03:00-11:00 UTC
US-West (Oregon) Region 06:00-14:00 UTC
EU (Ireland) Region 22:00-06:00 UTC
Asia Pacific (Singapore) Region 14:00-22:00 UTC
Asia Pacific (Sydney) Region 12:00-20:00 UTC
Asia Pacific (Tokyo) Region 17:00-03:00 UTC
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
integer
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.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Deletes the specified HSM client certificate.
Request Syntax
client.delete_hsm_client_certificate(
HsmClientCertificateIdentifier='string'
)
string
[REQUIRED]
The identifier of the HSM client certificate to be deleted.
None
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.
Request Syntax
client.describe_hsm_configurations(
HsmConfigurationIdentifier='string',
MaxRecords=123,
Marker='string'
)
string
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.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Marker': 'string',
'HsmConfigurations': [
{
'HsmConfigurationIdentifier': 'string',
'Description': 'string',
'HsmIpAddress': 'string',
'HsmPartitionName': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
HsmConfigurations (list) --
A list of Amazon Redshift HSM configurations.
(dict) --
Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.
HsmConfigurationIdentifier (string) --
The name of the Amazon Redshift HSM configuration.
Description (string) --
A text description of the HSM configuration.
HsmIpAddress (string) --
The IP address that the Amazon Redshift cluster must use to access the HSM.
HsmPartitionName (string) --
The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
Request Syntax
client.enable_snapshot_copy(
ClusterIdentifier='string',
DestinationRegion='string',
RetentionPeriod=123
)
string
[REQUIRED]
The unique identifier of the source cluster to copy snapshots from.
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
string
[REQUIRED]
The destination region that you want to copy snapshots to.
Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
integer
The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Deletes an Amazon Redshift security group.
Note
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 Management Guide .
Request Syntax
client.delete_cluster_security_group(
ClusterSecurityGroupName='string'
)
string
[REQUIRED]
The name of the cluster security group to be deleted.
None
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 Management Guide .
Request Syntax
client.describe_cluster_security_groups(
ClusterSecurityGroupName='string',
MaxRecords=123,
Marker='string'
)
string
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.
Example: securitygroup1
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
dict
Response Syntax
{
'Marker': 'string',
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'IPRanges': [
{
'Status': 'string',
'CIDRIP': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeClusterSecurityGroups action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
ClusterSecurityGroups (list) --
A list of ClusterSecurityGroup instances.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group to which the operation was applied.
Description (string) --
A description of the security group.
EC2SecurityGroups (list) --
A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
(dict) --
Describes an Amazon EC2 security group.
Status (string) --
The status of the EC2 security group.
EC2SecurityGroupName (string) --
The name of the EC2 Security Group.
EC2SecurityGroupOwnerId (string) --
The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
IPRanges (list) --
A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
(dict) --
Describes an IP range used in a security group.
Status (string) --
The status of the IP range, for example, "authorized".
CIDRIP (string) --
The IP range in Classless Inter-Domain Routing (CIDR) notation.
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.
Request Syntax
client.reset_cluster_parameter_group(
ParameterGroupName='string',
ResetAllParameters=True|False,
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
]
)
string
[REQUIRED]
The name of the cluster parameter group to be reset.
boolean
If true , all parameters in the specified parameter group will be reset to their default values.
Default: true
list
An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.
Constraints: A maximum of 20 parameters can be reset in a single request.
(dict) --
Describes a parameter in a cluster parameter group.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value, such as "engine-default" or "user".
DataType (string) --
The data type of the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
IsModifiable (boolean) --
If true , the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
dict
Response Syntax
{
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string'
}
Response Structure
(dict) --
Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterGroupStatus (string) --
The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
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 Management Guide .
Request Syntax
client.revoke_snapshot_access(
SnapshotIdentifier='string',
SnapshotClusterIdentifier='string',
AccountWithRestoreAccess='string'
)
string
[REQUIRED]
The identifier of the snapshot that the account can no longer access.
string
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.
string
[REQUIRED]
The identifier of the AWS customer account that can no longer restore the specified snapshot.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string'
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true , the data in the snapshot is encrypted at rest.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
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 Management Guide
Request Syntax
client.describe_orderable_cluster_options(
ClusterVersion='string',
NodeType='string',
MaxRecords=123,
Marker='string'
)
string
The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
string
The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'OrderableClusterOptions': [
{
'ClusterVersion': 'string',
'ClusterType': 'string',
'NodeType': 'string',
'AvailabilityZones': [
{
'Name': 'string'
},
]
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Contains the output from the DescribeOrderableClusterOptions action.
OrderableClusterOptions (list) --
An OrderableClusterOption structure containing information about orderable options for the Cluster.
(dict) --
Describes an orderable cluster option.
ClusterVersion (string) --
The version of the orderable cluster.
ClusterType (string) --
The cluster type, for example multi-node .
NodeType (string) --
The node type for the orderable cluster.
AvailabilityZones (list) --
A list of availability zones for the orderable cluster.
(dict) --
Describes an availability zone.
Name (string) --
The name of the availability zone.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
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 Management Guide.
Request Syntax
client.create_hsm_client_certificate(
HsmClientCertificateIdentifier='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'HsmClientCertificate': {
'HsmClientCertificateIdentifier': 'string',
'HsmClientCertificatePublicKey': 'string'
}
}
Response Structure
(dict) --
Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
HsmClientCertificate (dict) --
Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
HsmClientCertificateIdentifier (string) --
The identifier of the HSM client certificate.
HsmClientCertificatePublicKey (string) --
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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 Management Guide
Request Syntax
client.reboot_cluster(
ClusterIdentifier='string'
)
string
[REQUIRED]
The cluster identifier.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
Request Syntax
client.disable_logging(
ClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
dict
Response Syntax
{
'LoggingEnabled': True|False,
'BucketName': 'string',
'S3KeyPrefix': 'string',
'LastSuccessfulDeliveryTime': datetime(2015, 1, 1),
'LastFailureTime': datetime(2015, 1, 1),
'LastFailureMessage': 'string'
}
Response Structure
(dict) --
Describes the status of logging for a cluster.
LoggingEnabled (boolean) --
true if logging is on, false if logging is off.
BucketName (string) --
The name of the S3 bucket where the log files are stored.
S3KeyPrefix (string) --
The prefix applied to the log file names.
LastSuccessfulDeliveryTime (datetime) --
The last time when logs were delivered.
LastFailureTime (datetime) --
The last time when logs failed to be delivered.
LastFailureMessage (string) --
The message indicating that logs failed to be delivered.
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 managing parameter groups, go to Purchasing Reserved Nodes in the Amazon Redshift Management Guide .
Request Syntax
client.describe_reserved_node_offerings(
ReservedNodeOfferingId='string',
MaxRecords=123,
Marker='string'
)
string
The unique identifier for the offering.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Marker': 'string',
'ReservedNodeOfferings': [
{
'ReservedNodeOfferingId': 'string',
'NodeType': 'string',
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'OfferingType': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeReservedNodeOfferings action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
ReservedNodeOfferings (list) --
A list of reserved node offerings.
(dict) --
Describes a reserved node offering.
ReservedNodeOfferingId (string) --
The offering identifier.
NodeType (string) --
The node type offered by the reserved node offering.
Duration (integer) --
The duration, in seconds, for which the offering will reserve the node.
FixedPrice (float) --
The upfront fixed charge you will pay to purchase the specific reserved node offering.
UsagePrice (float) --
The rate you are charged for each hour the cluster that is using the offering is running.
CurrencyCode (string) --
The currency code for the compute nodes offering.
OfferingType (string) --
The anticipated utilization of the reserved node, as defined in the reserved node offering.
RecurringCharges (list) --
The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.
(dict) --
Describes a recurring charge.
RecurringChargeAmount (float) --
The amount charged per the period of time specified by the recurring charge frequency.
RecurringChargeFrequency (string) --
The frequency at which the recurring charge amount is applied.
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 Management Guide .
Request Syntax
client.create_cluster_subnet_group(
ClusterSubnetGroupName='string',
Description='string',
SubnetIds=[
'string',
]
)
string
[REQUIRED]
The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup
string
[REQUIRED]
A description for the subnet group.
list
[REQUIRED]
An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
(string) --
dict
Response Syntax
{
'ClusterSubnetGroup': {
'ClusterSubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
}
}
Response Structure
(dict) --
Describes a subnet group.
ClusterSubnetGroup (dict) --
Describes a subnet group.
ClusterSubnetGroupName (string) --
The name of the cluster subnet group.
Description (string) --
The description of the cluster subnet group.
VpcId (string) --
The VPC ID of the cluster subnet group.
SubnetGroupStatus (string) --
The status of the cluster subnet group. Possible values are Complete , Incomplete and Invalid .
Subnets (list) --
A list of the VPC Subnet elements.
(dict) --
Describes a subnet.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Describes an availability zone.
Name (string) --
The name of the availability zone.
SubnetStatus (string) --
The status of the subnet.
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 Management Guide .
Request Syntax
client.create_cluster_snapshot(
SnapshotIdentifier='string',
ClusterIdentifier='string'
)
string
[REQUIRED]
A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
string
[REQUIRED]
The cluster identifier for which you want a snapshot.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string'
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true , the data in the snapshot is encrypted at rest.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide .
Request Syntax
client.create_cluster(
DBName='string',
ClusterIdentifier='string',
ClusterType='string',
NodeType='string',
MasterUsername='string',
MasterUserPassword='string',
ClusterSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
ClusterSubnetGroupName='string',
AvailabilityZone='string',
PreferredMaintenanceWindow='string',
ClusterParameterGroupName='string',
AutomatedSnapshotRetentionPeriod=123,
Port=123,
ClusterVersion='string',
AllowVersionUpgrade=True|False,
NumberOfNodes=123,
PubliclyAccessible=True|False,
Encrypted=True|False,
HsmClientCertificateIdentifier='string',
HsmConfigurationIdentifier='string',
ElasticIp='string'
)
string
The name of the first database to be created when the cluster is created.
To 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.
Default: dev
Constraints:
Must contain 1 to 64 alphanumeric characters.
Must contain only lowercase letters.
Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
string
[REQUIRED]
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.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster
string
The type of the cluster. When cluster type is specified as
single-node , the NumberOfNodes parameter is not required.
multi-node , the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
string
[REQUIRED]
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Management Guide .
Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge .
string
[REQUIRED]
The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
string
[REQUIRED]
The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), , /, @, or space.
list
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
(string) --
list
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
(string) --
string
The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
string
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.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-1d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
string
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
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. The following list shows the time blocks for each region from which the default maintenance windows are assigned.
US-East (Northern Virginia) Region: 03:00-11:00 UTC
US-West (Oregon) Region 06:00-14:00 UTC
EU (Ireland) Region 22:00-06:00 UTC
Asia Pacific (Singapore) Region 14:00-22:00 UTC
Asia Pacific (Sydney) Region 12:00-20:00 UTC
Asia Pacific (Tokyo) Region 17:00-03:00 UTC
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
string
The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
integer
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.
Default: 1
Constraints: Must be a value from 0 to 35.
integer
The port number on which the cluster accepts incoming connections.
The 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.
Default: 5439
Valid Values: 1150-65535
string
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
boolean
If true , upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new 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.
Default: true
integer
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node .
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Management Guide .
If 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.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
boolean
If true , the cluster can be accessed from a public network.
boolean
If true , the data in the cluster is encrypted at rest.
Default: false
string
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
string
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.
string
The Elastic IP (EIP) address for the cluster.
Constraints: 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 Management Guide.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide .
Request Syntax
client.describe_cluster_parameters(
ParameterGroupName='string',
Source='string',
MaxRecords=123,
Marker='string'
)
string
[REQUIRED]
The name of a cluster parameter group for which to return details.
string
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.
Default: All parameter types returned.
Valid Values: user | engine-default
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Contains the output from the DescribeClusterParameters action.
Parameters (list) --
A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
(dict) --
Describes a parameter in a cluster parameter group.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value, such as "engine-default" or "user".
DataType (string) --
The data type of the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
IsModifiable (boolean) --
If true , the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
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.
Request Syntax
client.describe_hsm_client_certificates(
HsmClientCertificateIdentifier='string',
MaxRecords=123,
Marker='string'
)
string
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.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Marker': 'string',
'HsmClientCertificates': [
{
'HsmClientCertificateIdentifier': 'string',
'HsmClientCertificatePublicKey': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
HsmClientCertificates (list) --
A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.
(dict) --
Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
HsmClientCertificateIdentifier (string) --
The identifier of the HSM client certificate.
HsmClientCertificatePublicKey (string) --
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
Deletes the specified Amazon Redshift HSM configuration.
Request Syntax
client.delete_hsm_configuration(
HsmConfigurationIdentifier='string'
)
string
[REQUIRED]
The identifier of the Amazon Redshift HSM configuration to be deleted.
None
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 Management Guide .
Request Syntax
client.authorize_snapshot_access(
SnapshotIdentifier='string',
SnapshotClusterIdentifier='string',
AccountWithRestoreAccess='string'
)
string
[REQUIRED]
The identifier of the snapshot the account is authorized to restore.
string
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.
string
[REQUIRED]
The identifier of the AWS customer account authorized to restore the specified snapshot.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string'
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true , the data in the snapshot is encrypted at rest.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Rotates the encryption keys for a cluster.
Request Syntax
client.rotate_encryption_key(
ClusterIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
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.
Request Syntax
client.describe_events(
SourceIdentifier='string',
SourceType='cluster'|'cluster-parameter-group'|'cluster-security-group'|'cluster-snapshot',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
MaxRecords=123,
Marker='string'
)
string
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.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster .
Specify a cluster security group name when SourceType is cluster-security-group .
Specify a cluster parameter group name when SourceType is cluster-parameter-group .
Specify a cluster snapshot identifier when SourceType is cluster-snapshot .
string
The event source to retrieve events for. If no value is specified, all events are returned.
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
Specify cluster when SourceIdentifier is a cluster identifier.
Specify cluster-security-group when SourceIdentifier is a cluster security group name.
Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.
Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.
datetime
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.
Example: 2009-07-08T18:00Z
datetime
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.
Example: 2009-07-08T18:00Z
integer
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.
Default: 60
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Marker': 'string',
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'cluster'|'cluster-parameter-group'|'cluster-security-group'|'cluster-snapshot',
'Message': 'string',
'EventCategories': [
'string',
],
'Severity': 'string',
'Date': datetime(2015, 1, 1),
'EventId': 'string'
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeEvents action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Events (list) --
A list of Event instances.
(dict) --
Describes an event.
SourceIdentifier (string) --
The identifier for the source of the event.
SourceType (string) --
The source type for this event.
Message (string) --
The text of this event.
EventCategories (list) --
A list of the event categories.
(string) --
Severity (string) --
The severity of the event.
Values: ERROR, INFO
Date (datetime) --
The date and time of the event.
EventId (string) --
The identifier of the event.
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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide .
Request Syntax
client.describe_cluster_parameter_groups(
ParameterGroupName='string',
MaxRecords=123,
Marker='string'
)
string
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.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Marker': 'string',
'ParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterGroupFamily': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeClusterParameterGroups action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
ParameterGroups (list) --
A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.
(dict) --
Describes a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterGroupFamily (string) --
The name of the cluster parameter group family that this cluster parameter group is compatible with.
Description (string) --
The description of the parameter group.
Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription.
Request Syntax
client.describe_event_subscriptions(
SubscriptionName='string',
MaxRecords=123,
Marker='string'
)
string
The name of the Amazon Redshift event notification subscription to be described.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Marker': 'string',
'EventSubscriptionsList': [
{
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': datetime(2015, 1, 1),
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Severity': 'string',
'Enabled': True|False
},
]
}
Response Structure
(dict) --
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
EventSubscriptionsList (list) --
A list of event subscriptions.
(dict) --
CustomerAwsId (string) --
The AWS customer account associated with the Amazon Redshift event notification subscription.
CustSubscriptionId (string) --
The name of the Amazon Redshift event notification subscription.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
Status (string) --
The status of the Amazon Redshift event notification subscription.
Constraints:
Can be one of the following: active | no-permission | topic-not-exist
The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (datetime) --
The date and time the Amazon Redshift event notification subscription was created.
SourceType (string) --
The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.
SourceIdsList (list) --
A list of the sources that publish events to the Amazon Redshift event notification subscription.
(string) --
EventCategoriesList (list) --
The list of Amazon Redshift event categories specified in the event notification subscription.
Values: Configuration, Management, Monitoring, Security
(string) --
Severity (string) --
The event severity specified in the Amazon Redshift event notification subscription.
Values: ERROR, INFO
Enabled (boolean) --
A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.
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 Management Guide.
Request Syntax
client.create_hsm_configuration(
HsmConfigurationIdentifier='string',
Description='string',
HsmIpAddress='string',
HsmPartitionName='string',
HsmPartitionPassword='string',
HsmServerPublicCertificate='string'
)
string
[REQUIRED]
The identifier to be assigned to the new Amazon Redshift HSM configuration.
string
[REQUIRED]
A text description of the HSM configuration to be created.
string
[REQUIRED]
The IP address that the Amazon Redshift cluster must use to access the HSM.
string
[REQUIRED]
The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
string
[REQUIRED]
The password required to access the HSM partition.
string
[REQUIRED]
The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.
dict
Response Syntax
{
'HsmConfiguration': {
'HsmConfigurationIdentifier': 'string',
'Description': 'string',
'HsmIpAddress': 'string',
'HsmPartitionName': 'string'
}
}
Response Structure
(dict) --
Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.
HsmConfiguration (dict) --
Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.
HsmConfigurationIdentifier (string) --
The name of the Amazon Redshift HSM configuration.
Description (string) --
A text description of the HSM configuration.
HsmIpAddress (string) --
The IP address that the Amazon Redshift cluster must use to access the HSM.
HsmPartitionName (string) --
The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. If a final cluster snapshot is requested the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. 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 Management Guide .
Request Syntax
client.delete_cluster(
ClusterIdentifier='string',
SkipFinalClusterSnapshot=True|False,
FinalClusterSnapshotIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
boolean
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.
Note
The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false .
Default: false
string
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 .
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
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 Management Guide
Request Syntax
client.describe_cluster_versions(
ClusterVersion='string',
ClusterParameterGroupFamily='string',
MaxRecords=123,
Marker='string'
)
string
The specific cluster version to return.
Example: 1.0
string
The name of a specific cluster parameter group family to return details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Marker': 'string',
'ClusterVersions': [
{
'ClusterVersion': 'string',
'ClusterParameterGroupFamily': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeClusterVersions action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
ClusterVersions (list) --
A list of Version elements.
(dict) --
Describes a cluster version, including the parameter group family and description of the version.
ClusterVersion (string) --
The version number used by the cluster.
ClusterParameterGroupFamily (string) --
The name of the cluster parameter group family for the cluster.
Description (string) --
The description of the cluster version.
Returns the descriptions of the reserved nodes.
Request Syntax
client.describe_reserved_nodes(
ReservedNodeId='string',
MaxRecords=123,
Marker='string'
)
string
Identifier for the node reservation.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Marker': 'string',
'ReservedNodes': [
{
'ReservedNodeId': 'string',
'ReservedNodeOfferingId': 'string',
'NodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'NodeCount': 123,
'State': 'string',
'OfferingType': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeReservedNodes action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
ReservedNodes (list) --
The list of reserved nodes.
(dict) --
Describes a reserved node.
ReservedNodeId (string) --
The unique identifier for the reservation.
ReservedNodeOfferingId (string) --
The identifier for the reserved node offering.
NodeType (string) --
The node type of the reserved node.
StartTime (datetime) --
The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.
Duration (integer) --
The duration of the node reservation in seconds.
FixedPrice (float) --
The fixed cost Amazon Redshift charged you for this reserved node.
UsagePrice (float) --
The hourly rate Amazon Redshift charge you for this reserved node.
CurrencyCode (string) --
The currency code for the reserved cluster.
NodeCount (integer) --
The number of reserved compute nodes.
State (string) --
The state of the reserved Compute Node.
Possible Values:
pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.
active-This reserved node is owned by the caller and is available for use.
payment-failed-Payment failed for the purchase attempt.
OfferingType (string) --
The anticipated utilization of the reserved node, as defined in the reserved node offering.
RecurringCharges (list) --
The recurring charges for the reserved node.
(dict) --
Describes a recurring charge.
RecurringChargeAmount (float) --
The amount charged per the period of time specified by the recurring charge frequency.
RecurringChargeFrequency (string) --
The frequency at which the recurring charge amount is applied.
Deletes the specified cluster subnet group.
Request Syntax
client.delete_cluster_subnet_group(
ClusterSubnetGroupName='string'
)
string
[REQUIRED]
The name of the cluster subnet group name to be deleted.
None
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
Request Syntax
client.modify_snapshot_copy_retention_period(
ClusterIdentifier='string',
RetentionPeriod=123
)
string
[REQUIRED]
The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
integer
[REQUIRED]
The number of days to retain automated snapshots in the destination region after they are copied from the source region.
If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Deletes an Amazon Redshift event notification subscription.
Request Syntax
client.delete_event_subscription(
SubscriptionName='string'
)
string
[REQUIRED]
The name of the Amazon Redshift event notification subscription to be deleted.
None
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 EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range or an EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
Note
The EC2 security group must be defined in the AWS region where the cluster resides.
For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP 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 Management Guide .
Request Syntax
client.authorize_cluster_security_group_ingress(
ClusterSecurityGroupName='string',
CIDRIP='string',
EC2SecurityGroupName='string',
EC2SecurityGroupOwnerId='string'
)
string
[REQUIRED]
The name of the security group to which the ingress rule is added.
string
The IP range to be added the Amazon Redshift security group.
string
The EC2 security group to be added the Amazon Redshift security group.
string
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.
Example: 111122223333
dict
Response Syntax
{
'ClusterSecurityGroup': {
'ClusterSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'IPRanges': [
{
'Status': 'string',
'CIDRIP': 'string'
},
]
}
}
Response Structure
(dict) --
Describes a security group.
ClusterSecurityGroup (dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group to which the operation was applied.
Description (string) --
A description of the security group.
EC2SecurityGroups (list) --
A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
(dict) --
Describes an Amazon EC2 security group.
Status (string) --
The status of the EC2 security group.
EC2SecurityGroupName (string) --
The name of the EC2 Security Group.
EC2SecurityGroupOwnerId (string) --
The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
IPRanges (list) --
A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
(dict) --
Describes an IP range used in a security group.
Status (string) --
The status of the IP range, for example, "authorized".
CIDRIP (string) --
The IP range in Classless Inter-Domain Routing (CIDR) notation.
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
Request Syntax
client.enable_logging(
ClusterIdentifier='string',
BucketName='string',
S3KeyPrefix='string'
)
string
[REQUIRED]
The identifier of the cluster on which logging is to be started.
Example: examplecluster
string
[REQUIRED]
The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
string
The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
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
dict
Response Syntax
{
'LoggingEnabled': True|False,
'BucketName': 'string',
'S3KeyPrefix': 'string',
'LastSuccessfulDeliveryTime': datetime(2015, 1, 1),
'LastFailureTime': datetime(2015, 1, 1),
'LastFailureMessage': 'string'
}
Response Structure
(dict) --
Describes the status of logging for a cluster.
LoggingEnabled (boolean) --
true if logging is on, false if logging is off.
BucketName (string) --
The name of the S3 bucket where the log files are stored.
S3KeyPrefix (string) --
The prefix applied to the log file names.
LastSuccessfulDeliveryTime (datetime) --
The last time when logs were delivered.
LastFailureTime (datetime) --
The last time when logs failed to be delivered.
LastFailureMessage (string) --
The message indicating that logs failed to be delivered.
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.
Request Syntax
client.create_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
SourceIds=[
'string',
],
EventCategories=[
'string',
],
Severity='string',
Enabled=True|False
)
string
[REQUIRED]
The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
string
[REQUIRED]
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.
string
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.
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
list
A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
(string) --
list
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: Configuration, Management, Monitoring, Security
(string) --
string
Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
boolean
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': datetime(2015, 1, 1),
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Severity': 'string',
'Enabled': True|False
}
}
Response Structure
(dict) --
EventSubscription (dict) --
CustomerAwsId (string) --
The AWS customer account associated with the Amazon Redshift event notification subscription.
CustSubscriptionId (string) --
The name of the Amazon Redshift event notification subscription.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
Status (string) --
The status of the Amazon Redshift event notification subscription.
Constraints:
Can be one of the following: active | no-permission | topic-not-exist
The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (datetime) --
The date and time the Amazon Redshift event notification subscription was created.
SourceType (string) --
The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.
SourceIdsList (list) --
A list of the sources that publish events to the Amazon Redshift event notification subscription.
(string) --
EventCategoriesList (list) --
The list of Amazon Redshift event categories specified in the event notification subscription.
Values: Configuration, Management, Monitoring, Security
(string) --
Severity (string) --
The event severity specified in the Amazon Redshift event notification subscription.
Values: ERROR, INFO
Enabled (boolean) --
A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
Request Syntax
client.disable_snapshot_copy(
ClusterIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Returns a list of parameter settings for the specified parameter group family.
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide .
Request Syntax
client.describe_default_cluster_parameters(
ParameterGroupFamily='string',
MaxRecords=123,
Marker='string'
)
string
[REQUIRED]
The name of the cluster parameter group family.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'DefaultClusterParameters': {
'ParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
]
}
}
Response Structure
(dict) --
Describes the default cluster parameters for a parameter group family.
DefaultClusterParameters (dict) --
Describes the default cluster parameters for a parameter group family.
ParameterGroupFamily (string) --
The name of the cluster parameter group family to which the engine default parameters apply.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Parameters (list) --
The list of cluster default parameters.
(dict) --
Describes a parameter in a cluster parameter group.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value, such as "engine-default" or "user".
DataType (string) --
The data type of the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
IsModifiable (boolean) --
If true , the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
Modifies an existing Amazon Redshift event notification subscription.
Request Syntax
client.modify_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
SourceIds=[
'string',
],
EventCategories=[
'string',
],
Severity='string',
Enabled=True|False
)
string
[REQUIRED]
The name of the modified Amazon Redshift event notification subscription.
string
The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.
string
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.
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
list
A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
(string) --
list
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: Configuration, Management, Monitoring, Security
(string) --
string
Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
boolean
A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled
dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': datetime(2015, 1, 1),
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Severity': 'string',
'Enabled': True|False
}
}
Response Structure
(dict) --
EventSubscription (dict) --
CustomerAwsId (string) --
The AWS customer account associated with the Amazon Redshift event notification subscription.
CustSubscriptionId (string) --
The name of the Amazon Redshift event notification subscription.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
Status (string) --
The status of the Amazon Redshift event notification subscription.
Constraints:
Can be one of the following: active | no-permission | topic-not-exist
The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (datetime) --
The date and time the Amazon Redshift event notification subscription was created.
SourceType (string) --
The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.
SourceIdsList (list) --
A list of the sources that publish events to the Amazon Redshift event notification subscription.
(string) --
EventCategoriesList (list) --
The list of Amazon Redshift event categories specified in the event notification subscription.
Values: Configuration, Management, Monitoring, Security
(string) --
Severity (string) --
The event severity specified in the Amazon Redshift event notification subscription.
Values: ERROR, INFO
Enabled (boolean) --
A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.
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 Management Guide .
Request Syntax
client.revoke_cluster_security_group_ingress(
ClusterSecurityGroupName='string',
CIDRIP='string',
EC2SecurityGroupName='string',
EC2SecurityGroupOwnerId='string'
)
string
[REQUIRED]
The name of the security Group from which to revoke the ingress rule.
string
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.
string
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.
string
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.
Example: 111122223333
dict
Response Syntax
{
'ClusterSecurityGroup': {
'ClusterSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'IPRanges': [
{
'Status': 'string',
'CIDRIP': 'string'
},
]
}
}
Response Structure
(dict) --
Describes a security group.
ClusterSecurityGroup (dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group to which the operation was applied.
Description (string) --
A description of the security group.
EC2SecurityGroups (list) --
A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
(dict) --
Describes an Amazon EC2 security group.
Status (string) --
The status of the EC2 security group.
EC2SecurityGroupName (string) --
The name of the EC2 Security Group.
EC2SecurityGroupOwnerId (string) --
The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
IPRanges (list) --
A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
(dict) --
Describes an IP range used in a security group.
Status (string) --
The status of the IP range, for example, "authorized".
CIDRIP (string) --
The IP range in Classless Inter-Domain Routing (CIDR) notation.
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.
Request Syntax
client.describe_event_categories(
SourceType='string'
)
string
The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, snapshot, parameter group, and security group.
dict
Response Syntax
{
'EventCategoriesMapList': [
{
'SourceType': 'string',
'Events': [
{
'EventId': 'string',
'EventCategories': [
'string',
],
'EventDescription': 'string',
'Severity': 'string'
},
]
},
]
}
Response Structure
(dict) --
EventCategoriesMapList (list) --
A list of event categories descriptions.
(dict) --
SourceType (string) --
The Amazon Redshift source type, such as cluster or cluster-snapshot, that the returned categories belong to.
Events (list) --
The events in the event category.
(dict) --
EventId (string) --
The identifier of an Amazon Redshift event.
EventCategories (list) --
The category of an Amazon Redshift event.
(string) --
EventDescription (string) --
The description of an Amazon Redshift event.
Severity (string) --
The severity of the event.
Values: ERROR, INFO
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.
Request Syntax
client.delete_cluster_snapshot(
SnapshotIdentifier='string',
SnapshotClusterIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the available state.
string
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.
Constraints: Must be the name of valid cluster.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string'
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true , the data in the snapshot is encrypted at rest.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
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 Management Guide .
Request Syntax
client.describe_clusters(
ClusterIdentifier='string',
MaxRecords=123,
Marker='string'
)
string
The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
dict
Response Syntax
{
'Marker': 'string',
'Clusters': [
{
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string'
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeClusters action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Clusters (list) --
A list of Cluster objects, where each object describes one cluster.
(dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available , creating , deleting , rebooting , renaming , and resizing .
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName .
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true , version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true , the cluster can be accessed from a public network.
Encrypted (boolean) --
If true , data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
HsmClientCertificateIdentifier (string) --
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier (string) --
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster. -->
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
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.
Request Syntax
client.describe_cluster_subnet_groups(
ClusterSubnetGroupName='string',
MaxRecords=123,
Marker='string'
)
string
The name of the cluster subnet group for which information is requested.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Marker': 'string',
'ClusterSubnetGroups': [
{
'ClusterSubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeClusterSubnetGroups action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
ClusterSubnetGroups (list) --
A list of ClusterSubnetGroup instances.
(dict) --
Describes a subnet group.
ClusterSubnetGroupName (string) --
The name of the cluster subnet group.
Description (string) --
The description of the cluster subnet group.
VpcId (string) --
The VPC ID of the cluster subnet group.
SubnetGroupStatus (string) --
The status of the cluster subnet group. Possible values are Complete , Incomplete and Invalid .
Subnets (list) --
A list of the VPC Subnet elements.
(dict) --
Describes a subnet.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Describes an availability zone.
Name (string) --
The name of the availability zone.
SubnetStatus (string) --
The status of the subnet.