

********
Redshift
********



======
Client
======



.. py: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 <https://docs.aws.amazon.com/redshift/latest/mgmt/using-aws-sdk.html>`__.

   

  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 <https://docs.aws.amazon.com/redshift/latest/gsg/getting-started.html>`__.

   

  If you are a database developer, the `Amazon Redshift Database Developer Guide <https://docs.aws.amazon.com/redshift/latest/dg/welcome.html>`__ 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:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  redshift/client/accept_reserved_node_exchange
  redshift/client/add_partner
  redshift/client/associate_data_share_consumer
  redshift/client/authorize_cluster_security_group_ingress
  redshift/client/authorize_data_share
  redshift/client/authorize_endpoint_access
  redshift/client/authorize_snapshot_access
  redshift/client/batch_delete_cluster_snapshots
  redshift/client/batch_modify_cluster_snapshots
  redshift/client/can_paginate
  redshift/client/cancel_resize
  redshift/client/close
  redshift/client/copy_cluster_snapshot
  redshift/client/create_authentication_profile
  redshift/client/create_cluster
  redshift/client/create_cluster_parameter_group
  redshift/client/create_cluster_security_group
  redshift/client/create_cluster_snapshot
  redshift/client/create_cluster_subnet_group
  redshift/client/create_custom_domain_association
  redshift/client/create_endpoint_access
  redshift/client/create_event_subscription
  redshift/client/create_hsm_client_certificate
  redshift/client/create_hsm_configuration
  redshift/client/create_integration
  redshift/client/create_redshift_idc_application
  redshift/client/create_scheduled_action
  redshift/client/create_snapshot_copy_grant
  redshift/client/create_snapshot_schedule
  redshift/client/create_tags
  redshift/client/create_usage_limit
  redshift/client/deauthorize_data_share
  redshift/client/delete_authentication_profile
  redshift/client/delete_cluster
  redshift/client/delete_cluster_parameter_group
  redshift/client/delete_cluster_security_group
  redshift/client/delete_cluster_snapshot
  redshift/client/delete_cluster_subnet_group
  redshift/client/delete_custom_domain_association
  redshift/client/delete_endpoint_access
  redshift/client/delete_event_subscription
  redshift/client/delete_hsm_client_certificate
  redshift/client/delete_hsm_configuration
  redshift/client/delete_integration
  redshift/client/delete_partner
  redshift/client/delete_redshift_idc_application
  redshift/client/delete_resource_policy
  redshift/client/delete_scheduled_action
  redshift/client/delete_snapshot_copy_grant
  redshift/client/delete_snapshot_schedule
  redshift/client/delete_tags
  redshift/client/delete_usage_limit
  redshift/client/deregister_namespace
  redshift/client/describe_account_attributes
  redshift/client/describe_authentication_profiles
  redshift/client/describe_cluster_db_revisions
  redshift/client/describe_cluster_parameter_groups
  redshift/client/describe_cluster_parameters
  redshift/client/describe_cluster_security_groups
  redshift/client/describe_cluster_snapshots
  redshift/client/describe_cluster_subnet_groups
  redshift/client/describe_cluster_tracks
  redshift/client/describe_cluster_versions
  redshift/client/describe_clusters
  redshift/client/describe_custom_domain_associations
  redshift/client/describe_data_shares
  redshift/client/describe_data_shares_for_consumer
  redshift/client/describe_data_shares_for_producer
  redshift/client/describe_default_cluster_parameters
  redshift/client/describe_endpoint_access
  redshift/client/describe_endpoint_authorization
  redshift/client/describe_event_categories
  redshift/client/describe_event_subscriptions
  redshift/client/describe_events
  redshift/client/describe_hsm_client_certificates
  redshift/client/describe_hsm_configurations
  redshift/client/describe_inbound_integrations
  redshift/client/describe_integrations
  redshift/client/describe_logging_status
  redshift/client/describe_node_configuration_options
  redshift/client/describe_orderable_cluster_options
  redshift/client/describe_partners
  redshift/client/describe_redshift_idc_applications
  redshift/client/describe_reserved_node_exchange_status
  redshift/client/describe_reserved_node_offerings
  redshift/client/describe_reserved_nodes
  redshift/client/describe_resize
  redshift/client/describe_scheduled_actions
  redshift/client/describe_snapshot_copy_grants
  redshift/client/describe_snapshot_schedules
  redshift/client/describe_storage
  redshift/client/describe_table_restore_status
  redshift/client/describe_tags
  redshift/client/describe_usage_limits
  redshift/client/disable_logging
  redshift/client/disable_snapshot_copy
  redshift/client/disassociate_data_share_consumer
  redshift/client/enable_logging
  redshift/client/enable_snapshot_copy
  redshift/client/failover_primary_compute
  redshift/client/get_cluster_credentials
  redshift/client/get_cluster_credentials_with_iam
  redshift/client/get_identity_center_auth_token
  redshift/client/get_paginator
  redshift/client/get_reserved_node_exchange_configuration_options
  redshift/client/get_reserved_node_exchange_offerings
  redshift/client/get_resource_policy
  redshift/client/get_waiter
  redshift/client/list_recommendations
  redshift/client/modify_aqua_configuration
  redshift/client/modify_authentication_profile
  redshift/client/modify_cluster
  redshift/client/modify_cluster_db_revision
  redshift/client/modify_cluster_iam_roles
  redshift/client/modify_cluster_maintenance
  redshift/client/modify_cluster_parameter_group
  redshift/client/modify_cluster_snapshot
  redshift/client/modify_cluster_snapshot_schedule
  redshift/client/modify_cluster_subnet_group
  redshift/client/modify_custom_domain_association
  redshift/client/modify_endpoint_access
  redshift/client/modify_event_subscription
  redshift/client/modify_integration
  redshift/client/modify_lakehouse_configuration
  redshift/client/modify_redshift_idc_application
  redshift/client/modify_scheduled_action
  redshift/client/modify_snapshot_copy_retention_period
  redshift/client/modify_snapshot_schedule
  redshift/client/modify_usage_limit
  redshift/client/pause_cluster
  redshift/client/purchase_reserved_node_offering
  redshift/client/put_resource_policy
  redshift/client/reboot_cluster
  redshift/client/register_namespace
  redshift/client/reject_data_share
  redshift/client/reset_cluster_parameter_group
  redshift/client/resize_cluster
  redshift/client/restore_from_cluster_snapshot
  redshift/client/restore_table_from_cluster_snapshot
  redshift/client/resume_cluster
  redshift/client/revoke_cluster_security_group_ingress
  redshift/client/revoke_endpoint_access
  redshift/client/revoke_snapshot_access
  redshift/client/rotate_encryption_key
  redshift/client/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 <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  redshift/paginator/DescribeClusterDbRevisions
  redshift/paginator/DescribeClusterParameterGroups
  redshift/paginator/DescribeClusterParameters
  redshift/paginator/DescribeClusterSecurityGroups
  redshift/paginator/DescribeClusterSnapshots
  redshift/paginator/DescribeClusterSubnetGroups
  redshift/paginator/DescribeClusterTracks
  redshift/paginator/DescribeClusterVersions
  redshift/paginator/DescribeClusters
  redshift/paginator/DescribeCustomDomainAssociations
  redshift/paginator/DescribeDataShares
  redshift/paginator/DescribeDataSharesForConsumer
  redshift/paginator/DescribeDataSharesForProducer
  redshift/paginator/DescribeDefaultClusterParameters
  redshift/paginator/DescribeEndpointAccess
  redshift/paginator/DescribeEndpointAuthorization
  redshift/paginator/DescribeEventSubscriptions
  redshift/paginator/DescribeEvents
  redshift/paginator/DescribeHsmClientCertificates
  redshift/paginator/DescribeHsmConfigurations
  redshift/paginator/DescribeInboundIntegrations
  redshift/paginator/DescribeIntegrations
  redshift/paginator/DescribeNodeConfigurationOptions
  redshift/paginator/DescribeOrderableClusterOptions
  redshift/paginator/DescribeRedshiftIdcApplications
  redshift/paginator/DescribeReservedNodeExchangeStatus
  redshift/paginator/DescribeReservedNodeOfferings
  redshift/paginator/DescribeReservedNodes
  redshift/paginator/DescribeScheduledActions
  redshift/paginator/DescribeSnapshotCopyGrants
  redshift/paginator/DescribeSnapshotSchedules
  redshift/paginator/DescribeTableRestoreStatus
  redshift/paginator/DescribeTags
  redshift/paginator/DescribeUsageLimits
  redshift/paginator/GetReservedNodeExchangeConfigurationOptions
  redshift/paginator/GetReservedNodeExchangeOfferings
  redshift/paginator/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 <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters>`_.

The available waiters are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  redshift/waiter/ClusterAvailable
  redshift/waiter/ClusterDeleted
  redshift/waiter/ClusterRestored
  redshift/waiter/SnapshotAvailable
