# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.Redshift do
@moduledoc """
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.
"""
alias AWS.Client
alias AWS.Request
def metadata do
%{
abbreviation: nil,
api_version: "2012-12-01",
content_type: "application/x-www-form-urlencoded",
credential_scope: nil,
endpoint_prefix: "redshift",
global?: false,
protocol: "query",
service_id: "Redshift",
signature_version: "v4",
signing_name: "redshift",
target_prefix: nil
}
end
@doc """
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.
"""
def accept_reserved_node_exchange(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AcceptReservedNodeExchange", input, options)
end
@doc """
Adds a partner integration to a cluster.
This operation authorizes a partner to push status updates for the specified
database. To complete the integration, you also set up the integration on the
partner website.
"""
def add_partner(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AddPartner", input, options)
end
@doc """
From a datashare consumer account, associates a datashare with the account
(AssociateEntireAccount) or the specified namespace (ConsumerArn).
If you make this association, the consumer can consume the datashare.
"""
def associate_data_share_consumer(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AssociateDataShareConsumer", input, options)
end
@doc """
Adds an inbound (ingress) rule to an Amazon Redshift security group.
Depending on whether the application accessing your cluster is running on the
Internet or an Amazon EC2 instance, you can authorize inbound access to either a
Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an
Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon
Redshift security group.
If you authorize access to an Amazon EC2 security group, specify
*EC2SecurityGroupName* and *EC2SecurityGroupOwnerId*. The Amazon EC2 security
group and Amazon Redshift cluster must be in the same Amazon Web Services
Region.
If you authorize access to a CIDR/IP address range, specify *CIDRIP*. For an
overview of CIDR blocks, see the Wikipedia article on [Classless Inter-Domain Routing](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).
You must also associate the security group with a cluster so that clients
running on these IP addresses or the EC2 instance are authorized to connect to
the cluster. For information about managing security groups, go to [Working with Security
Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def authorize_cluster_security_group_ingress(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AuthorizeClusterSecurityGroupIngress", input, options)
end
@doc """
From a data producer account, authorizes the sharing of a datashare with one or
more consumer accounts or managing entities.
To authorize a datashare for a data consumer, the producer account must have the
correct access permissions.
"""
def authorize_data_share(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AuthorizeDataShare", input, options)
end
@doc """
Grants access to a cluster.
"""
def authorize_endpoint_access(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AuthorizeEndpointAccess", input, options)
end
@doc """
Authorizes the specified Amazon Web Services account to restore the specified
snapshot.
For more information about working with snapshots, go to [Amazon Redshift Snapshots](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def authorize_snapshot_access(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AuthorizeSnapshotAccess", input, options)
end
@doc """
Deletes a set of cluster snapshots.
"""
def batch_delete_cluster_snapshots(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "BatchDeleteClusterSnapshots", input, options)
end
@doc """
Modifies the settings for a set of cluster snapshots.
"""
def batch_modify_cluster_snapshots(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "BatchModifyClusterSnapshots", input, options)
end
@doc """
Cancels a resize operation for a cluster.
"""
def cancel_resize(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CancelResize", input, options)
end
@doc """
Copies the specified automated cluster snapshot to a new manual cluster
snapshot.
The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of
the cluster. Also, when the retention period of the snapshot expires, Amazon
Redshift automatically deletes it. If you want to keep an automated snapshot for
a longer period, you can make a manual copy of the snapshot. Manual snapshots
are retained until you delete them.
For more information about working with snapshots, go to [Amazon Redshift Snapshots](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def copy_cluster_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CopyClusterSnapshot", input, options)
end
@doc """
Creates an authentication profile with the specified parameters.
"""
def create_authentication_profile(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateAuthenticationProfile", input, options)
end
@doc """
Creates a new cluster with the specified parameters.
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster
subnet group name. The cluster subnet group identifies the subnets of your VPC
that Amazon Redshift uses when creating the cluster. For more information about
managing clusters, go to [Amazon Redshift Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def create_cluster(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateCluster", input, options)
end
@doc """
Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate
a cluster with a parameter group when you create the cluster. You can also
associate an existing cluster with a parameter group after the cluster is
created by using `ModifyCluster`.
Parameters in the parameter group define specific behavior that applies to the
databases you create on the cluster. For more information about parameters and
parameter groups, go to [Amazon Redshift Parameter Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def create_cluster_parameter_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateClusterParameterGroup", input, options)
end
@doc """
Creates a new Amazon Redshift security group.
You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to [Amazon Redshift Cluster Security
Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def create_cluster_security_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateClusterSecurityGroup", input, options)
end
@doc """
Creates a manual snapshot of the specified cluster.
The cluster must be in the `available` state.
For more information about working with snapshots, go to [Amazon Redshift Snapshots](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def create_cluster_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateClusterSnapshot", input, options)
end
@doc """
Creates a new Amazon Redshift subnet group.
You must provide a list of one or more subnets in your existing Amazon Virtual
Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to [Amazon Redshift Cluster Subnet Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def create_cluster_subnet_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateClusterSubnetGroup", input, options)
end
@doc """
Creates a Redshift-managed VPC endpoint.
"""
def create_endpoint_access(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateEndpointAccess", input, options)
end
@doc """
Creates an Amazon Redshift event notification subscription.
This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic
created by either the Amazon Redshift console, the Amazon SNS console, or the
Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in
Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event
categories, and event severities. Notifications will be sent for all events you
want that match those criteria. For example, you can specify source type =
cluster, source ID = my-cluster-1 and mycluster2, event categories =
Availability, Backup, and severity = ERROR. The subscription will only send
notifications for those ERROR events in the Availability and Backup categories
for the specified clusters.
If you specify both the source type and source IDs, such as source type =
cluster and source identifier = my-cluster-1, notifications will be sent for all
the cluster events for my-cluster-1. If you specify a source type but do not
specify a source identifier, you will receive notice of the events for the
objects of that type in your Amazon Web Services account. If you do not specify
either the SourceType nor the SourceIdentifier, you will be notified of events
generated from all Amazon Redshift sources belonging to your Amazon Web Services
account. You must specify a source type if you specify a source ID.
"""
def create_event_subscription(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateEventSubscription", input, options)
end
@doc """
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](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html#working-with-HSM)
in the *Amazon Redshift Cluster Management Guide*.
"""
def create_hsm_client_certificate(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateHsmClientCertificate", input, options)
end
@doc """
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).
After creating the HSM configuration, you can specify it as a parameter when
creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client
certificate. For more information, go to [Hardware Security Modules](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html)
in the Amazon Redshift Cluster Management Guide.
"""
def create_hsm_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateHsmConfiguration", input, options)
end
@doc """
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.
"""
def create_scheduled_action(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateScheduledAction", input, options)
end
@doc """
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.
For more information about managing snapshot copy grants, go to [Amazon Redshift Database
Encryption](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def create_snapshot_copy_grant(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateSnapshotCopyGrant", input, options)
end
@doc """
Create a snapshot schedule that can be associated to a cluster and which
overrides the default system backup schedule.
"""
def create_snapshot_schedule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateSnapshotSchedule", input, options)
end
@doc """
Adds tags to a cluster.
A resource can have up to 50 tags. If you try to create more than 50 tags for a
resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that
key will be updated with the new value.
"""
def create_tags(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateTags", input, options)
end
@doc """
Creates a usage limit for a specified Amazon Redshift feature on a cluster.
The usage limit is identified by the returned usage limit identifier.
"""
def create_usage_limit(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateUsageLimit", input, options)
end
@doc """
From a datashare producer account, removes authorization from the specified
datashare.
"""
def deauthorize_data_share(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeauthorizeDataShare", input, options)
end
@doc """
Deletes an authentication profile.
"""
def delete_authentication_profile(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteAuthenticationProfile", input, options)
end
@doc """
Deletes a previously provisioned cluster without its final snapshot being
created.
A successful response from the web service indicates that the request was
received correctly. Use `DescribeClusters` to monitor the status of the
deletion. The delete operation cannot be canceled or reverted once submitted.
For more information about managing clusters, go to [Amazon Redshift Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html)
in the *Amazon Redshift Cluster Management Guide*.
If you want to shut down the cluster and retain it for future use, set
*SkipFinalClusterSnapshot* to `false` and specify a name for
*FinalClusterSnapshotIdentifier*. You can later restore this snapshot to resume
using the cluster. If a final cluster snapshot is requested, the status of the
cluster will be "final-snapshot" while the snapshot is being taken, then it's
"deleting" once Amazon Redshift begins deleting the cluster.
For more information about managing clusters, go to [Amazon Redshift Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def delete_cluster(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteCluster", input, options)
end
@doc """
Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
"""
def delete_cluster_parameter_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteClusterParameterGroup", input, options)
end
@doc """
Deletes an Amazon Redshift security group.
You cannot delete a security group that is associated with any clusters. You
cannot delete the default security group.
For information about managing security groups, go to [Amazon Redshift Cluster Security
Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def delete_cluster_security_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteClusterSecurityGroup", input, options)
end
@doc """
Deletes the specified manual snapshot.
The snapshot must be in the `available` state, with no other users authorized to
access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete
your cluster. Amazon Redshift does not delete your manual snapshots. You must
delete manual snapshot explicitly to avoid getting charged. If other accounts
are authorized to access the snapshot, you must revoke all of the authorizations
before you can delete the snapshot.
"""
def delete_cluster_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteClusterSnapshot", input, options)
end
@doc """
Deletes the specified cluster subnet group.
"""
def delete_cluster_subnet_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteClusterSubnetGroup", input, options)
end
@doc """
Deletes a Redshift-managed VPC endpoint.
"""
def delete_endpoint_access(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteEndpointAccess", input, options)
end
@doc """
Deletes an Amazon Redshift event notification subscription.
"""
def delete_event_subscription(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteEventSubscription", input, options)
end
@doc """
Deletes the specified HSM client certificate.
"""
def delete_hsm_client_certificate(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteHsmClientCertificate", input, options)
end
@doc """
Deletes the specified Amazon Redshift HSM configuration.
"""
def delete_hsm_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteHsmConfiguration", input, options)
end
@doc """
Deletes a partner integration from a cluster.
Data can still flow to the cluster until the integration is deleted at the
partner's website.
"""
def delete_partner(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeletePartner", input, options)
end
@doc """
Deletes a scheduled action.
"""
def delete_scheduled_action(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteScheduledAction", input, options)
end
@doc """
Deletes the specified snapshot copy grant.
"""
def delete_snapshot_copy_grant(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteSnapshotCopyGrant", input, options)
end
@doc """
Deletes a snapshot schedule.
"""
def delete_snapshot_schedule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteSnapshotSchedule", input, options)
end
@doc """
Deletes tags from a resource.
You must provide the ARN of the resource from which you want to delete the tag
or tags.
"""
def delete_tags(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteTags", input, options)
end
@doc """
Deletes a usage limit from a cluster.
"""
def delete_usage_limit(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteUsageLimit", input, options)
end
@doc """
Returns a list of attributes attached to an account
"""
def describe_account_attributes(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeAccountAttributes", input, options)
end
@doc """
Describes an authentication profile.
"""
def describe_authentication_profiles(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeAuthenticationProfiles", input, options)
end
@doc """
Returns an array of `ClusterDbRevision` objects.
"""
def describe_cluster_db_revisions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeClusterDbRevisions", input, options)
end
@doc """
Returns a list of Amazon Redshift parameter groups, including parameter groups
you created and the default parameter group.
For each parameter group, the response includes the parameter group name,
description, and parameter group family name. You can optionally specify a name
to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to [Amazon Redshift Parameter
Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
If you specify both tag keys and tag values in the same request, Amazon Redshift
returns all parameter groups that match any combination of the specified keys
and values. For example, if you have `owner` and `environment` for tag keys, and
`admin` and `test` for tag values, all parameter groups that have any
combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are
returned regardless of whether they have tag keys or values associated with
them.
"""
def describe_cluster_parameter_groups(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeClusterParameterGroups", input, options)
end
@doc """
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](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def describe_cluster_parameters(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeClusterParameters", input, options)
end
@doc """
Returns information about Amazon Redshift security groups.
If the name of a security group is specified, the response will contain only
information about only that security group.
For information about managing security groups, go to [Amazon Redshift Cluster Security
Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
If you specify both tag keys and tag values in the same request, Amazon Redshift
returns all security groups that match any combination of the specified keys and
values. For example, if you have `owner` and `environment` for tag keys, and
`admin` and `test` for tag values, all security groups that have any combination
of those values are returned.
If both tag keys and values are omitted from the request, security groups are
returned regardless of whether they have tag keys or values associated with
them.
"""
def describe_cluster_security_groups(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeClusterSecurityGroups", input, options)
end
@doc """
Returns one or more snapshot objects, which contain metadata about your cluster
snapshots.
By default, this operation returns information about all snapshots of all
clusters that are owned by your Amazon Web Services account. No information is
returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift
returns all snapshots that match any combination of the specified keys and
values. For example, if you have `owner` and `environment` for tag keys, and
`admin` and `test` for tag values, all snapshots that have any combination of
those values are returned. Only snapshots that you own are returned in the
response; shared snapshots are not returned with the tag key and tag value
request parameters.
If both tag keys and values are omitted from the request, snapshots are returned
regardless of whether they have tag keys or values associated with them.
"""
def describe_cluster_snapshots(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeClusterSnapshots", input, options)
end
@doc """
Returns one or more cluster subnet group objects, which contain metadata about
your cluster subnet groups.
By default, this operation returns information about all cluster subnet groups
that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift
returns all subnet groups that match any combination of the specified keys and
values. For example, if you have `owner` and `environment` for tag keys, and
`admin` and `test` for tag values, all subnet groups that have any combination
of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are
returned regardless of whether they have tag keys or values associated with
them.
"""
def describe_cluster_subnet_groups(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeClusterSubnetGroups", input, options)
end
@doc """
Returns a list of all the available maintenance tracks.
"""
def describe_cluster_tracks(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeClusterTracks", input, options)
end
@doc """
Returns descriptions of the available Amazon Redshift cluster versions.
You can call this operation even before creating any clusters to learn more
about the Amazon Redshift versions. For more information about managing
clusters, go to [Amazon Redshift Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def describe_cluster_versions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeClusterVersions", input, options)
end
@doc """
Returns properties of provisioned clusters including general cluster properties,
cluster database properties, maintenance and backup properties, and security and
access properties.
This operation supports pagination. For more information about managing
clusters, go to [Amazon Redshift Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html)
in the *Amazon Redshift Cluster Management Guide*.
If you specify both tag keys and tag values in the same request, Amazon Redshift
returns all clusters that match any combination of the specified keys and
values. For example, if you have `owner` and `environment` for tag keys, and
`admin` and `test` for tag values, all clusters that have any combination of
those values are returned.
If both tag keys and values are omitted from the request, clusters are returned
regardless of whether they have tag keys or values associated with them.
"""
def describe_clusters(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeClusters", input, options)
end
@doc """
Shows the status of any inbound or outbound datashares available in the
specified account.
"""
def describe_data_shares(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeDataShares", input, options)
end
@doc """
Returns a list of datashares where the account identifier being called is a
consumer account identifier.
"""
def describe_data_shares_for_consumer(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeDataSharesForConsumer", input, options)
end
@doc """
Returns a list of datashares when the account identifier being called is a
producer account identifier.
"""
def describe_data_shares_for_producer(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeDataSharesForProducer", input, options)
end
@doc """
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to [Amazon Redshift Parameter
Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def describe_default_cluster_parameters(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeDefaultClusterParameters", input, options)
end
@doc """
Describes a Redshift-managed VPC endpoint.
"""
def describe_endpoint_access(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeEndpointAccess", input, options)
end
@doc """
Describes an endpoint authorization.
"""
def describe_endpoint_authorization(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeEndpointAuthorization", input, options)
end
@doc """
Displays a list of event categories for all event source types, or for a
specified source type.
For a list of the event categories and source types, go to [Amazon Redshift Event
Notifications](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html).
"""
def describe_event_categories(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeEventCategories", input, options)
end
@doc """
Lists descriptions of all the Amazon Redshift event notification subscriptions
for a customer account.
If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift
returns all event notification subscriptions that match any combination of the
specified keys and values. For example, if you have `owner` and `environment`
for tag keys, and `admin` and `test` for tag values, all subscriptions that have
any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are
returned regardless of whether they have tag keys or values associated with
them.
"""
def describe_event_subscriptions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeEventSubscriptions", input, options)
end
@doc """
Returns events related to clusters, security groups, snapshots, and parameter
groups for the past 14 days.
Events specific to a particular cluster, security group, snapshot or parameter
group can be obtained by providing the name as a parameter. By default, the past
hour of events are returned.
"""
def describe_events(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeEvents", input, options)
end
@doc """
Returns information about the specified HSM client certificate.
If no certificate ID is specified, returns information about all the HSM
certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift
returns all HSM client certificates that match any combination of the specified
keys and values. For example, if you have `owner` and `environment` for tag
keys, and `admin` and `test` for tag values, all HSM client certificates that
have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client
certificates are returned regardless of whether they have tag keys or values
associated with them.
"""
def describe_hsm_client_certificates(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeHsmClientCertificates", input, options)
end
@doc """
Returns information about the specified Amazon Redshift HSM configuration.
If no configuration ID is specified, returns information about all the HSM
configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift
returns all HSM connections that match any combination of the specified keys and
values. For example, if you have `owner` and `environment` for tag keys, and
`admin` and `test` for tag values, all HSM connections that have any combination
of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are
returned regardless of whether they have tag keys or values associated with
them.
"""
def describe_hsm_configurations(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeHsmConfigurations", input, options)
end
@doc """
Describes whether information, such as queries and connection attempts, is being
logged for the specified Amazon Redshift cluster.
"""
def describe_logging_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLoggingStatus", input, options)
end
@doc """
Returns properties of possible node configurations such as node type, number of
nodes, and disk usage for the specified action type.
"""
def describe_node_configuration_options(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeNodeConfigurationOptions", input, options)
end
@doc """
Returns a list of orderable cluster options.
Before you create a new cluster you can use this operation to find what options
are available, such as the EC2 Availability Zones (AZ) in the specific Amazon
Web Services Region that you can specify, and the node types you can request.
The node types differ by available storage, memory, CPU and price. With the cost
involved you might want to obtain a list of cluster options in the specific
region and specify values when creating a cluster. For more information about
managing clusters, go to [Amazon Redshift Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def describe_orderable_cluster_options(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeOrderableClusterOptions", input, options)
end
@doc """
Returns information about the partner integrations defined for a cluster.
"""
def describe_partners(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribePartners", input, options)
end
@doc """
Returns exchange status details and associated metadata for a reserved-node
exchange.
Statuses include such values as in progress and requested.
"""
def describe_reserved_node_exchange_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeReservedNodeExchangeStatus", input, options)
end
@doc """
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.
These descriptions help you determine which reserve node offering you want to
purchase. You then use the unique offering ID in you call to
`PurchaseReservedNodeOffering` to reserve one or more nodes for your Amazon
Redshift cluster.
For more information about reserved node offerings, go to [Purchasing Reserved Nodes](https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def describe_reserved_node_offerings(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeReservedNodeOfferings", input, options)
end
@doc """
Returns the descriptions of the reserved nodes.
"""
def describe_reserved_nodes(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeReservedNodes", input, options)
end
@doc """
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.
"""
def describe_resize(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeResize", input, options)
end
@doc """
Describes properties of scheduled actions.
"""
def describe_scheduled_actions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeScheduledActions", input, options)
end
@doc """
Returns a list of snapshot copy grants owned by the Amazon Web Services account
in the destination region.
For more information about managing snapshot copy grants, go to [Amazon Redshift Database
Encryption](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def describe_snapshot_copy_grants(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeSnapshotCopyGrants", input, options)
end
@doc """
Returns a list of snapshot schedules.
"""
def describe_snapshot_schedules(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeSnapshotSchedules", input, options)
end
@doc """
Returns account level backups storage size and provisional storage.
"""
def describe_storage(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeStorage", input, options)
end
@doc """
Lists the status of one or more table restore requests made using the
`RestoreTableFromClusterSnapshot` API action.
If you don't specify a value for the `TableRestoreRequestId` parameter, then
`DescribeTableRestoreStatus` returns the status of all table restore requests
ordered by the date and time of the request in ascending order. Otherwise
`DescribeTableRestoreStatus` returns the status of the table specified by
`TableRestoreRequestId`.
"""
def describe_table_restore_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeTableRestoreStatus", input, options)
end
@doc """
Returns a list of tags.
You can return tags from a specific resource by specifying an ARN, or you can
return all tags for a given type of resource, such as clusters, snapshots, and
so on.
The following are limitations for `DescribeTags`:
* You cannot specify an ARN and a resource-type value together in
the same request.
* You cannot use the `MaxRecords` and `Marker` parameters together
with the ARN parameter.
* The `MaxRecords` parameter can be a range from 10 to 50 results to
return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift
returns all resources that match any combination of the specified keys and
values. For example, if you have `owner` and `environment` for tag keys, and
`admin` and `test` for tag values, all resources that have any combination of
those values are returned.
If both tag keys and values are omitted from the request, resources are returned
regardless of whether they have tag keys or values associated with them.
"""
def describe_tags(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeTags", input, options)
end
@doc """
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.
"""
def describe_usage_limits(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeUsageLimits", input, options)
end
@doc """
Stops logging information, such as queries and connection attempts, for the
specified Amazon Redshift cluster.
"""
def disable_logging(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DisableLogging", input, options)
end
@doc """
Disables the automatic copying of snapshots from one region to another region
for a specified cluster.
If your cluster and its snapshots are encrypted using an encrypted symmetric key
from Key Management Service, use `DeleteSnapshotCopyGrant` to delete the grant
that grants Amazon Redshift permission to the key in the destination region.
"""
def disable_snapshot_copy(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DisableSnapshotCopy", input, options)
end
@doc """
From a datashare consumer account, remove association for the specified
datashare.
"""
def disassociate_data_share_consumer(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DisassociateDataShareConsumer", input, options)
end
@doc """
Starts logging information, such as queries and connection attempts, for the
specified Amazon Redshift cluster.
"""
def enable_logging(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "EnableLogging", input, options)
end
@doc """
Enables the automatic copy of snapshots from one region to another region for a
specified cluster.
"""
def enable_snapshot_copy(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "EnableSnapshotCopy", input, options)
end
@doc """
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](https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html)
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](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources)
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.
"""
def get_cluster_credentials(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetClusterCredentials", input, options)
end
@doc """
Returns a database user name and temporary password with temporary authorization
to log in to an Amazon Redshift database.
The database user is mapped 1:1 to the source Identity and Access Management
(IAM) identity. For more information about IAM identities, see [IAM Identities (users, user groups, and
roles)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html) in the Amazon
Web Services Identity and Access Management User Guide.
The Identity and Access Management (IAM) identity that runs this operation must
have an IAM policy attached that allows access to all necessary actions and
resources. For more information about permissions, see [Using identity-based policies (IAM
policies)](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html)
in the Amazon Redshift Cluster Management Guide.
"""
def get_cluster_credentials_with_iam(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetClusterCredentialsWithIAM", input, options)
end
@doc """
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.
"""
def get_reserved_node_exchange_configuration_options(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(
client,
meta,
"GetReservedNodeExchangeConfigurationOptions",
input,
options
)
end
@doc """
Returns an array of DC2 ReservedNodeOfferings that matches the payment type,
term, and usage price of the given DC1 reserved node.
"""
def get_reserved_node_exchange_offerings(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetReservedNodeExchangeOfferings", input, options)
end
@doc """
This operation is retired.
Calling this operation does not change AQUA configuration. Amazon Redshift
automatically determines whether to use AQUA (Advanced Query Accelerator).
"""
def modify_aqua_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyAquaConfiguration", input, options)
end
@doc """
Modifies an authentication profile.
"""
def modify_authentication_profile(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyAuthenticationProfile", input, options)
end
@doc """
Modifies the settings for a cluster.
You can also change node type and the number of nodes to scale up or down the
cluster. When resizing a cluster, you must specify both the number of nodes and
the node type even if one of the parameters does not change.
You can add another security or parameter group, or change the admin user
password. Resetting a cluster password or modifying the security groups
associated with a cluster do not need a reboot. However, modifying a parameter
group requires a reboot for parameters to take effect. For more information
about managing clusters, go to [Amazon Redshift Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def modify_cluster(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyCluster", input, options)
end
@doc """
Modifies the database revision of a cluster.
The database revision is a unique revision of the database running in a cluster.
"""
def modify_cluster_db_revision(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyClusterDbRevision", input, options)
end
@doc """
Modifies the list of Identity and Access Management (IAM) roles that can be used
by the cluster to access other Amazon Web Services services.
The maximum number of IAM roles that you can associate is subject to a quota.
For more information, go to [Quotas and limits](https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def modify_cluster_iam_roles(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyClusterIamRoles", input, options)
end
@doc """
Modifies the maintenance settings of a cluster.
"""
def modify_cluster_maintenance(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyClusterMaintenance", input, options)
end
@doc """
Modifies the parameters of a parameter group.
For the parameters parameter, it can't contain ASCII characters.
For more information about parameters and parameter groups, go to [Amazon Redshift Parameter
Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def modify_cluster_parameter_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyClusterParameterGroup", input, options)
end
@doc """
Modifies the settings for a snapshot.
This exanmple modifies the manual retention period setting for a cluster
snapshot.
"""
def modify_cluster_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyClusterSnapshot", input, options)
end
@doc """
Modifies a snapshot schedule for a cluster.
"""
def modify_cluster_snapshot_schedule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyClusterSnapshotSchedule", input, options)
end
@doc """
Modifies a cluster subnet group to include the specified list of VPC subnets.
The operation replaces the existing list of subnets with the new list of
subnets.
"""
def modify_cluster_subnet_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyClusterSubnetGroup", input, options)
end
@doc """
Modifies a Redshift-managed VPC endpoint.
"""
def modify_endpoint_access(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyEndpointAccess", input, options)
end
@doc """
Modifies an existing Amazon Redshift event notification subscription.
"""
def modify_event_subscription(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyEventSubscription", input, options)
end
@doc """
Modifies a scheduled action.
"""
def modify_scheduled_action(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyScheduledAction", input, options)
end
@doc """
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.
By default, this operation only changes the retention period of copied automated
snapshots. The retention periods for both new and existing copied automated
snapshots are updated with the new retention period. You can set the manual
option to change only the retention periods of copied manual snapshots. If you
set this option, only newly copied manual snapshots have the new retention
period.
"""
def modify_snapshot_copy_retention_period(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifySnapshotCopyRetentionPeriod", input, options)
end
@doc """
Modifies a snapshot schedule.
Any schedule associated with a cluster is modified asynchronously.
"""
def modify_snapshot_schedule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifySnapshotSchedule", input, options)
end
@doc """
Modifies a usage limit in a cluster.
You can't modify the feature type or period of a usage limit.
"""
def modify_usage_limit(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ModifyUsageLimit", input, options)
end
@doc """
Pauses a cluster.
"""
def pause_cluster(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PauseCluster", input, options)
end
@doc """
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](https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def purchase_reserved_node_offering(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PurchaseReservedNodeOffering", input, options)
end
@doc """
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](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def reboot_cluster(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RebootCluster", input, options)
end
@doc """
From a datashare consumer account, rejects the specified datashare.
"""
def reject_data_share(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RejectDataShare", input, options)
end
@doc """
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.
"""
def reset_cluster_parameter_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ResetClusterParameterGroup", input, options)
end
@doc """
Changes the size of the cluster.
You can change the cluster's type, or change the number or type of nodes. The
default behavior is to use the elastic resize method. With an elastic resize,
your cluster is available for read and write operations more quickly than with
the classic resize method.
Elastic resize operations have the following restrictions:
* You can only resize clusters of the following types:
* dc1.large (if your cluster is in a VPC)
* dc1.8xlarge (if your cluster is in a VPC)
* dc2.large
* dc2.8xlarge
* ds2.xlarge
* ds2.8xlarge
* ra3.xlplus
* ra3.4xlarge
* ra3.16xlarge
* The type of nodes that you add must match the node type for the
cluster.
"""
def resize_cluster(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ResizeCluster", input, options)
end
@doc """
Creates a new cluster from a snapshot.
By default, Amazon Redshift creates the resulting cluster with the same
configuration as the original cluster from which the snapshot was created,
except that the new cluster is created with the default cluster security and
parameter groups. After Amazon Redshift creates the cluster, you can use the
`ModifyCluster` API to associate a different security group and different
parameter group with the restored cluster. If you are using a DS node type, you
can also choose to change to another DS node type of the same size during
restore.
If you restore a cluster into a VPC, you must provide a cluster subnet group
where you want the cluster restored.
For more information about working with snapshots, go to [Amazon Redshift Snapshots](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def restore_from_cluster_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RestoreFromClusterSnapshot", input, options)
end
@doc """
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](https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved).
"""
def restore_table_from_cluster_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RestoreTableFromClusterSnapshot", input, options)
end
@doc """
Resumes a paused cluster.
"""
def resume_cluster(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ResumeCluster", input, options)
end
@doc """
Revokes an ingress rule in an Amazon Redshift security group for a previously
authorized IP range or Amazon EC2 security group.
To add an ingress rule, see `AuthorizeClusterSecurityGroupIngress`. For
information about managing security groups, go to [Amazon Redshift Cluster Security
Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def revoke_cluster_security_group_ingress(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RevokeClusterSecurityGroupIngress", input, options)
end
@doc """
Revokes access to a cluster.
"""
def revoke_endpoint_access(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RevokeEndpointAccess", input, options)
end
@doc """
Removes the ability of the specified Amazon Web Services account to restore the
specified snapshot.
If the account is currently restoring the snapshot, the restore will run to
completion.
For more information about working with snapshots, go to [Amazon Redshift Snapshots](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html)
in the *Amazon Redshift Cluster Management Guide*.
"""
def revoke_snapshot_access(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RevokeSnapshotAccess", input, options)
end
@doc """
Rotates the encryption keys for a cluster.
"""
def rotate_encryption_key(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RotateEncryptionKey", input, options)
end
@doc """
Updates the status of a partner integration.
"""
def update_partner_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdatePartnerStatus", input, options)
end
end
