Redshift ******** Client ====== class Redshift.Client A low-level client representing Amazon Redshift **Overview** This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces. Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers. If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide. If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse. import boto3 client = boto3.client('redshift') These are the available methods: * accept_reserved_node_exchange * add_partner * associate_data_share_consumer * authorize_cluster_security_group_ingress * authorize_data_share * authorize_endpoint_access * authorize_snapshot_access * batch_delete_cluster_snapshots * batch_modify_cluster_snapshots * can_paginate * cancel_resize * close * copy_cluster_snapshot * create_authentication_profile * create_cluster * create_cluster_parameter_group * create_cluster_security_group * create_cluster_snapshot * create_cluster_subnet_group * create_custom_domain_association * create_endpoint_access * create_event_subscription * create_hsm_client_certificate * create_hsm_configuration * create_integration * create_redshift_idc_application * create_scheduled_action * create_snapshot_copy_grant * create_snapshot_schedule * create_tags * create_usage_limit * deauthorize_data_share * delete_authentication_profile * delete_cluster * delete_cluster_parameter_group * delete_cluster_security_group * delete_cluster_snapshot * delete_cluster_subnet_group * delete_custom_domain_association * delete_endpoint_access * delete_event_subscription * delete_hsm_client_certificate * delete_hsm_configuration * delete_integration * delete_partner * delete_redshift_idc_application * delete_resource_policy * delete_scheduled_action * delete_snapshot_copy_grant * delete_snapshot_schedule * delete_tags * delete_usage_limit * deregister_namespace * describe_account_attributes * describe_authentication_profiles * describe_cluster_db_revisions * describe_cluster_parameter_groups * describe_cluster_parameters * describe_cluster_security_groups * describe_cluster_snapshots * describe_cluster_subnet_groups * describe_cluster_tracks * describe_cluster_versions * describe_clusters * describe_custom_domain_associations * describe_data_shares * describe_data_shares_for_consumer * describe_data_shares_for_producer * describe_default_cluster_parameters * describe_endpoint_access * describe_endpoint_authorization * describe_event_categories * describe_event_subscriptions * describe_events * describe_hsm_client_certificates * describe_hsm_configurations * describe_inbound_integrations * describe_integrations * describe_logging_status * describe_node_configuration_options * describe_orderable_cluster_options * describe_partners * describe_redshift_idc_applications * describe_reserved_node_exchange_status * describe_reserved_node_offerings * describe_reserved_nodes * describe_resize * describe_scheduled_actions * describe_snapshot_copy_grants * describe_snapshot_schedules * describe_storage * describe_table_restore_status * describe_tags * describe_usage_limits * disable_logging * disable_snapshot_copy * disassociate_data_share_consumer * enable_logging * enable_snapshot_copy * failover_primary_compute * get_cluster_credentials * get_cluster_credentials_with_iam * get_paginator * get_reserved_node_exchange_configuration_options * get_reserved_node_exchange_offerings * get_resource_policy * get_waiter * list_recommendations * modify_aqua_configuration * modify_authentication_profile * modify_cluster * modify_cluster_db_revision * modify_cluster_iam_roles * modify_cluster_maintenance * modify_cluster_parameter_group * modify_cluster_snapshot * modify_cluster_snapshot_schedule * modify_cluster_subnet_group * modify_custom_domain_association * modify_endpoint_access * modify_event_subscription * modify_integration * modify_redshift_idc_application * modify_scheduled_action * modify_snapshot_copy_retention_period * modify_snapshot_schedule * modify_usage_limit * pause_cluster * purchase_reserved_node_offering * put_resource_policy * reboot_cluster * register_namespace * reject_data_share * reset_cluster_parameter_group * resize_cluster * restore_from_cluster_snapshot * restore_table_from_cluster_snapshot * resume_cluster * revoke_cluster_security_group_ingress * revoke_endpoint_access * revoke_snapshot_access * rotate_encryption_key * update_partner_status Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * DescribeClusterDbRevisions * DescribeClusterParameterGroups * DescribeClusterParameters * DescribeClusterSecurityGroups * DescribeClusterSnapshots * DescribeClusterSubnetGroups * DescribeClusterTracks * DescribeClusterVersions * DescribeClusters * DescribeCustomDomainAssociations * DescribeDataShares * DescribeDataSharesForConsumer * DescribeDataSharesForProducer * DescribeDefaultClusterParameters * DescribeEndpointAccess * DescribeEndpointAuthorization * DescribeEventSubscriptions * DescribeEvents * DescribeHsmClientCertificates * DescribeHsmConfigurations * DescribeInboundIntegrations * DescribeIntegrations * DescribeNodeConfigurationOptions * DescribeOrderableClusterOptions * DescribeRedshiftIdcApplications * DescribeReservedNodeExchangeStatus * DescribeReservedNodeOfferings * DescribeReservedNodes * DescribeScheduledActions * DescribeSnapshotCopyGrants * DescribeSnapshotSchedules * DescribeTableRestoreStatus * DescribeTags * DescribeUsageLimits * GetReservedNodeExchangeConfigurationOptions * GetReservedNodeExchangeOfferings * ListRecommendations Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * ClusterAvailable * ClusterDeleted * ClusterRestored * SnapshotAvailable Redshift / Waiter / ClusterRestored ClusterRestored *************** class Redshift.Waiter.ClusterRestored waiter = client.get_waiter('cluster_restored') wait(**kwargs) Polls "Redshift.Client.describe_clusters()" every 60 seconds until a successful state is reached. An error is raised after 30 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ClusterIdentifier='string', MaxRecords=123, Marker='string', TagKeys=[ 'string', ], TagValues=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ClusterIdentifier** (*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. * **MaxRecords** (*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. * **Marker** (*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", Amazon Web Services 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. * **TagKeys** (*list*) -- A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called "owner" and "environment". If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. * *(string) --* * **TagValues** (*list*) -- A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called "admin" and "test". If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 60 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 30 Returns: None Redshift / Waiter / ClusterDeleted ClusterDeleted ************** class Redshift.Waiter.ClusterDeleted waiter = client.get_waiter('cluster_deleted') wait(**kwargs) Polls "Redshift.Client.describe_clusters()" every 60 seconds until a successful state is reached. An error is raised after 30 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ClusterIdentifier='string', MaxRecords=123, Marker='string', TagKeys=[ 'string', ], TagValues=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ClusterIdentifier** (*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. * **MaxRecords** (*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. * **Marker** (*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", Amazon Web Services 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. * **TagKeys** (*list*) -- A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called "owner" and "environment". If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. * *(string) --* * **TagValues** (*list*) -- A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called "admin" and "test". If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 60 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 30 Returns: None Redshift / Waiter / ClusterAvailable ClusterAvailable **************** class Redshift.Waiter.ClusterAvailable waiter = client.get_waiter('cluster_available') wait(**kwargs) Polls "Redshift.Client.describe_clusters()" every 60 seconds until a successful state is reached. An error is raised after 30 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ClusterIdentifier='string', MaxRecords=123, Marker='string', TagKeys=[ 'string', ], TagValues=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ClusterIdentifier** (*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. * **MaxRecords** (*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. * **Marker** (*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", Amazon Web Services 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. * **TagKeys** (*list*) -- A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called "owner" and "environment". If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. * *(string) --* * **TagValues** (*list*) -- A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called "admin" and "test". If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 60 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 30 Returns: None Redshift / Waiter / SnapshotAvailable SnapshotAvailable ***************** class Redshift.Waiter.SnapshotAvailable waiter = client.get_waiter('snapshot_available') wait(**kwargs) Polls "Redshift.Client.describe_cluster_snapshots()" every 15 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ClusterIdentifier='string', SnapshotIdentifier='string', SnapshotArn='string', SnapshotType='string', StartTime=datetime(2015, 1, 1), EndTime=datetime(2015, 1, 1), MaxRecords=123, Marker='string', OwnerAccount='string', TagKeys=[ 'string', ], TagValues=[ 'string', ], ClusterExists=True|False, SortingEntities=[ { 'Attribute': 'SOURCE_TYPE'|'TOTAL_SIZE'|'CREATE_TIME', 'SortOrder': 'ASC'|'DESC' }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ClusterIdentifier** (*string*) -- The identifier of the cluster which generated the requested snapshots. * **SnapshotIdentifier** (*string*) -- The snapshot identifier of the snapshot about which to return information. * **SnapshotArn** (*string*) -- The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots. * **SnapshotType** (*string*) -- The type of snapshots for which you are requesting information. By default, snapshots of all types are returned. Valid Values: "automated" | "manual" * **StartTime** (*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" * **EndTime** (*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" * **MaxRecords** (*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. * **Marker** (*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", Amazon Web Services 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. * **OwnerAccount** (*string*) -- The Amazon Web Services 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 Amazon Web Services account, or do not specify the parameter. * **TagKeys** (*list*) -- A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called "owner" and "environment". If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them. * *(string) --* * **TagValues** (*list*) -- A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called "admin" and "test". If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them. * *(string) --* * **ClusterExists** (*boolean*) -- A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows: * If "ClusterExists" is set to "true", "ClusterIdentifier" is required. * If "ClusterExists" is set to "false" and "ClusterIdentifier" isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned. * If "ClusterExists" is set to "false" and "ClusterIdentifier" is specified for a deleted cluster, snapshots associated with that cluster are returned. * If "ClusterExists" is set to "false" and "ClusterIdentifier" is specified for an existing cluster, no snapshots are returned. * **SortingEntities** (*list*) -- * *(dict) --* Describes a sorting entity * **Attribute** *(string) --* **[REQUIRED]** The category for sorting the snapshots. * **SortOrder** *(string) --* The order for listing the attributes. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Redshift / Paginator / DescribeDataSharesForProducer DescribeDataSharesForProducer ***************************** class Redshift.Paginator.DescribeDataSharesForProducer paginator = client.get_paginator('describe_data_shares_for_producer') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_data_shares_for_producer()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProducerArn='string', Status='ACTIVE'|'AUTHORIZED'|'PENDING_AUTHORIZATION'|'DEAUTHORIZED'|'REJECTED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProducerArn** (*string*) -- The Amazon Resource Name (ARN) of the producer namespace that returns in the list of datashares. * **Status** (*string*) -- An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DataShares': [ { 'DataShareArn': 'string', 'ProducerArn': 'string', 'AllowPubliclyAccessibleConsumers': True|False, 'DataShareAssociations': [ { 'ConsumerIdentifier': 'string', 'Status': 'ACTIVE'|'PENDING_AUTHORIZATION'|'AUTHORIZED'|'DEAUTHORIZED'|'REJECTED'|'AVAILABLE', 'ConsumerRegion': 'string', 'CreatedDate': datetime(2015, 1, 1), 'StatusChangeDate': datetime(2015, 1, 1), 'ProducerAllowedWrites': True|False, 'ConsumerAcceptedWrites': True|False }, ], 'ManagedBy': 'string', 'DataShareType': 'INTERNAL' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **DataShares** *(list) --* Shows the results of datashares available for producers. * *(dict) --* * **DataShareArn** *(string) --* The Amazon Resource Name (ARN) of the datashare that the consumer is to use. * **ProducerArn** *(string) --* The Amazon Resource Name (ARN) of the producer namespace. * **AllowPubliclyAccessibleConsumers** *(boolean) --* A value that specifies whether the datashare can be shared to a publicly accessible cluster. * **DataShareAssociations** *(list) --* A value that specifies when the datashare has an association between producer and data consumers. * *(dict) --* The association of a datashare from a producer account with a data consumer. * **ConsumerIdentifier** *(string) --* The name of the consumer accounts that have an association with a producer datashare. * **Status** *(string) --* The status of the datashare that is associated. * **ConsumerRegion** *(string) --* The Amazon Web Services Region of the consumer accounts that have an association with a producer datashare. * **CreatedDate** *(datetime) --* The creation date of the datashare that is associated. * **StatusChangeDate** *(datetime) --* The status change data of the datashare that is associated. * **ProducerAllowedWrites** *(boolean) --* Specifies whether write operations were allowed during data share authorization. * **ConsumerAcceptedWrites** *(boolean) --* Specifies whether write operations were allowed during data share association. * **ManagedBy** *(string) --* The identifier of a datashare to show its managing entity. * **DataShareType** *(string) --* The type of the datashare created by RegisterNamespace. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeHsmConfigurations DescribeHsmConfigurations ************************* class Redshift.Paginator.DescribeHsmConfigurations paginator = client.get_paginator('describe_hsm_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_hsm_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( HsmConfigurationIdentifier='string', TagKeys=[ 'string', ], TagValues=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **HsmConfigurationIdentifier** (*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 Amazon Web Services account. * **TagKeys** (*list*) -- A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called "owner" and "environment". If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them. * *(string) --* * **TagValues** (*list*) -- A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called "admin" and "test". If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HsmConfigurations': [ { 'HsmConfigurationIdentifier': 'string', 'Description': 'string', 'HsmIpAddress': 'string', 'HsmPartitionName': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **HsmConfigurations** *(list) --* A list of "HsmConfiguration" objects. * *(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. * **Tags** *(list) --* The list of tags for the HSM configuration. * *(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. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeTableRestoreStatus DescribeTableRestoreStatus ************************** class Redshift.Paginator.DescribeTableRestoreStatus paginator = client.get_paginator('describe_table_restore_status') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_table_restore_status()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterIdentifier='string', TableRestoreRequestId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterIdentifier** (*string*) -- The Amazon Redshift cluster that the table is being restored to. * **TableRestoreRequestId** (*string*) -- The identifier of the table restore request to return status for. If you don't specify a "TableRestoreRequestId" value, then "DescribeTableRestoreStatus" returns the status of all in- progress table restore requests. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TableRestoreStatusDetails': [ { 'TableRestoreRequestId': 'string', 'Status': 'PENDING'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'CANCELED', 'Message': 'string', 'RequestTime': datetime(2015, 1, 1), 'ProgressInMegaBytes': 123, 'TotalDataInMegaBytes': 123, 'ClusterIdentifier': 'string', 'SnapshotIdentifier': 'string', 'SourceDatabaseName': 'string', 'SourceSchemaName': 'string', 'SourceTableName': 'string', 'TargetDatabaseName': 'string', 'TargetSchemaName': 'string', 'NewTableName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TableRestoreStatusDetails** *(list) --* A list of status details for one or more table restore requests. * *(dict) --* Describes the status of a RestoreTableFromClusterSnapshot operation. * **TableRestoreRequestId** *(string) --* The unique identifier for the table restore request. * **Status** *(string) --* A value that describes the current state of the table restore request. Valid Values: "SUCCEEDED", "FAILED", "CANCELED", "PENDING", "IN_PROGRESS" * **Message** *(string) --* A description of the status of the table restore request. Status values include "SUCCEEDED", "FAILED", "CANCELED", "PENDING", "IN_PROGRESS". * **RequestTime** *(datetime) --* The time that the table restore request was made, in Universal Coordinated Time (UTC). * **ProgressInMegaBytes** *(integer) --* The amount of data restored to the new table so far, in megabytes (MB). * **TotalDataInMegaBytes** *(integer) --* The total amount of data to restore to the new table, in megabytes (MB). * **ClusterIdentifier** *(string) --* The identifier of the Amazon Redshift cluster that the table is being restored to. * **SnapshotIdentifier** *(string) --* The identifier of the snapshot that the table is being restored from. * **SourceDatabaseName** *(string) --* The name of the source database that contains the table being restored. * **SourceSchemaName** *(string) --* The name of the source schema that contains the table being restored. * **SourceTableName** *(string) --* The name of the source table being restored. * **TargetDatabaseName** *(string) --* The name of the database to restore the table to. * **TargetSchemaName** *(string) --* The name of the schema to restore the table to. * **NewTableName** *(string) --* The name of the table to create as a result of the table restore request. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeDataShares DescribeDataShares ****************** class Redshift.Paginator.DescribeDataShares paginator = client.get_paginator('describe_data_shares') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_data_shares()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DataShareArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DataShareArn** (*string*) -- The Amazon resource name (ARN) of the datashare to describe details of. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DataShares': [ { 'DataShareArn': 'string', 'ProducerArn': 'string', 'AllowPubliclyAccessibleConsumers': True|False, 'DataShareAssociations': [ { 'ConsumerIdentifier': 'string', 'Status': 'ACTIVE'|'PENDING_AUTHORIZATION'|'AUTHORIZED'|'DEAUTHORIZED'|'REJECTED'|'AVAILABLE', 'ConsumerRegion': 'string', 'CreatedDate': datetime(2015, 1, 1), 'StatusChangeDate': datetime(2015, 1, 1), 'ProducerAllowedWrites': True|False, 'ConsumerAcceptedWrites': True|False }, ], 'ManagedBy': 'string', 'DataShareType': 'INTERNAL' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **DataShares** *(list) --* The results returned from describing datashares. * *(dict) --* * **DataShareArn** *(string) --* The Amazon Resource Name (ARN) of the datashare that the consumer is to use. * **ProducerArn** *(string) --* The Amazon Resource Name (ARN) of the producer namespace. * **AllowPubliclyAccessibleConsumers** *(boolean) --* A value that specifies whether the datashare can be shared to a publicly accessible cluster. * **DataShareAssociations** *(list) --* A value that specifies when the datashare has an association between producer and data consumers. * *(dict) --* The association of a datashare from a producer account with a data consumer. * **ConsumerIdentifier** *(string) --* The name of the consumer accounts that have an association with a producer datashare. * **Status** *(string) --* The status of the datashare that is associated. * **ConsumerRegion** *(string) --* The Amazon Web Services Region of the consumer accounts that have an association with a producer datashare. * **CreatedDate** *(datetime) --* The creation date of the datashare that is associated. * **StatusChangeDate** *(datetime) --* The status change data of the datashare that is associated. * **ProducerAllowedWrites** *(boolean) --* Specifies whether write operations were allowed during data share authorization. * **ConsumerAcceptedWrites** *(boolean) --* Specifies whether write operations were allowed during data share association. * **ManagedBy** *(string) --* The identifier of a datashare to show its managing entity. * **DataShareType** *(string) --* The type of the datashare created by RegisterNamespace. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeSnapshotSchedules DescribeSnapshotSchedules ************************* class Redshift.Paginator.DescribeSnapshotSchedules paginator = client.get_paginator('describe_snapshot_schedules') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_snapshot_schedules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterIdentifier='string', ScheduleIdentifier='string', TagKeys=[ 'string', ], TagValues=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterIdentifier** (*string*) -- The unique identifier for the cluster whose snapshot schedules you want to view. * **ScheduleIdentifier** (*string*) -- A unique identifier for a snapshot schedule. * **TagKeys** (*list*) -- The key value for a snapshot schedule tag. * *(string) --* * **TagValues** (*list*) -- The value corresponding to the key of the snapshot schedule tag. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SnapshotSchedules': [ { 'ScheduleDefinitions': [ 'string', ], 'ScheduleIdentifier': 'string', 'ScheduleDescription': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'NextInvocations': [ datetime(2015, 1, 1), ], 'AssociatedClusterCount': 123, 'AssociatedClusters': [ { 'ClusterIdentifier': 'string', 'ScheduleAssociationState': 'MODIFYING'|'ACTIVE'|'FAILED' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **SnapshotSchedules** *(list) --* A list of SnapshotSchedules. * *(dict) --* Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates. * **ScheduleDefinitions** *(list) --* A list of ScheduleDefinitions. * *(string) --* * **ScheduleIdentifier** *(string) --* A unique identifier for the schedule. * **ScheduleDescription** *(string) --* The description of the schedule. * **Tags** *(list) --* An optional set of tags describing the schedule. * *(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. * **NextInvocations** *(list) --* * *(datetime) --* * **AssociatedClusterCount** *(integer) --* The number of clusters associated with the schedule. * **AssociatedClusters** *(list) --* A list of clusters associated with the schedule. A maximum of 100 clusters is returned. * *(dict) --* * **ClusterIdentifier** *(string) --* * **ScheduleAssociationState** *(string) --* * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeInboundIntegrations DescribeInboundIntegrations *************************** class Redshift.Paginator.DescribeInboundIntegrations paginator = client.get_paginator('describe_inbound_integrations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_inbound_integrations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( IntegrationArn='string', TargetArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **IntegrationArn** (*string*) -- The Amazon Resource Name (ARN) of the inbound integration. * **TargetArn** (*string*) -- The Amazon Resource Name (ARN) of the target of an inbound integration. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InboundIntegrations': [ { 'IntegrationArn': 'string', 'SourceArn': 'string', 'TargetArn': 'string', 'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention', 'Errors': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ], 'CreateTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **InboundIntegrations** *(list) --* A list of InboundIntegration instances. * *(dict) --* The content of an inbound integration. * **IntegrationArn** *(string) --* The Amazon Resource Name (ARN) of an inbound integration. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the source of an inbound integration. * **TargetArn** *(string) --* The Amazon Resource Name (ARN) of the target of an inbound integration. * **Status** *(string) --* The status of an inbound integration. * **Errors** *(list) --* The outstanding errors of an inbound integration. Each item is an "IntegrationError". This is null if there is no error. * *(dict) --* The error of an inbound integration. * **ErrorCode** *(string) --* The error code of an inbound integration error. * **ErrorMessage** *(string) --* The error message of an inbound integration error. * **CreateTime** *(datetime) --* The creation time of an inbound integration. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeEventSubscriptions DescribeEventSubscriptions ************************** class Redshift.Paginator.DescribeEventSubscriptions paginator = client.get_paginator('describe_event_subscriptions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_event_subscriptions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( SubscriptionName='string', TagKeys=[ 'string', ], TagValues=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **SubscriptionName** (*string*) -- The name of the Amazon Redshift event notification subscription to be described. * **TagKeys** (*list*) -- A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called "owner" and "environment". If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them. * *(string) --* * **TagValues** (*list*) -- A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called "admin" and "test". If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **EventSubscriptionsList** *(list) --* A list of event subscriptions. * *(dict) --* Describes event subscriptions. * **CustomerAwsId** *(string) --* The Amazon Web Services 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 by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster- security-group, or scheduled-action. * **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, Pending * *(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 that the subscription is enabled. * **Tags** *(list) --* The list of tags for the event subscription. * *(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. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeRedshiftIdcApplications DescribeRedshiftIdcApplications ******************************* class Redshift.Paginator.DescribeRedshiftIdcApplications paginator = client.get_paginator('describe_redshift_idc_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_redshift_idc_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( RedshiftIdcApplicationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **RedshiftIdcApplicationArn** (*string*) -- The ARN for the Redshift application that integrates with IAM Identity Center. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RedshiftIdcApplications': [ { 'IdcInstanceArn': 'string', 'RedshiftIdcApplicationName': 'string', 'RedshiftIdcApplicationArn': 'string', 'IdentityNamespace': 'string', 'IdcDisplayName': 'string', 'IamRoleArn': 'string', 'IdcManagedApplicationArn': 'string', 'IdcOnboardStatus': 'string', 'AuthorizedTokenIssuerList': [ { 'TrustedTokenIssuerArn': 'string', 'AuthorizedAudiencesList': [ 'string', ] }, ], 'ServiceIntegrations': [ { 'LakeFormation': [ { 'LakeFormationQuery': { 'Authorization': 'Enabled'|'Disabled' } }, ], 'S3AccessGrants': [ { 'ReadWriteAccess': { 'Authorization': 'Enabled'|'Disabled' } }, ] }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RedshiftIdcApplications** *(list) --* The list of Amazon Redshift IAM Identity Center applications. * *(dict) --* Contains properties for the Redshift IDC application. * **IdcInstanceArn** *(string) --* The ARN for the IAM Identity Center instance that Redshift integrates with. * **RedshiftIdcApplicationName** *(string) --* The name of the Redshift application in IAM Identity Center. * **RedshiftIdcApplicationArn** *(string) --* The ARN for the Redshift application that integrates with IAM Identity Center. * **IdentityNamespace** *(string) --* The identity namespace for the Amazon Redshift IAM Identity Center application. It determines which managed application verifies the connection token. * **IdcDisplayName** *(string) --* The display name for the Amazon Redshift IAM Identity Center application. It appears on the console. * **IamRoleArn** *(string) --* The ARN for the Amazon Redshift IAM Identity Center application. It has the required permissions to be assumed and invoke the IDC Identity Center API. * **IdcManagedApplicationArn** *(string) --* The ARN for the Amazon Redshift IAM Identity Center application. * **IdcOnboardStatus** *(string) --* The onboarding status for the Amazon Redshift IAM Identity Center application. * **AuthorizedTokenIssuerList** *(list) --* The authorized token issuer list for the Amazon Redshift IAM Identity Center application. * *(dict) --* The authorized token issuer for the Amazon Redshift IAM Identity Center application. * **TrustedTokenIssuerArn** *(string) --* The ARN for the authorized token issuer for integrating Amazon Redshift with IDC Identity Center. * **AuthorizedAudiencesList** *(list) --* The list of audiences for the authorized token issuer for integrating Amazon Redshift with IDC Identity Center. * *(string) --* * **ServiceIntegrations** *(list) --* A list of service integrations for the Redshift IAM Identity Center application. * *(dict) --* A list of service integrations. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "LakeFormation", "S3AccessGrants". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **LakeFormation** *(list) --* A list of scopes set up for Lake Formation integration. * *(dict) --* A list of scopes set up for Lake Formation integration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "LakeFormationQuery". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **LakeFormationQuery** *(dict) --* The Lake Formation scope. * **Authorization** *(string) --* Determines whether the query scope is enabled or disabled. * **S3AccessGrants** *(list) --* A list of scopes set up for S3 Access Grants integration. * *(dict) --* A list of scopes set up for S3 Access Grants integration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "ReadWriteAccess". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **ReadWriteAccess** *(dict) --* The S3 Access Grants scope. * **Authorization** *(string) --* Determines whether the read/write scope is enabled or disabled. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeEndpointAuthorization DescribeEndpointAuthorization ***************************** class Redshift.Paginator.DescribeEndpointAuthorization paginator = client.get_paginator('describe_endpoint_authorization') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_endpoint_authorization()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterIdentifier='string', Account='string', Grantee=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterIdentifier** (*string*) -- The cluster identifier of the cluster to access. * **Account** (*string*) -- The Amazon Web Services account ID of either the cluster owner (grantor) or grantee. If "Grantee" parameter is true, then the "Account" value is of the grantor. * **Grantee** (*boolean*) -- Indicates whether to check authorization from a grantor or grantee point of view. If true, Amazon Redshift returns endpoint authorizations that you've been granted. If false (default), checks authorization from a grantor point of view. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EndpointAuthorizationList': [ { 'Grantor': 'string', 'Grantee': 'string', 'ClusterIdentifier': 'string', 'AuthorizeTime': datetime(2015, 1, 1), 'ClusterStatus': 'string', 'Status': 'Authorized'|'Revoking', 'AllowedAllVPCs': True|False, 'AllowedVPCs': [ 'string', ], 'EndpointCount': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **EndpointAuthorizationList** *(list) --* The authorizations to an endpoint. * *(dict) --* Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across Amazon Web Services accounts. * **Grantor** *(string) --* The Amazon Web Services account ID of the cluster owner. * **Grantee** *(string) --* The Amazon Web Services account ID of the grantee of the cluster. * **ClusterIdentifier** *(string) --* The cluster identifier. * **AuthorizeTime** *(datetime) --* The time (UTC) when the authorization was created. * **ClusterStatus** *(string) --* The status of the cluster. * **Status** *(string) --* The status of the authorization action. * **AllowedAllVPCs** *(boolean) --* Indicates whether all VPCs in the grantee account are allowed access to the cluster. * **AllowedVPCs** *(list) --* The VPCs allowed access to the cluster. * *(string) --* * **EndpointCount** *(integer) --* The number of Redshift-managed VPC endpoints created for the authorization. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeReservedNodeExchangeStatus DescribeReservedNodeExchangeStatus ********************************** class Redshift.Paginator.DescribeReservedNodeExchangeStatus paginator = client.get_paginator('describe_reserved_node_exchange_status') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_reserved_node_exchange_status()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ReservedNodeId='string', ReservedNodeExchangeRequestId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ReservedNodeId** (*string*) -- The identifier of the source reserved node in a reserved-node exchange request. * **ReservedNodeExchangeRequestId** (*string*) -- The identifier of the reserved-node exchange request. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ReservedNodeExchangeStatusDetails': [ { 'ReservedNodeExchangeRequestId': 'string', 'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED', 'RequestTime': datetime(2015, 1, 1), 'SourceReservedNodeId': 'string', 'SourceReservedNodeType': 'string', 'SourceReservedNodeCount': 123, 'TargetReservedNodeOfferingId': 'string', 'TargetReservedNodeType': 'string', 'TargetReservedNodeCount': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ReservedNodeExchangeStatusDetails** *(list) --* The details of the reserved-node exchange request, including the status, request time, source reserved-node identifier, and additional details. * *(dict) --* Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other details. * **ReservedNodeExchangeRequestId** *(string) --* The identifier of the reserved-node exchange request. * **Status** *(string) --* The status of the reserved-node exchange request. Statuses include in-progress and requested. * **RequestTime** *(datetime) --* A date and time that indicate when the reserved-node exchange was requested. * **SourceReservedNodeId** *(string) --* The identifier of the source reserved node. * **SourceReservedNodeType** *(string) --* The source reserved-node type, for example ra3.4xlarge. * **SourceReservedNodeCount** *(integer) --* The source reserved-node count in the cluster. * **TargetReservedNodeOfferingId** *(string) --* The identifier of the target reserved node offering. * **TargetReservedNodeType** *(string) --* The node type of the target reserved node, for example ra3.4xlarge. * **TargetReservedNodeCount** *(integer) --* The count of target reserved nodes in the cluster. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeEndpointAccess DescribeEndpointAccess ********************** class Redshift.Paginator.DescribeEndpointAccess paginator = client.get_paginator('describe_endpoint_access') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_endpoint_access()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterIdentifier='string', ResourceOwner='string', EndpointName='string', VpcId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterIdentifier** (*string*) -- The cluster identifier associated with the described endpoint. * **ResourceOwner** (*string*) -- The Amazon Web Services account ID of the owner of the cluster. * **EndpointName** (*string*) -- The name of the endpoint to be described. * **VpcId** (*string*) -- The virtual private cloud (VPC) identifier with access to the cluster. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EndpointAccessList': [ { 'ClusterIdentifier': 'string', 'ResourceOwner': 'string', 'SubnetGroupName': 'string', 'EndpointStatus': 'string', 'EndpointName': 'string', 'EndpointCreateTime': datetime(2015, 1, 1), 'Port': 123, 'Address': 'string', 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'VpcEndpoint': { 'VpcEndpointId': 'string', 'VpcId': 'string', 'NetworkInterfaces': [ { 'NetworkInterfaceId': 'string', 'SubnetId': 'string', 'PrivateIpAddress': 'string', 'AvailabilityZone': 'string', 'Ipv6Address': 'string' }, ] } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **EndpointAccessList** *(list) --* The list of endpoints with access to the cluster. * *(dict) --* Describes a Redshift-managed VPC endpoint. * **ClusterIdentifier** *(string) --* The cluster identifier of the cluster associated with the endpoint. * **ResourceOwner** *(string) --* The Amazon Web Services account ID of the owner of the cluster. * **SubnetGroupName** *(string) --* The subnet group name where Amazon Redshift chooses to deploy the endpoint. * **EndpointStatus** *(string) --* The status of the endpoint. * **EndpointName** *(string) --* The name of the endpoint. * **EndpointCreateTime** *(datetime) --* The time (UTC) that the endpoint was created. * **Port** *(integer) --* The port number on which the cluster accepts incoming connections. * **Address** *(string) --* The DNS address of the endpoint. * **VpcSecurityGroups** *(list) --* The security groups associated with the endpoint. * *(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. * **VpcEndpoint** *(dict) --* The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. * **VpcEndpointId** *(string) --* The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. * **VpcId** *(string) --* The VPC identifier that the endpoint is associated. * **NetworkInterfaces** *(list) --* One or more network interfaces of the endpoint. Also known as an interface endpoint. * *(dict) --* Describes a network interface. * **NetworkInterfaceId** *(string) --* The network interface identifier. * **SubnetId** *(string) --* The subnet identifier. * **PrivateIpAddress** *(string) --* The IPv4 address of the network interface within the subnet. * **AvailabilityZone** *(string) --* The Availability Zone. * **Ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeReservedNodes DescribeReservedNodes ********************* class Redshift.Paginator.DescribeReservedNodes paginator = client.get_paginator('describe_reserved_nodes') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_reserved_nodes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ReservedNodeId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ReservedNodeId** (*string*) -- Identifier for the node reservation. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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' }, ], 'ReservedNodeOfferingType': 'Regular'|'Upgradable' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ReservedNodes** *(list) --* The list of "ReservedNode" objects. * *(dict) --* Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. * **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 charges you for this reserved node. * **UsagePrice** *(float) --* The hourly rate Amazon Redshift charges 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. * retired-The reserved node is no longer available. * exchanging-The owner is exchanging the reserved node for another reserved node. * **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. * **ReservedNodeOfferingType** *(string) --* * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeDefaultClusterParameters DescribeDefaultClusterParameters ******************************** class Redshift.Paginator.DescribeDefaultClusterParameters paginator = client.get_paginator('describe_default_cluster_parameters') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_default_cluster_parameters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ParameterGroupFamily='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ParameterGroupFamily** (*string*) -- **[REQUIRED]** The name of the cluster parameter group family. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DefaultClusterParameters': { 'ParameterGroupFamily': 'string', 'Marker': 'string', 'Parameters': [ { 'ParameterName': 'string', 'ParameterValue': 'string', 'Description': 'string', 'Source': 'string', 'DataType': 'string', 'AllowedValues': 'string', 'ApplyType': 'static'|'dynamic', 'IsModifiable': True|False, 'MinimumEngineVersion': 'string' }, ] }, 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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. If "ParameterName" is "wlm_json_configuration", then the maximum size of "ParameterValue" is 8000 characters. * **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. * **ApplyType** *(string) --* Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the *Amazon Redshift Cluster Management Guide*. * **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. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / GetReservedNodeExchangeConfigurationOptions GetReservedNodeExchangeConfigurationOptions ******************************************* class Redshift.Paginator.GetReservedNodeExchangeConfigurationOptions paginator = client.get_paginator('get_reserved_node_exchange_configuration_options') paginate(**kwargs) Creates an iterator that will paginate through responses from " Redshift.Client.get_reserved_node_exchange_configuration_option s()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ActionType='restore-cluster'|'resize-cluster', ClusterIdentifier='string', SnapshotIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ActionType** (*string*) -- **[REQUIRED]** The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize. * **ClusterIdentifier** (*string*) -- The identifier for the cluster that is the source for a reserved-node exchange. * **SnapshotIdentifier** (*string*) -- The identifier for the snapshot that is the source for the reserved-node exchange. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ReservedNodeConfigurationOptionList': [ { 'SourceReservedNode': { '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' }, ], 'ReservedNodeOfferingType': 'Regular'|'Upgradable' }, 'TargetReservedNodeCount': 123, 'TargetReservedNodeOffering': { 'ReservedNodeOfferingId': 'string', 'NodeType': 'string', 'Duration': 123, 'FixedPrice': 123.0, 'UsagePrice': 123.0, 'CurrencyCode': 'string', 'OfferingType': 'string', 'RecurringCharges': [ { 'RecurringChargeAmount': 123.0, 'RecurringChargeFrequency': 'string' }, ], 'ReservedNodeOfferingType': 'Regular'|'Upgradable' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ReservedNodeConfigurationOptionList** *(list) --* the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node. Details include the node type, the price, the node count, and the offering type. * *(dict) --* Details for a reserved-node exchange. Examples include the node type for a reserved node, the price for a node, the node's state, and other details. * **SourceReservedNode** *(dict) --* Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. * **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 charges you for this reserved node. * **UsagePrice** *(float) --* The hourly rate Amazon Redshift charges 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. * retired-The reserved node is no longer available. * exchanging-The owner is exchanging the reserved node for another reserved node. * **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. * **ReservedNodeOfferingType** *(string) --* * **TargetReservedNodeCount** *(integer) --* The target reserved-node count. * **TargetReservedNodeOffering** *(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. * **ReservedNodeOfferingType** *(string) --* * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeClusterVersions DescribeClusterVersions *********************** class Redshift.Paginator.DescribeClusterVersions paginator = client.get_paginator('describe_cluster_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_cluster_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterVersion='string', ClusterParameterGroupFamily='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterVersion** (*string*) -- The specific cluster version to return. Example: "1.0" * **ClusterParameterGroupFamily** (*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 * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ClusterVersions': [ { 'ClusterVersion': 'string', 'ClusterParameterGroupFamily': 'string', 'Description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the output from the DescribeClusterVersions action. * **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. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeClusterSubnetGroups DescribeClusterSubnetGroups *************************** class Redshift.Paginator.DescribeClusterSubnetGroups paginator = client.get_paginator('describe_cluster_subnet_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_cluster_subnet_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterSubnetGroupName='string', TagKeys=[ 'string', ], TagValues=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterSubnetGroupName** (*string*) -- The name of the cluster subnet group for which information is requested. * **TagKeys** (*list*) -- A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called "owner" and "environment". If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them. * *(string) --* * **TagValues** (*list*) -- A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called "admin" and "test". If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ClusterSubnetGroups': [ { 'ClusterSubnetGroupName': 'string', 'Description': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string', 'SupportedPlatforms': [ { 'Name': 'string' }, ] }, 'SubnetStatus': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SupportedClusterIpAddressTypes': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the output from the DescribeClusterSubnetGroups action. * **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) --* * **Name** *(string) --* The name of the availability zone. * **SupportedPlatforms** *(list) --* * *(dict) --* A list of supported platforms for orderable clusters. * **Name** *(string) --* * **SubnetStatus** *(string) --* The status of the subnet. * **Tags** *(list) --* The list of tags for the cluster subnet group. * *(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. * **SupportedClusterIpAddressTypes** *(list) --* The IP address types supported by this cluster subnet group. Possible values are "ipv4" and "dualstack". * *(string) --* * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeScheduledActions DescribeScheduledActions ************************ class Redshift.Paginator.DescribeScheduledActions paginator = client.get_paginator('describe_scheduled_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_scheduled_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( 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', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ScheduledActionName** (*string*) -- The name of the scheduled action to retrieve. * **TargetActionType** (*string*) -- The type of the scheduled actions to retrieve. * **StartTime** (*datetime*) -- The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved. * **EndTime** (*datetime*) -- The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved. * **Active** (*boolean*) -- If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. * **Filters** (*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) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ScheduledActions': [ { 'ScheduledActionName': 'string', 'TargetAction': { 'ResizeCluster': { 'ClusterIdentifier': 'string', 'ClusterType': 'string', 'NodeType': 'string', 'NumberOfNodes': 123, 'Classic': True|False, 'ReservedNodeId': 'string', 'TargetReservedNodeOfferingId': 'string' }, '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) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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\":\"ra3.4xlarge\", \"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. If not specified, the cluster's current number of nodes is used. * **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. * **ReservedNodeId** *(string) --* The identifier of the reserved node. * **TargetReservedNodeOfferingId** *(string) --* The identifier of the target reserved node offering. * **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. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeClusterDbRevisions DescribeClusterDbRevisions ************************** class Redshift.Paginator.DescribeClusterDbRevisions paginator = client.get_paginator('describe_cluster_db_revisions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_cluster_db_revisions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterIdentifier** (*string*) -- A unique identifier for a cluster whose "ClusterDbRevisions" you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ClusterDbRevisions': [ { 'ClusterIdentifier': 'string', 'CurrentDatabaseRevision': 'string', 'DatabaseRevisionReleaseDate': datetime(2015, 1, 1), 'RevisionTargets': [ { 'DatabaseRevision': 'string', 'Description': 'string', 'DatabaseRevisionReleaseDate': datetime(2015, 1, 1) }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ClusterDbRevisions** *(list) --* A list of revisions. * *(dict) --* Describes a "ClusterDbRevision". * **ClusterIdentifier** *(string) --* The unique identifier of the cluster. * **CurrentDatabaseRevision** *(string) --* A string representing the current cluster version. * **DatabaseRevisionReleaseDate** *(datetime) --* The date on which the database revision was released. * **RevisionTargets** *(list) --* A list of "RevisionTarget" objects, where each object describes the database revision that a cluster can be updated to. * *(dict) --* Describes a "RevisionTarget". * **DatabaseRevision** *(string) --* A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision. * **Description** *(string) --* A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision. * **DatabaseRevisionReleaseDate** *(datetime) --* The date on which the database revision was released. * **NextToken** *(string) --* A token to resume pagination. Redshift / Paginator / DescribeClusters DescribeClusters **************** class Redshift.Paginator.DescribeClusters paginator = client.get_paginator('describe_clusters') paginate(**kwargs) Creates an iterator that will paginate through responses from "Redshift.Client.describe_clusters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterIdentifier='string', TagKeys=[ 'string', ], TagValues=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterIdentifier** (*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. * **TagKeys** (*list*) -- A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called "owner" and "environment". If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. * *(string) --* * **TagValues** (*list*) -- A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called "admin" and "test". If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Clusters': [ { 'ClusterIdentifier': 'string', 'NodeType': 'string', 'ClusterStatus': 'string', 'ClusterAvailabilityStatus': 'string', 'ModifyStatus': 'string', 'MasterUsername': 'string', 'DBName': 'string', 'Endpoint': { 'Address': 'string', 'Port': 123, 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcId': 'string', 'NetworkInterfaces': [ { 'NetworkInterfaceId': 'string', 'SubnetId': 'string', 'PrivateIpAddress': 'string', 'AvailabilityZone': 'string', 'Ipv6Address': 'string' }, ] }, ] }, '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 }, 'AvailabilityZoneRelocationStatus': 'string', 'ClusterNamespaceArn': 'string', 'TotalStorageCapacityInMegaBytes': 123, 'AquaConfiguration': { 'AquaStatus': 'enabled'|'disabled'|'applying', 'AquaConfigurationStatus': 'enabled'|'disabled'|'auto' }, 'DefaultIamRoleArn': 'string', 'ReservedNodeExchangeStatus': { 'ReservedNodeExchangeRequestId': 'string', 'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED', 'RequestTime': datetime(2015, 1, 1), 'SourceReservedNodeId': 'string', 'SourceReservedNodeType': 'string', 'SourceReservedNodeCount': 123, 'TargetReservedNodeOfferingId': 'string', 'TargetReservedNodeType': 'string', 'TargetReservedNodeCount': 123 }, 'CustomDomainName': 'string', 'CustomDomainCertificateArn': 'string', 'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1), 'MasterPasswordSecretArn': 'string', 'MasterPasswordSecretKmsKeyId': 'string', 'IpAddressType': 'string', 'MultiAZ': 'string', 'MultiAZSecondary': { 'AvailabilityZone': 'string', 'ClusterNodes': [ { 'NodeRole': 'string', 'PrivateIPAddress': 'string', 'PublicIPAddress': 'string' }, ] } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the output from the DescribeClusters action. * **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 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 admin 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 >>``<>``<>``<>``<>``<>``<>``<>``<>``<>``<>``<>``<>``<>``<>*<<)" or "rate(12 hours)". * *(string) --* Return type: dict Returns: **Response Syntax** { 'ScheduleDefinitions': [ 'string', ], 'ScheduleIdentifier': 'string', 'ScheduleDescription': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'NextInvocations': [ datetime(2015, 1, 1), ], 'AssociatedClusterCount': 123, 'AssociatedClusters': [ { 'ClusterIdentifier': 'string', 'ScheduleAssociationState': 'MODIFYING'|'ACTIVE'|'FAILED' }, ] } **Response Structure** * *(dict) --* Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates. * **ScheduleDefinitions** *(list) --* A list of ScheduleDefinitions. * *(string) --* * **ScheduleIdentifier** *(string) --* A unique identifier for the schedule. * **ScheduleDescription** *(string) --* The description of the schedule. * **Tags** *(list) --* An optional set of tags describing the schedule. * *(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. * **NextInvocations** *(list) --* * *(datetime) --* * **AssociatedClusterCount** *(integer) --* The number of clusters associated with the schedule. * **AssociatedClusters** *(list) --* A list of clusters associated with the schedule. A maximum of 100 clusters is returned. * *(dict) --* * **ClusterIdentifier** *(string) --* * **ScheduleAssociationState** *(string) --* **Exceptions** * "Redshift.Client.exceptions.InvalidScheduleFault" * "Redshift.Client.exceptions.SnapshotScheduleNotFoundFault" * "Redshift.Client.exceptions.SnapshotScheduleUpdateInProgressFaul t" Redshift / Client / get_reserved_node_exchange_configuration_options get_reserved_node_exchange_configuration_options ************************************************ Redshift.Client.get_reserved_node_exchange_configuration_options(**kwargs) Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type. See also: AWS API Documentation **Request Syntax** response = client.get_reserved_node_exchange_configuration_options( ActionType='restore-cluster'|'resize-cluster', ClusterIdentifier='string', SnapshotIdentifier='string', MaxRecords=123, Marker='string' ) Parameters: * **ActionType** (*string*) -- **[REQUIRED]** The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize. * **ClusterIdentifier** (*string*) -- The identifier for the cluster that is the source for a reserved-node exchange. * **SnapshotIdentifier** (*string*) -- The identifier for the snapshot that is the source for the reserved-node exchange. * **MaxRecords** (*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. * **Marker** (*string*) -- An optional pagination token provided by a previous "GetReservedNodeExchangeConfigurationOptions" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the "MaxRecords" parameter. You can retrieve the next set of response records by providing the returned marker value in the "Marker" parameter and retrying the request. Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'ReservedNodeConfigurationOptionList': [ { 'SourceReservedNode': { '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' }, ], 'ReservedNodeOfferingType': 'Regular'|'Upgradable' }, 'TargetReservedNodeCount': 123, 'TargetReservedNodeOffering': { 'ReservedNodeOfferingId': 'string', 'NodeType': 'string', 'Duration': 123, 'FixedPrice': 123.0, 'UsagePrice': 123.0, 'CurrencyCode': 'string', 'OfferingType': 'string', 'RecurringCharges': [ { 'RecurringChargeAmount': 123.0, 'RecurringChargeFrequency': 'string' }, ], 'ReservedNodeOfferingType': 'Regular'|'Upgradable' } }, ] } **Response Structure** * *(dict) --* * **Marker** *(string) --* A pagination token provided by a previous "GetReservedNodeExchangeConfigurationOptions" request. * **ReservedNodeConfigurationOptionList** *(list) --* the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node. Details include the node type, the price, the node count, and the offering type. * *(dict) --* Details for a reserved-node exchange. Examples include the node type for a reserved node, the price for a node, the node's state, and other details. * **SourceReservedNode** *(dict) --* Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. * **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 charges you for this reserved node. * **UsagePrice** *(float) --* The hourly rate Amazon Redshift charges 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. * retired-The reserved node is no longer available. * exchanging-The owner is exchanging the reserved node for another reserved node. * **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. * **ReservedNodeOfferingType** *(string) --* * **TargetReservedNodeCount** *(integer) --* The target reserved-node count. * **TargetReservedNodeOffering** *(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. * **ReservedNodeOfferingType** *(string) --* **Exceptions** * "Redshift.Client.exceptions.ReservedNodeNotFoundFault" * "Redshift.Client.exceptions.InvalidReservedNodeStateFault" * "Redshift.Client.exceptions.ReservedNodeAlreadyMigratedFault" * "Redshift.Client.exceptions.ReservedNodeOfferingNotFoundFault" * "Redshift.Client.exceptions.UnsupportedOperationFault" * "Redshift.Client.exceptions.DependentServiceUnavailableFault" * "Redshift.Client.exceptions.ClusterNotFoundFault" * "Redshift.Client.exceptions.ClusterSnapshotNotFoundFault" Redshift / Client / modify_event_subscription modify_event_subscription ************************* Redshift.Client.modify_event_subscription(**kwargs) Modifies an existing Amazon Redshift event notification subscription. See also: AWS API Documentation **Request Syntax** response = client.modify_event_subscription( SubscriptionName='string', SnsTopicArn='string', SourceType='string', SourceIds=[ 'string', ], EventCategories=[ 'string', ], Severity='string', Enabled=True|False ) Parameters: * **SubscriptionName** (*string*) -- **[REQUIRED]** The name of the modified Amazon Redshift event notification subscription. * **SnsTopicArn** (*string*) -- The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription. * **SourceType** (*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 Amazon Web Services account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster- security-group, cluster-snapshot, and scheduled-action. * **SourceIds** (*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) --* * **EventCategories** (*list*) -- Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: configuration, management, monitoring, security, pending * *(string) --* * **Severity** (*string*) -- Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO * **Enabled** (*boolean*) -- A Boolean value indicating if the subscription is enabled. "true" indicates the subscription is enabled Return type: dict Returns: **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, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **EventSubscription** *(dict) --* Describes event subscriptions. * **CustomerAwsId** *(string) --* The Amazon Web Services 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 by the Amazon Redshift event notification, such as cluster, cluster- snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action. * **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, Pending * *(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 that the subscription is enabled. * **Tags** *(list) --* The list of tags for the event subscription. * *(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. **Exceptions** * "Redshift.Client.exceptions.SubscriptionNotFoundFault" * "Redshift.Client.exceptions.SNSInvalidTopicFault" * "Redshift.Client.exceptions.SNSNoAuthorizationFault" * "Redshift.Client.exceptions.SNSTopicArnNotFoundFault" * "Redshift.Client.exceptions.SubscriptionEventIdNotFoundFault" * "Redshift.Client.exceptions.SubscriptionCategoryNotFoundFault" * "Redshift.Client.exceptions.SubscriptionSeverityNotFoundFault" * "Redshift.Client.exceptions.SourceNotFoundFault" * "Redshift.Client.exceptions.InvalidSubscriptionStateFault" Redshift / Client / create_scheduled_action create_scheduled_action *********************** Redshift.Client.create_scheduled_action(**kwargs) 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** response = client.create_scheduled_action( ScheduledActionName='string', TargetAction={ 'ResizeCluster': { 'ClusterIdentifier': 'string', 'ClusterType': 'string', 'NodeType': 'string', 'NumberOfNodes': 123, 'Classic': True|False, 'ReservedNodeId': 'string', 'TargetReservedNodeOfferingId': 'string' }, '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 ) Parameters: * **ScheduledActionName** (*string*) -- **[REQUIRED]** The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction. * **TargetAction** (*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. If not specified, the cluster's current number of nodes is used. * **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. * **ReservedNodeId** *(string) --* The identifier of the reserved node. * **TargetReservedNodeOfferingId** *(string) --* The identifier of the target reserved node offering. * **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. * **Schedule** (*string*) -- **[REQUIRED]** The schedule in "at( )" or "cron( )" format. For more information about this parameter, see ScheduledAction. * **IamRole** (*string*) -- **[REQUIRED]** The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction. * **ScheduledActionDescription** (*string*) -- The description of the scheduled action. * **StartTime** (*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. * **EndTime** (*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. * **Enable** (*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. Return type: dict Returns: **Response Syntax** { 'ScheduledActionName': 'string', 'TargetAction': { 'ResizeCluster': { 'ClusterIdentifier': 'string', 'ClusterType': 'string', 'NodeType': 'string', 'NumberOfNodes': 123, 'Classic': True|False, 'ReservedNodeId': 'string', 'TargetReservedNodeOfferingId': 'string' }, '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\":\"ra3.4xlarge\",\"Clust erIdentifier\":\"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. If not specified, the cluster's current number of nodes is used. * **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. * **ReservedNodeId** *(string) --* The identifier of the reserved node. * **TargetReservedNodeOfferingId** *(string) --* The identifier of the target reserved node offering. * **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. **Exceptions** * "Redshift.Client.exceptions.ClusterNotFoundFault" * "Redshift.Client.exceptions.ScheduledActionAlreadyExistsFault" * "Redshift.Client.exceptions.ScheduledActionQuotaExceededFault" * "Redshift.Client.exceptions.ScheduledActionTypeUnsupportedFault" * "Redshift.Client.exceptions.InvalidScheduleFault" * "Redshift.Client.exceptions.InvalidScheduledActionFault" * "Redshift.Client.exceptions.UnauthorizedOperation" * "Redshift.Client.exceptions.UnsupportedOperationFault" Redshift / Client / reset_cluster_parameter_group reset_cluster_parameter_group ***************************** Redshift.Client.reset_cluster_parameter_group(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.reset_cluster_parameter_group( ParameterGroupName='string', ResetAllParameters=True|False, Parameters=[ { 'ParameterName': 'string', 'ParameterValue': 'string', 'Description': 'string', 'Source': 'string', 'DataType': 'string', 'AllowedValues': 'string', 'ApplyType': 'static'|'dynamic', 'IsModifiable': True|False, 'MinimumEngineVersion': 'string' }, ] ) Parameters: * **ParameterGroupName** (*string*) -- **[REQUIRED]** The name of the cluster parameter group to be reset. * **ResetAllParameters** (*boolean*) -- If "true", all parameters in the specified parameter group will be reset to their default values. Default: "true" * **Parameters** (*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. If "ParameterName" is "wlm_json_configuration", then the maximum size of "ParameterValue" is 8000 characters. * **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. * **ApplyType** *(string) --* Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the *Amazon Redshift Cluster Management Guide*. * **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. Return type: dict Returns: **Response Syntax** { 'ParameterGroupName': 'string', 'ParameterGroupStatus': 'string' } **Response Structure** * *(dict) --* * **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. **Exceptions** * "Redshift.Client.exceptions.InvalidClusterParameterGroupStateFau lt" * "Redshift.Client.exceptions.ClusterParameterGroupNotFoundFault" Redshift / Client / create_hsm_client_certificate create_hsm_client_certificate ***************************** Redshift.Client.create_hsm_client_certificate(**kwargs) Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the *Amazon Redshift Cluster Management Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_hsm_client_certificate( HsmClientCertificateIdentifier='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **HsmClientCertificateIdentifier** (*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. * **Tags** (*list*) -- A list of tag instances. * *(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. Return type: dict Returns: **Response Syntax** { 'HsmClientCertificate': { 'HsmClientCertificateIdentifier': 'string', 'HsmClientCertificatePublicKey': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **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. * **Tags** *(list) --* The list of tags for the HSM client certificate. * *(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. **Exceptions** * "Redshift.Client.exceptions.HsmClientCertificateAlreadyExistsFau lt" * "Redshift.Client.exceptions.HsmClientCertificateQuotaExceededFau lt" * "Redshift.Client.exceptions.TagLimitExceededFault" * "Redshift.Client.exceptions.InvalidTagFault" Redshift / Client / purchase_reserved_node_offering purchase_reserved_node_offering ******************************* Redshift.Client.purchase_reserved_node_offering(**kwargs) Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the *Amazon Redshift Cluster Management Guide*. See also: AWS API Documentation **Request Syntax** response = client.purchase_reserved_node_offering( ReservedNodeOfferingId='string', NodeCount=123 ) Parameters: * **ReservedNodeOfferingId** (*string*) -- **[REQUIRED]** The unique identifier of the reserved node offering you want to purchase. * **NodeCount** (*integer*) -- The number of reserved nodes that you want to purchase. Default: "1" Return type: dict Returns: **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' }, ], 'ReservedNodeOfferingType': 'Regular'|'Upgradable' } } **Response Structure** * *(dict) --* * **ReservedNode** *(dict) --* Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. * **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 charges you for this reserved node. * **UsagePrice** *(float) --* The hourly rate Amazon Redshift charges 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. * retired-The reserved node is no longer available. * exchanging-The owner is exchanging the reserved node for another reserved node. * **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. * **ReservedNodeOfferingType** *(string) --* **Exceptions** * "Redshift.Client.exceptions.ReservedNodeOfferingNotFoundFault" * "Redshift.Client.exceptions.ReservedNodeAlreadyExistsFault" * "Redshift.Client.exceptions.ReservedNodeQuotaExceededFault" * "Redshift.Client.exceptions.UnsupportedOperationFault" Redshift / Client / modify_aqua_configuration modify_aqua_configuration ************************* Redshift.Client.modify_aqua_configuration(**kwargs) This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). See also: AWS API Documentation **Request Syntax** response = client.modify_aqua_configuration( ClusterIdentifier='string', AquaConfigurationStatus='enabled'|'disabled'|'auto' ) Parameters: * **ClusterIdentifier** (*string*) -- **[REQUIRED]** The identifier of the cluster to be modified. * **AquaConfigurationStatus** (*string*) -- This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). Return type: dict Returns: **Response Syntax** { 'AquaConfiguration': { 'AquaStatus': 'enabled'|'disabled'|'applying', 'AquaConfigurationStatus': 'enabled'|'disabled'|'auto' } } **Response Structure** * *(dict) --* * **AquaConfiguration** *(dict) --* This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). * **AquaStatus** *(string) --* This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). * **AquaConfigurationStatus** *(string) --* This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). **Exceptions** * "Redshift.Client.exceptions.ClusterNotFoundFault" * "Redshift.Client.exceptions.InvalidClusterStateFault" * "Redshift.Client.exceptions.UnsupportedOperationFault" Redshift / Client / batch_modify_cluster_snapshots batch_modify_cluster_snapshots ****************************** Redshift.Client.batch_modify_cluster_snapshots(**kwargs) Modifies the settings for a set of cluster snapshots. See also: AWS API Documentation **Request Syntax** response = client.batch_modify_cluster_snapshots( SnapshotIdentifierList=[ 'string', ], ManualSnapshotRetentionPeriod=123, Force=True|False ) Parameters: * **SnapshotIdentifierList** (*list*) -- **[REQUIRED]** A list of snapshot identifiers you want to modify. * *(string) --* * **ManualSnapshotRetentionPeriod** (*integer*) -- The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely. The number must be either -1 or an integer between 1 and 3,653. If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option. * **Force** (*boolean*) -- A boolean value indicating whether to override an exception if the retention period has passed. Return type: dict Returns: **Response Syntax** { 'Resources': [ 'string', ], 'Errors': [ { 'SnapshotIdentifier': 'string', 'SnapshotClusterIdentifier': 'string', 'FailureCode': 'string', 'FailureReason': 'string' }, ] } **Response Structure** * *(dict) --* * **Resources** *(list) --* A list of the snapshots that were modified. * *(string) --* * **Errors** *(list) --* A list of any errors returned. * *(dict) --* Describes the errors returned by a snapshot. * **SnapshotIdentifier** *(string) --* A unique identifier for the snapshot returning the error. * **SnapshotClusterIdentifier** *(string) --* A unique identifier for the cluster. * **FailureCode** *(string) --* The failure code for the error. * **FailureReason** *(string) --* The text message describing the error. **Exceptions** * "Redshift.Client.exceptions.InvalidRetentionPeriodFault" * "Redshift.Client.exceptions.BatchModifyClusterSnapshotsLimitExce ededFault" Redshift / Client / describe_scheduled_actions describe_scheduled_actions ************************** Redshift.Client.describe_scheduled_actions(**kwargs) Describes properties of scheduled actions. See also: AWS API Documentation **Request Syntax** response = 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 ) Parameters: * **ScheduledActionName** (*string*) -- The name of the scheduled action to retrieve. * **TargetActionType** (*string*) -- The type of the scheduled actions to retrieve. * **StartTime** (*datetime*) -- The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved. * **EndTime** (*datetime*) -- The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved. * **Active** (*boolean*) -- If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. * **Filters** (*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) --* * **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", Amazon Web Services 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. * **MaxRecords** (*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. Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'ScheduledActions': [ { 'ScheduledActionName': 'string', 'TargetAction': { 'ResizeCluster': { 'ClusterIdentifier': 'string', 'ClusterType': 'string', 'NodeType': 'string', 'NumberOfNodes': 123, 'Classic': True|False, 'ReservedNodeId': 'string', 'TargetReservedNodeOfferingId': 'string' }, '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", Amazon Web Services 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\":\"ra3.4xlarge\",\"C lusterIdentifier\":\"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. If not specified, the cluster's current number of nodes is used. * **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. * **ReservedNodeId** *(string) --* The identifier of the reserved node. * **TargetReservedNodeOfferingId** *(string) --* The identifier of the target reserved node offering. * **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. **Exceptions** * "Redshift.Client.exceptions.ScheduledActionNotFoundFault" * "Redshift.Client.exceptions.UnauthorizedOperation" Redshift / Client / delete_snapshot_copy_grant delete_snapshot_copy_grant ************************** Redshift.Client.delete_snapshot_copy_grant(**kwargs) Deletes the specified snapshot copy grant. See also: AWS API Documentation **Request Syntax** response = client.delete_snapshot_copy_grant( SnapshotCopyGrantName='string' ) Parameters: **SnapshotCopyGrantName** (*string*) -- **[REQUIRED]** The name of the snapshot copy grant to delete. Returns: None **Exceptions** * "Redshift.Client.exceptions.InvalidSnapshotCopyGrantStateFault" * "Redshift.Client.exceptions.SnapshotCopyGrantNotFoundFault" Redshift / Client / describe_resize describe_resize *************** Redshift.Client.describe_resize(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.describe_resize( ClusterIdentifier='string' ) Parameters: **ClusterIdentifier** (*string*) -- **[REQUIRED]** The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. By default, resize operations for all clusters defined for an Amazon Web Services account are returned. Return type: dict Returns: **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, 'ResizeType': 'string', 'Message': 'string', 'TargetEncryptionType': 'string', 'DataTransferProgressPercent': 123.0 } **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" | "CANCELLING" * **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. * **ResizeType** *(string) --* An enum with possible values of "ClassicResize" and "ElasticResize". These values describe the type of resize operation being performed. * **Message** *(string) --* An optional string to provide additional details about the resize action. * **TargetEncryptionType** *(string) --* The type of encryption for the cluster after the resize is complete. Possible values are "KMS" and "None". * **DataTransferProgressPercent** *(float) --* The percent of data transferred from source cluster to target cluster. **Exceptions** * "Redshift.Client.exceptions.ClusterNotFoundFault" * "Redshift.Client.exceptions.ResizeNotFoundFault" * "Redshift.Client.exceptions.UnsupportedOperationFault" Redshift / Client / describe_usage_limits describe_usage_limits ********************* Redshift.Client.describe_usage_limits(**kwargs) Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters: * If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned. * If usage limit identifier is provided, then the corresponding usage limit object is returned. * If cluster identifier is provided, then all usage limit objects for the specified cluster are returned. * If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned. See also: AWS API Documentation **Request Syntax** response = client.describe_usage_limits( UsageLimitId='string', ClusterIdentifier='string', FeatureType='spectrum'|'concurrency-scaling'|'cross-region-datasharing', MaxRecords=123, Marker='string', TagKeys=[ 'string', ], TagValues=[ 'string', ] ) Parameters: * **UsageLimitId** (*string*) -- The identifier of the usage limit to describe. * **ClusterIdentifier** (*string*) -- The identifier of the cluster for which you want to describe usage limits. * **FeatureType** (*string*) -- The feature type for which you want to describe usage limits. * **MaxRecords** (*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. * **Marker** (*string*) -- An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in "MaxRecords", Amazon Web Services 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. * **TagKeys** (*list*) -- A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called "owner" and "environment". If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them. * *(string) --* * **TagValues** (*list*) -- A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called "admin" and "test". If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them. * *(string) --* Return type: dict Returns: **Response Syntax** { 'UsageLimits': [ { 'UsageLimitId': 'string', 'ClusterIdentifier': 'string', 'FeatureType': 'spectrum'|'concurrency-scaling'|'cross-region-datasharing', 'LimitType': 'time'|'data-scanned', 'Amount': 123, 'Period': 'daily'|'weekly'|'monthly', 'BreachAction': 'log'|'emit-metric'|'disable', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Marker': 'string' } **Response Structure** * *(dict) --* * **UsageLimits** *(list) --* Contains the output from the DescribeUsageLimits action. * *(dict) --* Describes a usage limit object for a cluster. * **UsageLimitId** *(string) --* The identifier of the usage limit. * **ClusterIdentifier** *(string) --* The identifier of the cluster with a usage limit. * **FeatureType** *(string) --* The Amazon Redshift feature to which the limit applies. * **LimitType** *(string) --* The type of limit. Depending on the feature type, this can be based on a time duration or data size. * **Amount** *(integer) --* The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). * **Period** *(string) --* The time period that the amount applies to. A "weekly" period begins on Sunday. The default is "monthly". * **BreachAction** *(string) --* The action that Amazon Redshift takes when the limit is reached. Possible values are: * **log** - To log an event in a system table. The default is log. * **emit-metric** - To emit CloudWatch metrics. * **disable** - To disable the feature until the next usage period begins. * **Tags** *(list) --* A list of tag instances. * *(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. * **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. **Exceptions** * "Redshift.Client.exceptions.ClusterNotFoundFault" * "Redshift.Client.exceptions.UnsupportedOperationFault" Redshift / Client / get_cluster_credentials get_cluster_credentials *********************** Redshift.Client.get_cluster_credentials(**kwargs) Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with "IAM:" if "AutoCreate" is "False" or "IAMA:" if "AutoCreate" is "True". You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide. The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide. If the "DbGroups" parameter is specified, the IAM policy must allow the "redshift:JoinGroup" action with access to the listed "dbgroups". In addition, if the "AutoCreate" parameter is set to "True", then the policy must include the "redshift:CreateClusterUser" permission. If the "DbName" parameter is specified, the IAM policy must allow access to the resource "dbname" for the specified database name. See also: AWS API Documentation **Request Syntax** response = client.get_cluster_credentials( DbUser='string', DbName='string', ClusterIdentifier='string', DurationSeconds=123, AutoCreate=True|False, DbGroups=[ 'string', ], CustomDomainName='string' ) Parameters: * **DbUser** (*string*) -- **[REQUIRED]** The name of a database user. If a user name matching "DbUser" exists in the database, the temporary user credentials have the same permissions as the existing user. If "DbUser" doesn't exist in the database and "Autocreate" is "True", a new user is created using the value for "DbUser" with PUBLIC permissions. If a database user matching the value for "DbUser" doesn't exist and "Autocreate" is "False", then the command succeeds but the connection attempt will fail because the user doesn't exist in the database. For more information, see CREATE USER in the Amazon Redshift Database Developer Guide. Constraints: * Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be "PUBLIC". * Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * First character must be a letter. * Must not contain a colon ( : ) or slash ( / ). * Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. * **DbName** (*string*) -- The name of a database that "DbUser" is authorized to log on to. If "DbName" is not specified, "DbUser" can log on to any existing database. Constraints: * Must be 1 to 64 alphanumeric characters or hyphens * Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * First character must be a letter. * Must not contain a colon ( : ) or slash ( / ). * Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. * **ClusterIdentifier** (*string*) -- The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive. * **DurationSeconds** (*integer*) -- The number of seconds until the returned temporary password expires. Constraint: minimum 900, maximum 3600. Default: 900 * **AutoCreate** (*boolean*) -- Create a database user with the name specified for the user named in "DbUser" if one does not exist. * **DbGroups** (*list*) -- A list of the names of existing database groups that the user named in "DbUser" will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name constraints * Must be 1 to 64 alphanumeric characters or hyphens * Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * First character must be a letter. * Must not contain a colon ( : ) or slash ( / ). * Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. * *(string) --* * **CustomDomainName** (*string*) -- The custom domain name for the cluster credentials. Return type: dict Returns: **Response Syntax** { 'DbUser': 'string', 'DbPassword': 'string', 'Expiration': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* Temporary credentials with authorization to log on to an Amazon Redshift database. * **DbUser** *(string) --* A database user name that is authorized to log on to the database "DbName" using the password "DbPassword". If the specified DbUser exists in the database, the new user name has the same database permissions as the the user named in DbUser. By default, the user is added to PUBLIC. If the "DbGroups" parameter is specifed, "DbUser" is added to the listed groups for any sessions created using these credentials. * **DbPassword** *(string) --* A temporary password that authorizes the user name returned by "DbUser" to log on to the database "DbName". * **Expiration** *(datetime) --* The date and time the password in "DbPassword" expires. **Exceptions** * "Redshift.Client.exceptions.ClusterNotFoundFault" * "Redshift.Client.exceptions.UnsupportedOperationFault" Redshift / Client / create_snapshot_schedule create_snapshot_schedule ************************ Redshift.Client.create_snapshot_schedule(**kwargs) Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule. See also: AWS API Documentation **Request Syntax** response = client.create_snapshot_schedule( ScheduleDefinitions=[ 'string', ], ScheduleIdentifier='string', ScheduleDescription='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], DryRun=True|False, NextInvocations=123 ) Parameters: * **ScheduleDefinitions** (*list*) -- The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 >>*<<)" or "rate(12 hours)". * *(string) --* * **ScheduleIdentifier** (*string*) -- A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier. * **ScheduleDescription** (*string*) -- The description of the snapshot schedule. * **Tags** (*list*) -- An optional set of tags you can use to search for the schedule. * *(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. * **DryRun** (*boolean*) * **NextInvocations** (*integer*) Return type: dict Returns: **Response Syntax** { 'ScheduleDefinitions': [ 'string', ], 'ScheduleIdentifier': 'string', 'ScheduleDescription': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'NextInvocations': [ datetime(2015, 1, 1), ], 'AssociatedClusterCount': 123, 'AssociatedClusters': [ { 'ClusterIdentifier': 'string', 'ScheduleAssociationState': 'MODIFYING'|'ACTIVE'|'FAILED' }, ] } **Response Structure** * *(dict) --* Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates. * **ScheduleDefinitions** *(list) --* A list of ScheduleDefinitions. * *(string) --* * **ScheduleIdentifier** *(string) --* A unique identifier for the schedule. * **ScheduleDescription** *(string) --* The description of the schedule. * **Tags** *(list) --* An optional set of tags describing the schedule. * *(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. * **NextInvocations** *(list) --* * *(datetime) --* * **AssociatedClusterCount** *(integer) --* The number of clusters associated with the schedule. * **AssociatedClusters** *(list) --* A list of clusters associated with the schedule. A maximum of 100 clusters is returned. * *(dict) --* * **ClusterIdentifier** *(string) --* * **ScheduleAssociationState** *(string) --* **Exceptions** * "Redshift.Client.exceptions.SnapshotScheduleAlreadyExistsFault" * "Redshift.Client.exceptions.InvalidScheduleFault" * "Redshift.Client.exceptions.SnapshotScheduleQuotaExceededFault" * "Redshift.Client.exceptions.TagLimitExceededFault" * "Redshift.Client.exceptions.ScheduleDefinitionTypeUnsupportedFau lt" * "Redshift.Client.exceptions.InvalidTagFault" Redshift / Client / describe_data_shares describe_data_shares ******************** Redshift.Client.describe_data_shares(**kwargs) Shows the status of any inbound or outbound datashares available in the specified account. See also: AWS API Documentation **Request Syntax** response = client.describe_data_shares( DataShareArn='string', MaxRecords=123, Marker='string' ) Parameters: * **DataShareArn** (*string*) -- The Amazon resource name (ARN) of the datashare to describe details of. * **MaxRecords** (*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. * **Marker** (*string*) -- An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in "MaxRecords", Amazon Web Services 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. Return type: dict Returns: **Response Syntax** { 'DataShares': [ { 'DataShareArn': 'string', 'ProducerArn': 'string', 'AllowPubliclyAccessibleConsumers': True|False, 'DataShareAssociations': [ { 'ConsumerIdentifier': 'string', 'Status': 'ACTIVE'|'PENDING_AUTHORIZATION'|'AUTHORIZED'|'DEAUTHORIZED'|'REJECTED'|'AVAILABLE', 'ConsumerRegion': 'string', 'CreatedDate': datetime(2015, 1, 1), 'StatusChangeDate': datetime(2015, 1, 1), 'ProducerAllowedWrites': True|False, 'ConsumerAcceptedWrites': True|False }, ], 'ManagedBy': 'string', 'DataShareType': 'INTERNAL' }, ], 'Marker': 'string' } **Response Structure** * *(dict) --* * **DataShares** *(list) --* The results returned from describing datashares. * *(dict) --* * **DataShareArn** *(string) --* The Amazon Resource Name (ARN) of the datashare that the consumer is to use. * **ProducerArn** *(string) --* The Amazon Resource Name (ARN) of the producer namespace. * **AllowPubliclyAccessibleConsumers** *(boolean) --* A value that specifies whether the datashare can be shared to a publicly accessible cluster. * **DataShareAssociations** *(list) --* A value that specifies when the datashare has an association between producer and data consumers. * *(dict) --* The association of a datashare from a producer account with a data consumer. * **ConsumerIdentifier** *(string) --* The name of the consumer accounts that have an association with a producer datashare. * **Status** *(string) --* The status of the datashare that is associated. * **ConsumerRegion** *(string) --* The Amazon Web Services Region of the consumer accounts that have an association with a producer datashare. * **CreatedDate** *(datetime) --* The creation date of the datashare that is associated. * **StatusChangeDate** *(datetime) --* The status change data of the datashare that is associated. * **ProducerAllowedWrites** *(boolean) --* Specifies whether write operations were allowed during data share authorization. * **ConsumerAcceptedWrites** *(boolean) --* Specifies whether write operations were allowed during data share association. * **ManagedBy** *(string) --* The identifier of a datashare to show its managing entity. * **DataShareType** *(string) --* The type of the datashare created by RegisterNamespace. * **Marker** *(string) --* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in "MaxRecords", Amazon Web Services 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. **Exceptions** * "Redshift.Client.exceptions.InvalidDataShareFault" Redshift / Client / delete_usage_limit delete_usage_limit ****************** Redshift.Client.delete_usage_limit(**kwargs) Deletes a usage limit from a cluster. See also: AWS API Documentation **Request Syntax** response = client.delete_usage_limit( UsageLimitId='string' ) Parameters: **UsageLimitId** (*string*) -- **[REQUIRED]** The identifier of the usage limit to delete. Returns: None **Exceptions** * "Redshift.Client.exceptions.UsageLimitNotFoundFault" * "Redshift.Client.exceptions.UnsupportedOperationFault" Redshift / Client / restore_table_from_cluster_snapshot restore_table_from_cluster_snapshot *********************************** Redshift.Client.restore_table_from_cluster_snapshot(**kwargs) Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use "RestoreTableFromClusterSnapshot" to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call "RestoreTableFromClusterSnapshot". When you have renamed your original table, then you can pass the original name of the table as the "NewTableName" parameter value in the call to "RestoreTableFromClusterSnapshot". This way, you can replace the original table with the table created from the snapshot. You can't use this operation to restore tables with interleaved sort keys. See also: AWS API Documentation **Request Syntax** response = client.restore_table_from_cluster_snapshot( ClusterIdentifier='string', SnapshotIdentifier='string', SourceDatabaseName='string', SourceSchemaName='string', SourceTableName='string', TargetDatabaseName='string', TargetSchemaName='string', NewTableName='string', EnableCaseSensitiveIdentifier=True|False ) Parameters: * **ClusterIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon Redshift cluster to restore the table to. * **SnapshotIdentifier** (*string*) -- **[REQUIRED]** The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the "ClusterIdentifier" parameter. * **SourceDatabaseName** (*string*) -- **[REQUIRED]** The name of the source database that contains the table to restore from. * **SourceSchemaName** (*string*) -- The name of the source schema that contains the table to restore from. If you do not specify a "SourceSchemaName" value, the default is "public". * **SourceTableName** (*string*) -- **[REQUIRED]** The name of the source table to restore from. * **TargetDatabaseName** (*string*) -- The name of the database to restore the table to. * **TargetSchemaName** (*string*) -- The name of the schema to restore the table to. * **NewTableName** (*string*) -- **[REQUIRED]** The name of the table to create as a result of the current request. * **EnableCaseSensitiveIdentifier** (*boolean*) -- Indicates whether name identifiers for database, schema, and table are case sensitive. If "true", the names are case sensitive. If "false" (default), the names are not case sensitive. Return type: dict Returns: **Response Syntax** { 'TableRestoreStatus': { 'TableRestoreRequestId': 'string', 'Status': 'PENDING'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'CANCELED', 'Message': 'string', 'RequestTime': datetime(2015, 1, 1), 'ProgressInMegaBytes': 123, 'TotalDataInMegaBytes': 123, 'ClusterIdentifier': 'string', 'SnapshotIdentifier': 'string', 'SourceDatabaseName': 'string', 'SourceSchemaName': 'string', 'SourceTableName': 'string', 'TargetDatabaseName': 'string', 'TargetSchemaName': 'string', 'NewTableName': 'string' } } **Response Structure** * *(dict) --* * **TableRestoreStatus** *(dict) --* Describes the status of a RestoreTableFromClusterSnapshot operation. * **TableRestoreRequestId** *(string) --* The unique identifier for the table restore request. * **Status** *(string) --* A value that describes the current state of the table restore request. Valid Values: "SUCCEEDED", "FAILED", "CANCELED", "PENDING", "IN_PROGRESS" * **Message** *(string) --* A description of the status of the table restore request. Status values include "SUCCEEDED", "FAILED", "CANCELED", "PENDING", "IN_PROGRESS". * **RequestTime** *(datetime) --* The time that the table restore request was made, in Universal Coordinated Time (UTC). * **ProgressInMegaBytes** *(integer) --* The amount of data restored to the new table so far, in megabytes (MB). * **TotalDataInMegaBytes** *(integer) --* The total amount of data to restore to the new table, in megabytes (MB). * **ClusterIdentifier** *(string) --* The identifier of the Amazon Redshift cluster that the table is being restored to. * **SnapshotIdentifier** *(string) --* The identifier of the snapshot that the table is being restored from. * **SourceDatabaseName** *(string) --* The name of the source database that contains the table being restored. * **SourceSchemaName** *(string) --* The name of the source schema that contains the table being restored. * **SourceTableName** *(string) --* The name of the source table being restored. * **TargetDatabaseName** *(string) --* The name of the database to restore the table to. * **TargetSchemaName** *(string) --* The name of the schema to restore the table to. * **NewTableName** *(string) --* The name of the table to create as a result of the table restore request. **Exceptions** * "Redshift.Client.exceptions.ClusterSnapshotNotFoundFault" * "Redshift.Client.exceptions.InProgressTableRestoreQuotaExceededF ault" * "Redshift.Client.exceptions.InvalidClusterSnapshotStateFault" * "Redshift.Client.exceptions.InvalidTableRestoreArgumentFault" * "Redshift.Client.exceptions.ClusterNotFoundFault" * "Redshift.Client.exceptions.InvalidClusterStateFault" * "Redshift.Client.exceptions.UnsupportedOperationFault" Redshift / Client / describe_cluster_parameters describe_cluster_parameters *************************** Redshift.Client.describe_cluster_parameters(**kwargs) Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. You can specify *source* filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify *source* equal to *user*. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the *Amazon Redshift Cluster Management Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_cluster_parameters( ParameterGroupName='string', Source='string', MaxRecords=123, Marker='string' ) Parameters: * **ParameterGroupName** (*string*) -- **[REQUIRED]** The name of a cluster parameter group for which to return details. * **Source** (*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" * **MaxRecords** (*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. * **Marker** (*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", Amazon Web Services 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. Return type: dict Returns: **Response Syntax** { 'Parameters': [ { 'ParameterName': 'string', 'ParameterValue': 'string', 'Description': 'string', 'Source': 'string', 'DataType': 'string', 'AllowedValues': 'string', 'ApplyType': 'static'|'dynamic', '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. If "ParameterName" is "wlm_json_configuration", then the maximum size of "ParameterValue" is 8000 characters. * **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. * **ApplyType** *(string) --* Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the *Amazon Redshift Cluster Management Guide*. * **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. **Exceptions** * "Redshift.Client.exceptions.ClusterParameterGroupNotFoundFault" Redshift / Client / create_usage_limit create_usage_limit ****************** Redshift.Client.create_usage_limit(**kwargs) Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier. See also: AWS API Documentation **Request Syntax** response = client.create_usage_limit( ClusterIdentifier='string', FeatureType='spectrum'|'concurrency-scaling'|'cross-region-datasharing', LimitType='time'|'data-scanned', Amount=123, Period='daily'|'weekly'|'monthly', BreachAction='log'|'emit-metric'|'disable', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClusterIdentifier** (*string*) -- **[REQUIRED]** The identifier of the cluster that you want to limit usage. * **FeatureType** (*string*) -- **[REQUIRED]** The Amazon Redshift feature that you want to limit. * **LimitType** (*string*) -- **[REQUIRED]** The type of limit. Depending on the feature type, this can be based on a time duration or data size. If "FeatureType" is "spectrum", then "LimitType" must be "data-scanned". If "FeatureType" is "concurrency-scaling", then "LimitType" must be "time". If "FeatureType" is "cross-region-datasharing", then "LimitType" must be "data-scanned". * **Amount** (*integer*) -- **[REQUIRED]** The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number. * **Period** (*string*) -- The time period that the amount applies to. A "weekly" period begins on Sunday. The default is "monthly". * **BreachAction** (*string*) -- The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit. * **Tags** (*list*) -- A list of tag instances. * *(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. Return type: dict Returns: **Response Syntax** { 'UsageLimitId': 'string', 'ClusterIdentifier': 'string', 'FeatureType': 'spectrum'|'concurrency-scaling'|'cross-region-datasharing', 'LimitType': 'time'|'data-scanned', 'Amount': 123, 'Period': 'daily'|'weekly'|'monthly', 'BreachAction': 'log'|'emit-metric'|'disable', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* Describes a usage limit object for a cluster. * **UsageLimitId** *(string) --* The identifier of the usage limit. * **ClusterIdentifier** *(string) --* The identifier of the cluster with a usage limit. * **FeatureType** *(string) --* The Amazon Redshift feature to which the limit applies. * **LimitType** *(string) --* The type of limit. Depending on the feature type, this can be based on a time duration or data size. * **Amount** *(integer) --* The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). * **Period** *(string) --* The time period that the amount applies to. A "weekly" period begins on Sunday. The default is "monthly". * **BreachAction** *(string) --* The action that Amazon Redshift takes when the limit is reached. Possible values are: * **log** - To log an event in a system table. The default is log. * **emit-metric** - To emit CloudWatch metrics. * **disable** - To disable the feature until the next usage period begins. * **Tags** *(list) --* A list of tag instances. * *(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. **Exceptions** * "Redshift.Client.exceptions.ClusterNotFoundFault" * "Redshift.Client.exceptions.InvalidClusterStateFault" * "Redshift.Client.exceptions.LimitExceededFault" * "Redshift.Client.exceptions.UsageLimitAlreadyExistsFault" * "Redshift.Client.exceptions.InvalidUsageLimitFault" * "Redshift.Client.exceptions.TagLimitExceededFault" * "Redshift.Client.exceptions.UnsupportedOperationFault" Redshift / Client / reboot_cluster reboot_cluster ************** Redshift.Client.reboot_cluster(**kwargs) Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to "rebooting". A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the *Amazon Redshift Cluster Management Guide*. See also: AWS API Documentation **Request Syntax** response = client.reboot_cluster( ClusterIdentifier='string' ) Parameters: **ClusterIdentifier** (*string*) -- **[REQUIRED]** The cluster identifier. Return type: dict Returns: **Response Syntax** { 'Cluster': { 'ClusterIdentifier': 'string', 'NodeType': 'string', 'ClusterStatus': 'string', 'ClusterAvailabilityStatus': 'string', 'ModifyStatus': 'string', 'MasterUsername': 'string', 'DBName': 'string', 'Endpoint': { 'Address': 'string', 'Port': 123, 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcId': 'string', 'NetworkInterfaces': [ { 'NetworkInterfaceId': 'string', 'SubnetId': 'string', 'PrivateIpAddress': 'string', 'AvailabilityZone': 'string', 'Ipv6Address': 'string' }, ] }, ] }, '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 }, 'AvailabilityZoneRelocationStatus': 'string', 'ClusterNamespaceArn': 'string', 'TotalStorageCapacityInMegaBytes': 123, 'AquaConfiguration': { 'AquaStatus': 'enabled'|'disabled'|'applying', 'AquaConfigurationStatus': 'enabled'|'disabled'|'auto' }, 'DefaultIamRoleArn': 'string', 'ReservedNodeExchangeStatus': { 'ReservedNodeExchangeRequestId': 'string', 'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED', 'RequestTime': datetime(2015, 1, 1), 'SourceReservedNodeId': 'string', 'SourceReservedNodeType': 'string', 'SourceReservedNodeCount': 123, 'TargetReservedNodeOfferingId': 'string', 'TargetReservedNodeType': 'string', 'TargetReservedNodeCount': 123 }, 'CustomDomainName': 'string', 'CustomDomainCertificateArn': 'string', 'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1), 'MasterPasswordSecretArn': 'string', 'MasterPasswordSecretKmsKeyId': 'string', 'IpAddressType': 'string', 'MultiAZ': 'string', 'MultiAZSecondary': { 'AvailabilityZone': 'string', 'ClusterNodes': [ { 'NodeRole': 'string', 'PrivateIPAddress': 'string', 'PublicIPAddress': 'string' }, ] } } } **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 admin 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 >>``<>``<>``<>``<