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_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_partner
- delete_resource_policy
- delete_scheduled_action
- delete_snapshot_copy_grant
- delete_snapshot_schedule
- delete_tags
- delete_usage_limit
- 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_logging_status
- describe_node_configuration_options
- describe_orderable_cluster_options
- describe_partners
- 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
- 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_scheduled_action
- modify_snapshot_copy_retention_period
- modify_snapshot_schedule
- modify_usage_limit
- pause_cluster
- purchase_reserved_node_offering
- put_resource_policy
- reboot_cluster
- 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
- DescribeNodeConfigurationOptions
- DescribeOrderableClusterOptions
- DescribeReservedNodeExchangeStatus
- DescribeReservedNodeOfferings
- DescribeReservedNodes
- DescribeScheduledActions
- DescribeSnapshotCopyGrants
- DescribeSnapshotSchedules
- DescribeTableRestoreStatus
- DescribeTags
- DescribeUsageLimits
- GetReservedNodeExchangeConfigurationOptions
- GetReservedNodeExchangeOfferings
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: