Client

redshift

R Documentation

Amazon Redshift¶

Description¶

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.

Usage¶

redshift(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- redshift(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

accept_reserved_node_exchange: Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs
add_partner: Adds a partner integration to a cluster
associate_data_share_consumer: From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn); Adds an inbound (ingress) rule to an Amazon Redshift security group
authorize_data_share: From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities
authorize_endpoint_access: Grants access to a cluster
authorize_snapshot_access: Authorizes the specified Amazon Web Services account to restore the specified snapshot
batch_delete_cluster_snapshots: Deletes a set of cluster snapshots
batch_modify_cluster_snapshots: Modifies the settings for a set of cluster snapshots
cancel_resize: Cancels a resize operation for a cluster
copy_cluster_snapshot: Copies the specified automated cluster snapshot to a new manual cluster snapshot
create_authentication_profile: Creates an authentication profile with the specified parameters
create_cluster: Creates a new cluster with the specified parameters
create_cluster_parameter_group: Creates an Amazon Redshift parameter group
create_cluster_security_group: Creates a new Amazon Redshift security group
create_cluster_snapshot: Creates a manual snapshot of the specified cluster
create_cluster_subnet_group: Creates a new Amazon Redshift subnet group
create_custom_domain_association: Used to create a custom domain name for a cluster
create_endpoint_access: Creates a Redshift-managed VPC endpoint
create_event_subscription: Creates an Amazon Redshift event notification subscription
create_hsm_client_certificate: 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
create_hsm_configuration: Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM)
create_redshift_idc_application: Creates an Amazon Redshift application for use with IAM Identity Center
create_scheduled_action: Creates a scheduled action
create_snapshot_copy_grant: Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region
create_snapshot_schedule: Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule
create_tags: Adds tags to a cluster
create_usage_limit: Creates a usage limit for a specified Amazon Redshift feature on a cluster
deauthorize_data_share: From a datashare producer account, removes authorization from the specified datashare
delete_authentication_profile: Deletes an authentication profile
delete_cluster: Deletes a previously provisioned cluster without its final snapshot being created
delete_cluster_parameter_group: Deletes a specified Amazon Redshift parameter group
delete_cluster_security_group: Deletes an Amazon Redshift security group
delete_cluster_snapshot: Deletes the specified manual snapshot
delete_cluster_subnet_group: Deletes the specified cluster subnet group
delete_custom_domain_association: Contains information about deleting a custom domain association for a cluster
delete_endpoint_access: Deletes a Redshift-managed VPC endpoint
delete_event_subscription: Deletes an Amazon Redshift event notification subscription
delete_hsm_client_certificate: Deletes the specified HSM client certificate
delete_hsm_configuration: Deletes the specified Amazon Redshift HSM configuration
delete_partner: Deletes a partner integration from a cluster
delete_redshift_idc_application: Deletes an Amazon Redshift IAM Identity Center application
delete_resource_policy: Deletes the resource policy for a specified resource
delete_scheduled_action: Deletes a scheduled action
delete_snapshot_copy_grant: Deletes the specified snapshot copy grant
delete_snapshot_schedule: Deletes a snapshot schedule
delete_tags: Deletes tags from a resource
delete_usage_limit: Deletes a usage limit from a cluster
describe_account_attributes: Returns a list of attributes attached to an account
describe_authentication_profiles: Describes an authentication profile
describe_cluster_db_revisions: Returns an array of ClusterDbRevision objects
describe_cluster_parameter_groups: Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group
describe_cluster_parameters: Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group
describe_clusters: Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties
describe_cluster_security_groups: Returns information about Amazon Redshift security groups
describe_cluster_snapshots: Returns one or more snapshot objects, which contain metadata about your cluster snapshots
describe_cluster_subnet_groups: Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups
describe_cluster_tracks: Returns a list of all the available maintenance tracks
describe_cluster_versions: Returns descriptions of the available Amazon Redshift cluster versions
describe_custom_domain_associations: Contains information about custom domain associations for a cluster
describe_data_shares: Shows the status of any inbound or outbound datashares available in the specified account
describe_data_shares_for_consumer: Returns a list of datashares where the account identifier being called is a consumer account identifier
describe_data_shares_for_producer: Returns a list of datashares when the account identifier being called is a producer account identifier
describe_default_cluster_parameters: Returns a list of parameter settings for the specified parameter group family
describe_endpoint_access: Describes a Redshift-managed VPC endpoint
describe_endpoint_authorization: Describes an endpoint authorization
describe_event_categories: Displays a list of event categories for all event source types, or for a specified source type
describe_events: Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days
describe_event_subscriptions: Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account
describe_hsm_client_certificates: Returns information about the specified HSM client certificate
describe_hsm_configurations: Returns information about the specified Amazon Redshift HSM configuration
describe_inbound_integrations: Returns a list of inbound integrations
describe_logging_status: Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster
describe_node_configuration_options: Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type
describe_orderable_cluster_options: Returns a list of orderable cluster options
describe_partners: Returns information about the partner integrations defined for a cluster
describe_redshift_idc_applications: Lists the Amazon Redshift IAM Identity Center applications; Returns exchange status details and associated metadata for a reserved-node exchange
describe_reserved_node_offerings: Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you
describe_reserved_nodes: Returns the descriptions of the reserved nodes
describe_resize: Returns information about the last resize operation for the specified cluster
describe_scheduled_actions: Describes properties of scheduled actions
describe_snapshot_copy_grants: Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region
describe_snapshot_schedules: Returns a list of snapshot schedules
describe_storage: Returns account level backups storage size and provisional storage
describe_table_restore_status: Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action
describe_tags: Returns a list of tags
describe_usage_limits: Shows usage limits on a cluster
disable_logging: Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster
disable_snapshot_copy: Disables the automatic copying of snapshots from one region to another region for a specified cluster
disassociate_data_share_consumer: From a datashare consumer account, remove association for the specified datashare
enable_logging: Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster
enable_snapshot_copy: Enables the automatic copy of snapshots from one region to another region for a specified cluster
failover_primary_compute: Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone
get_cluster_credentials: Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database
get_cluster_credentials_with_iam: Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database; Gets the configuration options for the reserved-node exchange
get_reserved_node_exchange_offerings: Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node
get_resource_policy: Get the resource policy for a specified resource
list_recommendations: List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account
modify_aqua_configuration: This operation is retired
modify_authentication_profile: Modifies an authentication profile
modify_cluster: Modifies the settings for a cluster
modify_cluster_db_revision: Modifies the database revision of a cluster
modify_cluster_iam_roles: Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services
modify_cluster_maintenance: Modifies the maintenance settings of a cluster
modify_cluster_parameter_group: Modifies the parameters of a parameter group
modify_cluster_snapshot: Modifies the settings for a snapshot
modify_cluster_snapshot_schedule: Modifies a snapshot schedule for a cluster
modify_cluster_subnet_group: Modifies a cluster subnet group to include the specified list of VPC subnets
modify_custom_domain_association: Contains information for changing a custom domain association
modify_endpoint_access: Modifies a Redshift-managed VPC endpoint
modify_event_subscription: Modifies an existing Amazon Redshift event notification subscription
modify_redshift_idc_application: Changes an existing Amazon Redshift IAM Identity Center application
modify_scheduled_action: Modifies a scheduled action
modify_snapshot_copy_retention_period: Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region
modify_snapshot_schedule: Modifies a snapshot schedule
modify_usage_limit: Modifies a usage limit in a cluster
pause_cluster: Pauses a cluster
purchase_reserved_node_offering: Allows you to purchase reserved nodes
put_resource_policy: Updates the resource policy for a specified resource
reboot_cluster: Reboots a cluster
reject_data_share: From a datashare consumer account, rejects the specified datashare
reset_cluster_parameter_group: 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"
resize_cluster: Changes the size of the cluster
restore_from_cluster_snapshot: Creates a new cluster from a snapshot
restore_table_from_cluster_snapshot: Creates a new table from a table in an Amazon Redshift cluster snapshot
resume_cluster: Resumes a paused cluster
revoke_cluster_security_group_ingress: Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group
revoke_endpoint_access: Revokes access to a cluster
revoke_snapshot_access: Removes the ability of the specified Amazon Web Services account to restore the specified snapshot
rotate_encryption_key: Rotates the encryption keys for a cluster
update_partner_status: Updates the status of a partner integration

Examples¶

## Not run: 
svc <- redshift()
svc$accept_reserved_node_exchange(
  Foo = 123
)

## End(Not run)