2020/03/11 - Amazon Redshift - 2 new 3 updated api methods
Changes Amazon Redshift now supports operations to pause and resume a cluster on demand or on a schedule.
Resumes a paused cluster.
See also: AWS API Documentation
Request Syntax
client.resume_cluster(
ClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster to be resumed.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
}
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
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 the DBName parameter.
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 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.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide .
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync : The parameter value is in sync with the database.
pending-reboot : The parameter value will be applied after the cluster reboots.
applying : The parameter value is being applied to the database.
invalid-parameter : Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred : The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error : Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error : Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None. For the China region the possible values are None, and Legacy.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that major 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
The status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
(dict) --
An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
Pauses a cluster.
See also: AWS API Documentation
Request Syntax
client.pause_cluster(
ClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster to be paused.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
}
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
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 the DBName parameter.
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 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.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide .
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync : The parameter value is in sync with the database.
pending-reboot : The parameter value will be applied after the cluster reboots.
applying : The parameter value is being applied to the database.
invalid-parameter : Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred : The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error : Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error : Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None. For the China region the possible values are None, and Legacy.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that major 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
The status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
(dict) --
An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
{'TargetAction': {'PauseCluster': {'ClusterIdentifier': 'string'},
'ResumeCluster': {'ClusterIdentifier': 'string'}}}
Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.
See also: AWS API Documentation
Request Syntax
client.create_scheduled_action(
ScheduledActionName='string',
TargetAction={
'ResizeCluster': {
'ClusterIdentifier': 'string',
'ClusterType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'Classic': True|False
},
'PauseCluster': {
'ClusterIdentifier': 'string'
},
'ResumeCluster': {
'ClusterIdentifier': 'string'
}
},
Schedule='string',
IamRole='string',
ScheduledActionDescription='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Enable=True|False
)
string
[REQUIRED]
The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction .
dict
[REQUIRED]
A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction .
ResizeCluster (dict) --
An action that runs a ResizeCluster API operation.
ClusterIdentifier (string) -- [REQUIRED]
The unique identifier for the cluster to resize.
ClusterType (string) --
The new cluster type for the specified cluster.
NodeType (string) --
The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
NumberOfNodes (integer) --
The new number of nodes for the cluster.
Classic (boolean) --
A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
PauseCluster (dict) --
An action that runs a PauseCluster API operation.
ClusterIdentifier (string) -- [REQUIRED]
The identifier of the cluster to be paused.
ResumeCluster (dict) --
An action that runs a ResumeCluster API operation.
ClusterIdentifier (string) -- [REQUIRED]
The identifier of the cluster to be resumed.
string
[REQUIRED]
The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction .
string
[REQUIRED]
The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction .
string
The description of the scheduled action.
datetime
The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction .
datetime
The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction .
boolean
If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction .
dict
Response Syntax
{
'ScheduledActionName': 'string',
'TargetAction': {
'ResizeCluster': {
'ClusterIdentifier': 'string',
'ClusterType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'Classic': True|False
},
'PauseCluster': {
'ClusterIdentifier': 'string'
},
'ResumeCluster': {
'ClusterIdentifier': 'string'
}
},
'Schedule': 'string',
'IamRole': 'string',
'ScheduledActionDescription': 'string',
'State': 'ACTIVE'|'DISABLED',
'NextInvocations': [
datetime(2015, 1, 1),
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType .
ScheduledActionName (string) --
The name of the scheduled action.
TargetAction (dict) --
A JSON format string of the Amazon Redshift API operation with input parameters.
"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".
ResizeCluster (dict) --
An action that runs a ResizeCluster API operation.
ClusterIdentifier (string) --
The unique identifier for the cluster to resize.
ClusterType (string) --
The new cluster type for the specified cluster.
NodeType (string) --
The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
NumberOfNodes (integer) --
The new number of nodes for the cluster.
Classic (boolean) --
A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
PauseCluster (dict) --
An action that runs a PauseCluster API operation.
ClusterIdentifier (string) --
The identifier of the cluster to be paused.
ResumeCluster (dict) --
An action that runs a ResumeCluster API operation.
ClusterIdentifier (string) --
The identifier of the cluster to be resumed.
Schedule (string) --
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
IamRole (string) --
The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide .
ScheduledActionDescription (string) --
The description of the scheduled action.
State (string) --
The state of the scheduled action. For example, DISABLED .
NextInvocations (list) --
List of times when the scheduled action will run.
(datetime) --
StartTime (datetime) --
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
EndTime (datetime) --
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
{'TargetActionType': {'PauseCluster', 'ResumeCluster'}}
Response {'ScheduledActions': {'TargetAction': {'PauseCluster': {'ClusterIdentifier': 'string'},
'ResumeCluster': {'ClusterIdentifier': 'string'}}}}
Describes properties of scheduled actions.
See also: AWS API Documentation
Request Syntax
client.describe_scheduled_actions(
ScheduledActionName='string',
TargetActionType='ResizeCluster'|'PauseCluster'|'ResumeCluster',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Active=True|False,
Filters=[
{
'Name': 'cluster-identifier'|'iam-role',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
string
The name of the scheduled action to retrieve.
string
The type of the scheduled actions to retrieve.
datetime
The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
datetime
The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
boolean
If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
list
List of scheduled action filters.
(dict) --
A set of elements to filter the returned scheduled actions.
Name (string) -- [REQUIRED]
The type of element to filter.
Values (list) -- [REQUIRED]
List of values. Compare if the value (of type defined by Name ) equals an item in the list of scheduled actions.
(string) --
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions 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.
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.
dict
Response Syntax
{
'Marker': 'string',
'ScheduledActions': [
{
'ScheduledActionName': 'string',
'TargetAction': {
'ResizeCluster': {
'ClusterIdentifier': 'string',
'ClusterType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'Classic': True|False
},
'PauseCluster': {
'ClusterIdentifier': 'string'
},
'ResumeCluster': {
'ClusterIdentifier': 'string'
}
},
'Schedule': 'string',
'IamRole': 'string',
'ScheduledActionDescription': 'string',
'State': 'ACTIVE'|'DISABLED',
'NextInvocations': [
datetime(2015, 1, 1),
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions 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.
ScheduledActions (list) --
List of retrieved scheduled actions.
(dict) --
Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType .
ScheduledActionName (string) --
The name of the scheduled action.
TargetAction (dict) --
A JSON format string of the Amazon Redshift API operation with input parameters.
"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".
ResizeCluster (dict) --
An action that runs a ResizeCluster API operation.
ClusterIdentifier (string) --
The unique identifier for the cluster to resize.
ClusterType (string) --
The new cluster type for the specified cluster.
NodeType (string) --
The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
NumberOfNodes (integer) --
The new number of nodes for the cluster.
Classic (boolean) --
A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
PauseCluster (dict) --
An action that runs a PauseCluster API operation.
ClusterIdentifier (string) --
The identifier of the cluster to be paused.
ResumeCluster (dict) --
An action that runs a ResumeCluster API operation.
ClusterIdentifier (string) --
The identifier of the cluster to be resumed.
Schedule (string) --
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
IamRole (string) --
The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide .
ScheduledActionDescription (string) --
The description of the scheduled action.
State (string) --
The state of the scheduled action. For example, DISABLED .
NextInvocations (list) --
List of times when the scheduled action will run.
(datetime) --
StartTime (datetime) --
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
EndTime (datetime) --
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
{'TargetAction': {'PauseCluster': {'ClusterIdentifier': 'string'},
'ResumeCluster': {'ClusterIdentifier': 'string'}}}
Modifies a scheduled action.
See also: AWS API Documentation
Request Syntax
client.modify_scheduled_action(
ScheduledActionName='string',
TargetAction={
'ResizeCluster': {
'ClusterIdentifier': 'string',
'ClusterType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'Classic': True|False
},
'PauseCluster': {
'ClusterIdentifier': 'string'
},
'ResumeCluster': {
'ClusterIdentifier': 'string'
}
},
Schedule='string',
IamRole='string',
ScheduledActionDescription='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Enable=True|False
)
string
[REQUIRED]
The name of the scheduled action to modify.
dict
A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction .
ResizeCluster (dict) --
An action that runs a ResizeCluster API operation.
ClusterIdentifier (string) -- [REQUIRED]
The unique identifier for the cluster to resize.
ClusterType (string) --
The new cluster type for the specified cluster.
NodeType (string) --
The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
NumberOfNodes (integer) --
The new number of nodes for the cluster.
Classic (boolean) --
A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
PauseCluster (dict) --
An action that runs a PauseCluster API operation.
ClusterIdentifier (string) -- [REQUIRED]
The identifier of the cluster to be paused.
ResumeCluster (dict) --
An action that runs a ResumeCluster API operation.
ClusterIdentifier (string) -- [REQUIRED]
The identifier of the cluster to be resumed.
string
A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction .
string
A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction .
string
A modified description of the scheduled action.
datetime
A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction .
datetime
A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction .
boolean
A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.
dict
Response Syntax
{
'ScheduledActionName': 'string',
'TargetAction': {
'ResizeCluster': {
'ClusterIdentifier': 'string',
'ClusterType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'Classic': True|False
},
'PauseCluster': {
'ClusterIdentifier': 'string'
},
'ResumeCluster': {
'ClusterIdentifier': 'string'
}
},
'Schedule': 'string',
'IamRole': 'string',
'ScheduledActionDescription': 'string',
'State': 'ACTIVE'|'DISABLED',
'NextInvocations': [
datetime(2015, 1, 1),
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType .
ScheduledActionName (string) --
The name of the scheduled action.
TargetAction (dict) --
A JSON format string of the Amazon Redshift API operation with input parameters.
"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".
ResizeCluster (dict) --
An action that runs a ResizeCluster API operation.
ClusterIdentifier (string) --
The unique identifier for the cluster to resize.
ClusterType (string) --
The new cluster type for the specified cluster.
NodeType (string) --
The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
NumberOfNodes (integer) --
The new number of nodes for the cluster.
Classic (boolean) --
A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
PauseCluster (dict) --
An action that runs a PauseCluster API operation.
ClusterIdentifier (string) --
The identifier of the cluster to be paused.
ResumeCluster (dict) --
An action that runs a ResumeCluster API operation.
ClusterIdentifier (string) --
The identifier of the cluster to be resumed.
Schedule (string) --
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
IamRole (string) --
The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide .
ScheduledActionDescription (string) --
The description of the scheduled action.
State (string) --
The state of the scheduled action. For example, DISABLED .
NextInvocations (list) --
List of times when the scheduled action will run.
(datetime) --
StartTime (datetime) --
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
EndTime (datetime) --
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.