Class: Aws::Redshift::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Redshift::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb
Overview
An API client for Redshift. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Redshift::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_reserved_node_exchange(params = {}) ⇒ Types::AcceptReservedNodeExchangeOutputMessage
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(params = {}) ⇒ Types::PartnerIntegrationOutputMessage
Adds a partner integration to a cluster.
-
#associate_data_share_consumer(params = {}) ⇒ Types::DataShare
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn).
-
#authorize_cluster_security_group_ingress(params = {}) ⇒ Types::AuthorizeClusterSecurityGroupIngressResult
Adds an inbound (ingress) rule to an Amazon Redshift security group.
-
#authorize_data_share(params = {}) ⇒ Types::DataShare
From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities.
-
#authorize_endpoint_access(params = {}) ⇒ Types::EndpointAuthorization
Grants access to a cluster.
-
#authorize_snapshot_access(params = {}) ⇒ Types::AuthorizeSnapshotAccessResult
Authorizes the specified Amazon Web Services account to restore the specified snapshot.
-
#batch_delete_cluster_snapshots(params = {}) ⇒ Types::BatchDeleteClusterSnapshotsResult
Deletes a set of cluster snapshots.
-
#batch_modify_cluster_snapshots(params = {}) ⇒ Types::BatchModifyClusterSnapshotsOutputMessage
Modifies the settings for a set of cluster snapshots.
-
#cancel_resize(params = {}) ⇒ Types::ResizeProgressMessage
Cancels a resize operation for a cluster.
-
#copy_cluster_snapshot(params = {}) ⇒ Types::CopyClusterSnapshotResult
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
-
#create_authentication_profile(params = {}) ⇒ Types::CreateAuthenticationProfileResult
Creates an authentication profile with the specified parameters.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResult
Creates a new cluster with the specified parameters.
-
#create_cluster_parameter_group(params = {}) ⇒ Types::CreateClusterParameterGroupResult
Creates an Amazon Redshift parameter group.
-
#create_cluster_security_group(params = {}) ⇒ Types::CreateClusterSecurityGroupResult
Creates a new Amazon Redshift security group.
-
#create_cluster_snapshot(params = {}) ⇒ Types::CreateClusterSnapshotResult
Creates a manual snapshot of the specified cluster.
-
#create_cluster_subnet_group(params = {}) ⇒ Types::CreateClusterSubnetGroupResult
Creates a new Amazon Redshift subnet group.
-
#create_custom_domain_association(params = {}) ⇒ Types::CreateCustomDomainAssociationResult
Used to create a custom domain name for a cluster.
-
#create_endpoint_access(params = {}) ⇒ Types::EndpointAccess
Creates a Redshift-managed VPC endpoint.
-
#create_event_subscription(params = {}) ⇒ Types::CreateEventSubscriptionResult
Creates an Amazon Redshift event notification subscription.
-
#create_hsm_client_certificate(params = {}) ⇒ Types::CreateHsmClientCertificateResult
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(params = {}) ⇒ Types::CreateHsmConfigurationResult
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_integration(params = {}) ⇒ Types::Integration
Creates a zero-ETL integration or S3 event integration with Amazon Redshift.
-
#create_redshift_idc_application(params = {}) ⇒ Types::CreateRedshiftIdcApplicationResult
Creates an Amazon Redshift application for use with IAM Identity Center.
-
#create_scheduled_action(params = {}) ⇒ Types::ScheduledAction
Creates a scheduled action.
-
#create_snapshot_copy_grant(params = {}) ⇒ Types::CreateSnapshotCopyGrantResult
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(params = {}) ⇒ Types::SnapshotSchedule
Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
-
#create_tags(params = {}) ⇒ Struct
Adds tags to a cluster.
-
#create_usage_limit(params = {}) ⇒ Types::UsageLimit
Creates a usage limit for a specified Amazon Redshift feature on a cluster.
-
#deauthorize_data_share(params = {}) ⇒ Types::DataShare
From a datashare producer account, removes authorization from the specified datashare.
-
#delete_authentication_profile(params = {}) ⇒ Types::DeleteAuthenticationProfileResult
Deletes an authentication profile.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResult
Deletes a previously provisioned cluster without its final snapshot being created.
-
#delete_cluster_parameter_group(params = {}) ⇒ Struct
Deletes a specified Amazon Redshift parameter group.
-
#delete_cluster_security_group(params = {}) ⇒ Struct
Deletes an Amazon Redshift security group.
-
#delete_cluster_snapshot(params = {}) ⇒ Types::DeleteClusterSnapshotResult
Deletes the specified manual snapshot.
-
#delete_cluster_subnet_group(params = {}) ⇒ Struct
Deletes the specified cluster subnet group.
-
#delete_custom_domain_association(params = {}) ⇒ Struct
Contains information about deleting a custom domain association for a cluster.
-
#delete_endpoint_access(params = {}) ⇒ Types::EndpointAccess
Deletes a Redshift-managed VPC endpoint.
-
#delete_event_subscription(params = {}) ⇒ Struct
Deletes an Amazon Redshift event notification subscription.
-
#delete_hsm_client_certificate(params = {}) ⇒ Struct
Deletes the specified HSM client certificate.
-
#delete_hsm_configuration(params = {}) ⇒ Struct
Deletes the specified Amazon Redshift HSM configuration.
-
#delete_integration(params = {}) ⇒ Types::Integration
Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.
-
#delete_partner(params = {}) ⇒ Types::PartnerIntegrationOutputMessage
Deletes a partner integration from a cluster.
-
#delete_redshift_idc_application(params = {}) ⇒ Struct
Deletes an Amazon Redshift IAM Identity Center application.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource policy for a specified resource.
-
#delete_scheduled_action(params = {}) ⇒ Struct
Deletes a scheduled action.
-
#delete_snapshot_copy_grant(params = {}) ⇒ Struct
Deletes the specified snapshot copy grant.
-
#delete_snapshot_schedule(params = {}) ⇒ Struct
Deletes a snapshot schedule.
-
#delete_tags(params = {}) ⇒ Struct
Deletes tags from a resource.
-
#delete_usage_limit(params = {}) ⇒ Struct
Deletes a usage limit from a cluster.
-
#deregister_namespace(params = {}) ⇒ Types::DeregisterNamespaceOutputMessage
Deregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog.
-
#describe_account_attributes(params = {}) ⇒ Types::AccountAttributeList
Returns a list of attributes attached to an account.
-
#describe_authentication_profiles(params = {}) ⇒ Types::DescribeAuthenticationProfilesResult
Describes an authentication profile.
-
#describe_cluster_db_revisions(params = {}) ⇒ Types::ClusterDbRevisionsMessage
Returns an array of
ClusterDbRevision
objects. -
#describe_cluster_parameter_groups(params = {}) ⇒ Types::ClusterParameterGroupsMessage
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.
-
#describe_cluster_parameters(params = {}) ⇒ Types::ClusterParameterGroupDetails
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
-
#describe_cluster_security_groups(params = {}) ⇒ Types::ClusterSecurityGroupMessage
Returns information about Amazon Redshift security groups.
-
#describe_cluster_snapshots(params = {}) ⇒ Types::SnapshotMessage
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
-
#describe_cluster_subnet_groups(params = {}) ⇒ Types::ClusterSubnetGroupMessage
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
-
#describe_cluster_tracks(params = {}) ⇒ Types::TrackListMessage
Returns a list of all the available maintenance tracks.
-
#describe_cluster_versions(params = {}) ⇒ Types::ClusterVersionsMessage
Returns descriptions of the available Amazon Redshift cluster versions.
-
#describe_clusters(params = {}) ⇒ Types::ClustersMessage
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties.
-
#describe_custom_domain_associations(params = {}) ⇒ Types::CustomDomainAssociationsMessage
Contains information about custom domain associations for a cluster.
-
#describe_data_shares(params = {}) ⇒ Types::DescribeDataSharesResult
Shows the status of any inbound or outbound datashares available in the specified account.
-
#describe_data_shares_for_consumer(params = {}) ⇒ Types::DescribeDataSharesForConsumerResult
Returns a list of datashares where the account identifier being called is a consumer account identifier.
-
#describe_data_shares_for_producer(params = {}) ⇒ Types::DescribeDataSharesForProducerResult
Returns a list of datashares when the account identifier being called is a producer account identifier.
-
#describe_default_cluster_parameters(params = {}) ⇒ Types::DescribeDefaultClusterParametersResult
Returns a list of parameter settings for the specified parameter group family.
-
#describe_endpoint_access(params = {}) ⇒ Types::EndpointAccessList
Describes a Redshift-managed VPC endpoint.
-
#describe_endpoint_authorization(params = {}) ⇒ Types::EndpointAuthorizationList
Describes an endpoint authorization.
-
#describe_event_categories(params = {}) ⇒ Types::EventCategoriesMessage
Displays a list of event categories for all event source types, or for a specified source type.
-
#describe_event_subscriptions(params = {}) ⇒ Types::EventSubscriptionsMessage
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
-
#describe_events(params = {}) ⇒ Types::EventsMessage
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
-
#describe_hsm_client_certificates(params = {}) ⇒ Types::HsmClientCertificateMessage
Returns information about the specified HSM client certificate.
-
#describe_hsm_configurations(params = {}) ⇒ Types::HsmConfigurationMessage
Returns information about the specified Amazon Redshift HSM configuration.
-
#describe_inbound_integrations(params = {}) ⇒ Types::InboundIntegrationsMessage
Returns a list of inbound integrations.
-
#describe_integrations(params = {}) ⇒ Types::IntegrationsMessage
Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.
-
#describe_logging_status(params = {}) ⇒ Types::LoggingStatus
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
-
#describe_node_configuration_options(params = {}) ⇒ Types::NodeConfigurationOptionsMessage
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(params = {}) ⇒ Types::OrderableClusterOptionsMessage
Returns a list of orderable cluster options.
-
#describe_partners(params = {}) ⇒ Types::DescribePartnersOutputMessage
Returns information about the partner integrations defined for a cluster.
-
#describe_redshift_idc_applications(params = {}) ⇒ Types::DescribeRedshiftIdcApplicationsResult
Lists the Amazon Redshift IAM Identity Center applications.
-
#describe_reserved_node_exchange_status(params = {}) ⇒ Types::DescribeReservedNodeExchangeStatusOutputMessage
Returns exchange status details and associated metadata for a reserved-node exchange.
-
#describe_reserved_node_offerings(params = {}) ⇒ Types::ReservedNodeOfferingsMessage
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(params = {}) ⇒ Types::ReservedNodesMessage
Returns the descriptions of the reserved nodes.
-
#describe_resize(params = {}) ⇒ Types::ResizeProgressMessage
Returns information about the last resize operation for the specified cluster.
-
#describe_scheduled_actions(params = {}) ⇒ Types::ScheduledActionsMessage
Describes properties of scheduled actions.
-
#describe_snapshot_copy_grants(params = {}) ⇒ Types::SnapshotCopyGrantMessage
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
-
#describe_snapshot_schedules(params = {}) ⇒ Types::DescribeSnapshotSchedulesOutputMessage
Returns a list of snapshot schedules.
-
#describe_storage(params = {}) ⇒ Types::CustomerStorageMessage
Returns account level backups storage size and provisional storage.
-
#describe_table_restore_status(params = {}) ⇒ Types::TableRestoreStatusMessage
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action.
-
#describe_tags(params = {}) ⇒ Types::TaggedResourceListMessage
Returns a list of tags.
-
#describe_usage_limits(params = {}) ⇒ Types::UsageLimitList
Shows usage limits on a cluster.
-
#disable_logging(params = {}) ⇒ Types::LoggingStatus
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
-
#disable_snapshot_copy(params = {}) ⇒ Types::DisableSnapshotCopyResult
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
-
#disassociate_data_share_consumer(params = {}) ⇒ Types::DataShare
From a datashare consumer account, remove association for the specified datashare.
-
#enable_logging(params = {}) ⇒ Types::LoggingStatus
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
-
#enable_snapshot_copy(params = {}) ⇒ Types::EnableSnapshotCopyResult
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
-
#failover_primary_compute(params = {}) ⇒ Types::FailoverPrimaryComputeResult
Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
-
#get_cluster_credentials(params = {}) ⇒ Types::ClusterCredentials
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database.
-
#get_cluster_credentials_with_iam(params = {}) ⇒ Types::ClusterExtendedCredentials
Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database.
-
#get_reserved_node_exchange_configuration_options(params = {}) ⇒ Types::GetReservedNodeExchangeConfigurationOptionsOutputMessage
Gets the configuration options for the reserved-node exchange.
-
#get_reserved_node_exchange_offerings(params = {}) ⇒ Types::GetReservedNodeExchangeOfferingsOutputMessage
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResult
Get the resource policy for a specified resource.
-
#list_recommendations(params = {}) ⇒ Types::ListRecommendationsResult
List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.
-
#modify_aqua_configuration(params = {}) ⇒ Types::ModifyAquaOutputMessage
This operation is retired.
-
#modify_authentication_profile(params = {}) ⇒ Types::ModifyAuthenticationProfileResult
Modifies an authentication profile.
-
#modify_cluster(params = {}) ⇒ Types::ModifyClusterResult
Modifies the settings for a cluster.
-
#modify_cluster_db_revision(params = {}) ⇒ Types::ModifyClusterDbRevisionResult
Modifies the database revision of a cluster.
-
#modify_cluster_iam_roles(params = {}) ⇒ Types::ModifyClusterIamRolesResult
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(params = {}) ⇒ Types::ModifyClusterMaintenanceResult
Modifies the maintenance settings of a cluster.
-
#modify_cluster_parameter_group(params = {}) ⇒ Types::ClusterParameterGroupNameMessage
Modifies the parameters of a parameter group.
-
#modify_cluster_snapshot(params = {}) ⇒ Types::ModifyClusterSnapshotResult
Modifies the settings for a snapshot.
-
#modify_cluster_snapshot_schedule(params = {}) ⇒ Struct
Modifies a snapshot schedule for a cluster.
-
#modify_cluster_subnet_group(params = {}) ⇒ Types::ModifyClusterSubnetGroupResult
Modifies a cluster subnet group to include the specified list of VPC subnets.
-
#modify_custom_domain_association(params = {}) ⇒ Types::ModifyCustomDomainAssociationResult
Contains information for changing a custom domain association.
-
#modify_endpoint_access(params = {}) ⇒ Types::EndpointAccess
Modifies a Redshift-managed VPC endpoint.
-
#modify_event_subscription(params = {}) ⇒ Types::ModifyEventSubscriptionResult
Modifies an existing Amazon Redshift event notification subscription.
-
#modify_integration(params = {}) ⇒ Types::Integration
Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.
-
#modify_redshift_idc_application(params = {}) ⇒ Types::ModifyRedshiftIdcApplicationResult
Changes an existing Amazon Redshift IAM Identity Center application.
-
#modify_scheduled_action(params = {}) ⇒ Types::ScheduledAction
Modifies a scheduled action.
-
#modify_snapshot_copy_retention_period(params = {}) ⇒ Types::ModifySnapshotCopyRetentionPeriodResult
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(params = {}) ⇒ Types::SnapshotSchedule
Modifies a snapshot schedule.
-
#modify_usage_limit(params = {}) ⇒ Types::UsageLimit
Modifies a usage limit in a cluster.
-
#pause_cluster(params = {}) ⇒ Types::PauseClusterResult
Pauses a cluster.
-
#purchase_reserved_node_offering(params = {}) ⇒ Types::PurchaseReservedNodeOfferingResult
Allows you to purchase reserved nodes.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult
Updates the resource policy for a specified resource.
-
#reboot_cluster(params = {}) ⇒ Types::RebootClusterResult
Reboots a cluster.
-
#register_namespace(params = {}) ⇒ Types::RegisterNamespaceOutputMessage
Registers a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.
-
#reject_data_share(params = {}) ⇒ Types::DataShare
From a datashare consumer account, rejects the specified datashare.
-
#reset_cluster_parameter_group(params = {}) ⇒ Types::ClusterParameterGroupNameMessage
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(params = {}) ⇒ Types::ResizeClusterResult
Changes the size of the cluster.
-
#restore_from_cluster_snapshot(params = {}) ⇒ Types::RestoreFromClusterSnapshotResult
Creates a new cluster from a snapshot.
-
#restore_table_from_cluster_snapshot(params = {}) ⇒ Types::RestoreTableFromClusterSnapshotResult
Creates a new table from a table in an Amazon Redshift cluster snapshot.
-
#resume_cluster(params = {}) ⇒ Types::ResumeClusterResult
Resumes a paused cluster.
-
#revoke_cluster_security_group_ingress(params = {}) ⇒ Types::RevokeClusterSecurityGroupIngressResult
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group.
-
#revoke_endpoint_access(params = {}) ⇒ Types::EndpointAuthorization
Revokes access to a cluster.
-
#revoke_snapshot_access(params = {}) ⇒ Types::RevokeSnapshotAccessResult
Removes the ability of the specified Amazon Web Services account to restore the specified snapshot.
-
#rotate_encryption_key(params = {}) ⇒ Types::RotateEncryptionKeyResult
Rotates the encryption keys for a cluster.
-
#update_partner_status(params = {}) ⇒ Types::PartnerIntegrationOutputMessage
Updates the status of a partner integration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#accept_reserved_node_exchange(params = {}) ⇒ Types::AcceptReservedNodeExchangeOutputMessage
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.
525 526 527 528 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 525 def accept_reserved_node_exchange(params = {}, = {}) req = build_request(:accept_reserved_node_exchange, params) req.send_request() end |
#add_partner(params = {}) ⇒ Types::PartnerIntegrationOutputMessage
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.
571 572 573 574 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 571 def add_partner(params = {}, = {}) req = build_request(:add_partner, params) req.send_request() end |
#associate_data_share_consumer(params = {}) ⇒ Types::DataShare
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.
640 641 642 643 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 640 def associate_data_share_consumer(params = {}, = {}) req = build_request(:associate_data_share_consumer, params) req.send_request() end |
#authorize_cluster_security_group_ingress(params = {}) ⇒ Types::AuthorizeClusterSecurityGroupIngressResult
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.
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 in the Amazon Redshift Cluster Management Guide.
726 727 728 729 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 726 def (params = {}, = {}) req = build_request(:authorize_cluster_security_group_ingress, params) req.send_request() end |
#authorize_data_share(params = {}) ⇒ Types::DataShare
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.
785 786 787 788 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 785 def (params = {}, = {}) req = build_request(:authorize_data_share, params) req.send_request() end |
#authorize_endpoint_access(params = {}) ⇒ Types::EndpointAuthorization
Grants access to a cluster.
838 839 840 841 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 838 def (params = {}, = {}) req = build_request(:authorize_endpoint_access, params) req.send_request() end |
#authorize_snapshot_access(params = {}) ⇒ Types::AuthorizeSnapshotAccessResult
Authorizes the specified Amazon Web Services account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
941 942 943 944 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 941 def (params = {}, = {}) req = build_request(:authorize_snapshot_access, params) req.send_request() end |
#batch_delete_cluster_snapshots(params = {}) ⇒ Types::BatchDeleteClusterSnapshotsResult
Deletes a set of cluster snapshots.
981 982 983 984 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 981 def batch_delete_cluster_snapshots(params = {}, = {}) req = build_request(:batch_delete_cluster_snapshots, params) req.send_request() end |
#batch_modify_cluster_snapshots(params = {}) ⇒ Types::BatchModifyClusterSnapshotsOutputMessage
Modifies the settings for a set of cluster snapshots.
1033 1034 1035 1036 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1033 def batch_modify_cluster_snapshots(params = {}, = {}) req = build_request(:batch_modify_cluster_snapshots, params) req.send_request() end |
#cancel_resize(params = {}) ⇒ Types::ResizeProgressMessage
Cancels a resize operation for a cluster.
1095 1096 1097 1098 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1095 def cancel_resize(params = {}, = {}) req = build_request(:cancel_resize, params) req.send_request() end |
#copy_cluster_snapshot(params = {}) ⇒ Types::CopyClusterSnapshotResult
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 in the Amazon Redshift Cluster Management Guide.
1227 1228 1229 1230 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1227 def copy_cluster_snapshot(params = {}, = {}) req = build_request(:copy_cluster_snapshot, params) req.send_request() end |
#create_authentication_profile(params = {}) ⇒ Types::CreateAuthenticationProfileResult
Creates an authentication profile with the specified parameters.
1262 1263 1264 1265 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1262 def create_authentication_profile(params = {}, = {}) req = build_request(:create_authentication_profile, params) req.send_request() end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResult
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 in the Amazon Redshift Cluster Management Guide.
VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:
Creating a public cluster
Restoring a public cluster
Modifying a private cluster to be public
Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group
For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
1876 1877 1878 1879 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1876 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_cluster_parameter_group(params = {}) ⇒ Types::CreateClusterParameterGroupResult
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 in the Amazon Redshift Cluster Management Guide.
1965 1966 1967 1968 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1965 def create_cluster_parameter_group(params = {}, = {}) req = build_request(:create_cluster_parameter_group, params) req.send_request() end |
#create_cluster_security_group(params = {}) ⇒ Types::CreateClusterSecurityGroupResult
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 in the Amazon Redshift Cluster Management Guide.
2044 2045 2046 2047 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2044 def create_cluster_security_group(params = {}, = {}) req = build_request(:create_cluster_security_group, params) req.send_request() end |
#create_cluster_snapshot(params = {}) ⇒ Types::CreateClusterSnapshotResult
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 in the Amazon Redshift Cluster Management Guide.
2158 2159 2160 2161 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2158 def create_cluster_snapshot(params = {}, = {}) req = build_request(:create_cluster_snapshot, params) req.send_request() end |
#create_cluster_subnet_group(params = {}) ⇒ Types::CreateClusterSubnetGroupResult
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 in the Amazon Redshift Cluster Management Guide.
2239 2240 2241 2242 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2239 def create_cluster_subnet_group(params = {}, = {}) req = build_request(:create_cluster_subnet_group, params) req.send_request() end |
#create_custom_domain_association(params = {}) ⇒ Types::CreateCustomDomainAssociationResult
Used to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the certificate Amazon Resource Name (ARN).
2284 2285 2286 2287 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2284 def create_custom_domain_association(params = {}, = {}) req = build_request(:create_custom_domain_association, params) req.send_request() end |
#create_endpoint_access(params = {}) ⇒ Types::EndpointAccess
Creates a Redshift-managed VPC endpoint.
2363 2364 2365 2366 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2363 def create_endpoint_access(params = {}, = {}) req = build_request(:create_endpoint_access, params) req.send_request() end |
#create_event_subscription(params = {}) ⇒ Types::CreateEventSubscriptionResult
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.
2498 2499 2500 2501 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2498 def create_event_subscription(params = {}, = {}) req = build_request(:create_event_subscription, params) req.send_request() end |
#create_hsm_client_certificate(params = {}) ⇒ Types::CreateHsmClientCertificateResult
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
2554 2555 2556 2557 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2554 def create_hsm_client_certificate(params = {}, = {}) req = build_request(:create_hsm_client_certificate, params) req.send_request() end |
#create_hsm_configuration(params = {}) ⇒ Types::CreateHsmConfigurationResult
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 in the Amazon Redshift Cluster Management Guide.
2633 2634 2635 2636 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2633 def create_hsm_configuration(params = {}, = {}) req = build_request(:create_hsm_configuration, params) req.send_request() end |
#create_integration(params = {}) ⇒ Types::Integration
Creates a zero-ETL integration or S3 event integration with Amazon Redshift.
2732 2733 2734 2735 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2732 def create_integration(params = {}, = {}) req = build_request(:create_integration, params) req.send_request() end |
#create_redshift_idc_application(params = {}) ⇒ Types::CreateRedshiftIdcApplicationResult
Creates an Amazon Redshift application for use with IAM Identity Center.
2851 2852 2853 2854 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2851 def create_redshift_idc_application(params = {}, = {}) req = build_request(:create_redshift_idc_application, params) req.send_request() end |
#create_scheduled_action(params = {}) ⇒ Types::ScheduledAction
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.
2962 2963 2964 2965 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2962 def create_scheduled_action(params = {}, = {}) req = build_request(:create_scheduled_action, params) req.send_request() end |
#create_snapshot_copy_grant(params = {}) ⇒ Types::CreateSnapshotCopyGrantResult
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 in the Amazon Redshift Cluster Management Guide.
3033 3034 3035 3036 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3033 def create_snapshot_copy_grant(params = {}, = {}) req = build_request(:create_snapshot_copy_grant, params) req.send_request() end |
#create_snapshot_schedule(params = {}) ⇒ Types::SnapshotSchedule
Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
3106 3107 3108 3109 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3106 def create_snapshot_schedule(params = {}, = {}) req = build_request(:create_snapshot_schedule, params) req.send_request() end |
#create_tags(params = {}) ⇒ Struct
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.
3150 3151 3152 3153 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3150 def (params = {}, = {}) req = build_request(:create_tags, params) req.send_request() end |
#create_usage_limit(params = {}) ⇒ Types::UsageLimit
Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
3235 3236 3237 3238 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3235 def create_usage_limit(params = {}, = {}) req = build_request(:create_usage_limit, params) req.send_request() end |
#deauthorize_data_share(params = {}) ⇒ Types::DataShare
From a datashare producer account, removes authorization from the specified datashare.
3288 3289 3290 3291 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3288 def (params = {}, = {}) req = build_request(:deauthorize_data_share, params) req.send_request() end |
#delete_authentication_profile(params = {}) ⇒ Types::DeleteAuthenticationProfileResult
Deletes an authentication profile.
3316 3317 3318 3319 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3316 def delete_authentication_profile(params = {}, = {}) req = build_request(:delete_authentication_profile, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResult
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 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 in the Amazon Redshift Cluster Management Guide.
3542 3543 3544 3545 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3542 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_cluster_parameter_group(params = {}) ⇒ Struct
Deletes a specified Amazon Redshift parameter group.
3575 3576 3577 3578 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3575 def delete_cluster_parameter_group(params = {}, = {}) req = build_request(:delete_cluster_parameter_group, params) req.send_request() end |
#delete_cluster_security_group(params = {}) ⇒ Struct
Deletes an Amazon Redshift security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
3610 3611 3612 3613 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3610 def delete_cluster_security_group(params = {}, = {}) req = build_request(:delete_cluster_security_group, params) req.send_request() end |
#delete_cluster_snapshot(params = {}) ⇒ Types::DeleteClusterSnapshotResult
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.
3700 3701 3702 3703 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3700 def delete_cluster_snapshot(params = {}, = {}) req = build_request(:delete_cluster_snapshot, params) req.send_request() end |
#delete_cluster_subnet_group(params = {}) ⇒ Struct
Deletes the specified cluster subnet group.
3722 3723 3724 3725 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3722 def delete_cluster_subnet_group(params = {}, = {}) req = build_request(:delete_cluster_subnet_group, params) req.send_request() end |
#delete_custom_domain_association(params = {}) ⇒ Struct
Contains information about deleting a custom domain association for a cluster.
3750 3751 3752 3753 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3750 def delete_custom_domain_association(params = {}, = {}) req = build_request(:delete_custom_domain_association, params) req.send_request() end |
#delete_endpoint_access(params = {}) ⇒ Types::EndpointAccess
Deletes a Redshift-managed VPC endpoint.
3805 3806 3807 3808 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3805 def delete_endpoint_access(params = {}, = {}) req = build_request(:delete_endpoint_access, params) req.send_request() end |
#delete_event_subscription(params = {}) ⇒ Struct
Deletes an Amazon Redshift event notification subscription.
3828 3829 3830 3831 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3828 def delete_event_subscription(params = {}, = {}) req = build_request(:delete_event_subscription, params) req.send_request() end |
#delete_hsm_client_certificate(params = {}) ⇒ Struct
Deletes the specified HSM client certificate.
3850 3851 3852 3853 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3850 def delete_hsm_client_certificate(params = {}, = {}) req = build_request(:delete_hsm_client_certificate, params) req.send_request() end |
#delete_hsm_configuration(params = {}) ⇒ Struct
Deletes the specified Amazon Redshift HSM configuration.
3872 3873 3874 3875 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3872 def delete_hsm_configuration(params = {}, = {}) req = build_request(:delete_hsm_configuration, params) req.send_request() end |
#delete_integration(params = {}) ⇒ Types::Integration
Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.
3926 3927 3928 3929 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3926 def delete_integration(params = {}, = {}) req = build_request(:delete_integration, params) req.send_request() end |
#delete_partner(params = {}) ⇒ Types::PartnerIntegrationOutputMessage
Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.
3971 3972 3973 3974 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3971 def delete_partner(params = {}, = {}) req = build_request(:delete_partner, params) req.send_request() end |
#delete_redshift_idc_application(params = {}) ⇒ Struct
Deletes an Amazon Redshift IAM Identity Center application.
3993 3994 3995 3996 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3993 def delete_redshift_idc_application(params = {}, = {}) req = build_request(:delete_redshift_idc_application, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource policy for a specified resource.
4016 4017 4018 4019 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4016 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#delete_scheduled_action(params = {}) ⇒ Struct
Deletes a scheduled action.
4038 4039 4040 4041 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4038 def delete_scheduled_action(params = {}, = {}) req = build_request(:delete_scheduled_action, params) req.send_request() end |
#delete_snapshot_copy_grant(params = {}) ⇒ Struct
Deletes the specified snapshot copy grant.
4060 4061 4062 4063 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4060 def delete_snapshot_copy_grant(params = {}, = {}) req = build_request(:delete_snapshot_copy_grant, params) req.send_request() end |
#delete_snapshot_schedule(params = {}) ⇒ Struct
Deletes a snapshot schedule.
4082 4083 4084 4085 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4082 def delete_snapshot_schedule(params = {}, = {}) req = build_request(:delete_snapshot_schedule, params) req.send_request() end |
#delete_tags(params = {}) ⇒ Struct
Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
4111 4112 4113 4114 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4111 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_usage_limit(params = {}) ⇒ Struct
Deletes a usage limit from a cluster.
4133 4134 4135 4136 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4133 def delete_usage_limit(params = {}, = {}) req = build_request(:delete_usage_limit, params) req.send_request() end |
#deregister_namespace(params = {}) ⇒ Types::DeregisterNamespaceOutputMessage
Deregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog.
4176 4177 4178 4179 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4176 def deregister_namespace(params = {}, = {}) req = build_request(:deregister_namespace, params) req.send_request() end |
#describe_account_attributes(params = {}) ⇒ Types::AccountAttributeList
Returns a list of attributes attached to an account
4207 4208 4209 4210 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4207 def describe_account_attributes(params = {}, = {}) req = build_request(:describe_account_attributes, params) req.send_request() end |
#describe_authentication_profiles(params = {}) ⇒ Types::DescribeAuthenticationProfilesResult
Describes an authentication profile.
4238 4239 4240 4241 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4238 def describe_authentication_profiles(params = {}, = {}) req = build_request(:describe_authentication_profiles, params) req.send_request() end |
#describe_cluster_db_revisions(params = {}) ⇒ Types::ClusterDbRevisionsMessage
Returns an array of ClusterDbRevision
objects.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4305 4306 4307 4308 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4305 def describe_cluster_db_revisions(params = {}, = {}) req = build_request(:describe_cluster_db_revisions, params) req.send_request() end |
#describe_cluster_parameter_groups(params = {}) ⇒ Types::ClusterParameterGroupsMessage
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 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4411 4412 4413 4414 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4411 def describe_cluster_parameter_groups(params = {}, = {}) req = build_request(:describe_cluster_parameter_groups, params) req.send_request() end |
#describe_cluster_parameters(params = {}) ⇒ Types::ClusterParameterGroupDetails
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4500 4501 4502 4503 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4500 def describe_cluster_parameters(params = {}, = {}) req = build_request(:describe_cluster_parameters, params) req.send_request() end |
#describe_cluster_security_groups(params = {}) ⇒ Types::ClusterSecurityGroupMessage
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 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4620 4621 4622 4623 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4620 def describe_cluster_security_groups(params = {}, = {}) req = build_request(:describe_cluster_security_groups, params) req.send_request() end |
#describe_cluster_snapshots(params = {}) ⇒ Types::SnapshotMessage
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- snapshot_available
4835 4836 4837 4838 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4835 def describe_cluster_snapshots(params = {}, = {}) req = build_request(:describe_cluster_snapshots, params) req.send_request() end |
#describe_cluster_subnet_groups(params = {}) ⇒ Types::ClusterSubnetGroupMessage
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4938 4939 4940 4941 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4938 def describe_cluster_subnet_groups(params = {}, = {}) req = build_request(:describe_cluster_subnet_groups, params) req.send_request() end |
#describe_cluster_tracks(params = {}) ⇒ Types::TrackListMessage
Returns a list of all the available maintenance tracks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4991 4992 4993 4994 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4991 def describe_cluster_tracks(params = {}, = {}) req = build_request(:describe_cluster_tracks, params) req.send_request() end |
#describe_cluster_versions(params = {}) ⇒ Types::ClusterVersionsMessage
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 in the Amazon Redshift Cluster Management Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5071 5072 5073 5074 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5071 def describe_cluster_versions(params = {}, = {}) req = build_request(:describe_cluster_versions, params) req.send_request() end |
#describe_clusters(params = {}) ⇒ Types::ClustersMessage
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 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- cluster_available
- cluster_deleted
- cluster_restored
5307 5308 5309 5310 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5307 def describe_clusters(params = {}, = {}) req = build_request(:describe_clusters, params) req.send_request() end |
#describe_custom_domain_associations(params = {}) ⇒ Types::CustomDomainAssociationsMessage
Contains information about custom domain associations for a cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5357 5358 5359 5360 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5357 def describe_custom_domain_associations(params = {}, = {}) req = build_request(:describe_custom_domain_associations, params) req.send_request() end |
#describe_data_shares(params = {}) ⇒ Types::DescribeDataSharesResult
Shows the status of any inbound or outbound datashares available in the specified account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5422 5423 5424 5425 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5422 def describe_data_shares(params = {}, = {}) req = build_request(:describe_data_shares, params) req.send_request() end |
#describe_data_shares_for_consumer(params = {}) ⇒ Types::DescribeDataSharesForConsumerResult
Returns a list of datashares where the account identifier being called is a consumer account identifier.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5493 5494 5495 5496 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5493 def describe_data_shares_for_consumer(params = {}, = {}) req = build_request(:describe_data_shares_for_consumer, params) req.send_request() end |
#describe_data_shares_for_producer(params = {}) ⇒ Types::DescribeDataSharesForProducerResult
Returns a list of datashares when the account identifier being called is a producer account identifier.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5564 5565 5566 5567 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5564 def describe_data_shares_for_producer(params = {}, = {}) req = build_request(:describe_data_shares_for_producer, params) req.send_request() end |
#describe_default_cluster_parameters(params = {}) ⇒ Types::DescribeDefaultClusterParametersResult
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 in the Amazon Redshift Cluster Management Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5636 5637 5638 5639 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5636 def describe_default_cluster_parameters(params = {}, = {}) req = build_request(:describe_default_cluster_parameters, params) req.send_request() end |
#describe_endpoint_access(params = {}) ⇒ Types::EndpointAccessList
Describes a Redshift-managed VPC endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5713 5714 5715 5716 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5713 def describe_endpoint_access(params = {}, = {}) req = build_request(:describe_endpoint_access, params) req.send_request() end |
#describe_endpoint_authorization(params = {}) ⇒ Types::EndpointAuthorizationList
Describes an endpoint authorization.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5782 5783 5784 5785 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5782 def (params = {}, = {}) req = build_request(:describe_endpoint_authorization, params) req.send_request() end |
#describe_event_categories(params = {}) ⇒ Types::EventCategoriesMessage
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.
5827 5828 5829 5830 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5827 def describe_event_categories(params = {}, = {}) req = build_request(:describe_event_categories, params) req.send_request() end |
#describe_event_subscriptions(params = {}) ⇒ Types::EventSubscriptionsMessage
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5930 5931 5932 5933 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5930 def describe_event_subscriptions(params = {}, = {}) req = build_request(:describe_event_subscriptions, params) req.send_request() end |
#describe_events(params = {}) ⇒ Types::EventsMessage
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6065 6066 6067 6068 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6065 def describe_events(params = {}, = {}) req = build_request(:describe_events, params) req.send_request() end |
#describe_hsm_client_certificates(params = {}) ⇒ Types::HsmClientCertificateMessage
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6160 6161 6162 6163 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6160 def describe_hsm_client_certificates(params = {}, = {}) req = build_request(:describe_hsm_client_certificates, params) req.send_request() end |
#describe_hsm_configurations(params = {}) ⇒ Types::HsmConfigurationMessage
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6257 6258 6259 6260 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6257 def describe_hsm_configurations(params = {}, = {}) req = build_request(:describe_hsm_configurations, params) req.send_request() end |
#describe_inbound_integrations(params = {}) ⇒ Types::InboundIntegrationsMessage
Returns a list of inbound integrations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6324 6325 6326 6327 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6324 def describe_inbound_integrations(params = {}, = {}) req = build_request(:describe_inbound_integrations, params) req.send_request() end |
#describe_integrations(params = {}) ⇒ Types::IntegrationsMessage
Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6401 6402 6403 6404 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6401 def describe_integrations(params = {}, = {}) req = build_request(:describe_integrations, params) req.send_request() end |
#describe_logging_status(params = {}) ⇒ Types::LoggingStatus
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
6447 6448 6449 6450 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6447 def describe_logging_status(params = {}, = {}) req = build_request(:describe_logging_status, params) req.send_request() end |
#describe_node_configuration_options(params = {}) ⇒ Types::NodeConfigurationOptionsMessage
Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6542 6543 6544 6545 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6542 def (params = {}, = {}) req = build_request(:describe_node_configuration_options, params) req.send_request() end |
#describe_orderable_cluster_options(params = {}) ⇒ Types::OrderableClusterOptionsMessage
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 in the Amazon Redshift Cluster Management Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6627 6628 6629 6630 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6627 def (params = {}, = {}) req = build_request(:describe_orderable_cluster_options, params) req.send_request() end |
#describe_partners(params = {}) ⇒ Types::DescribePartnersOutputMessage
Returns information about the partner integrations defined for a cluster.
6678 6679 6680 6681 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6678 def describe_partners(params = {}, = {}) req = build_request(:describe_partners, params) req.send_request() end |
#describe_redshift_idc_applications(params = {}) ⇒ Types::DescribeRedshiftIdcApplicationsResult
Lists the Amazon Redshift IAM Identity Center applications.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6750 6751 6752 6753 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6750 def describe_redshift_idc_applications(params = {}, = {}) req = build_request(:describe_redshift_idc_applications, params) req.send_request() end |
#describe_reserved_node_exchange_status(params = {}) ⇒ Types::DescribeReservedNodeExchangeStatusOutputMessage
Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6815 6816 6817 6818 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6815 def describe_reserved_node_exchange_status(params = {}, = {}) req = build_request(:describe_reserved_node_exchange_status, params) req.send_request() end |
#describe_reserved_node_offerings(params = {}) ⇒ Types::ReservedNodeOfferingsMessage
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 in the Amazon Redshift Cluster Management Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6893 6894 6895 6896 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6893 def describe_reserved_node_offerings(params = {}, = {}) req = build_request(:describe_reserved_node_offerings, params) req.send_request() end |
#describe_reserved_nodes(params = {}) ⇒ Types::ReservedNodesMessage
Returns the descriptions of the reserved nodes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6962 6963 6964 6965 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6962 def describe_reserved_nodes(params = {}, = {}) req = build_request(:describe_reserved_nodes, params) req.send_request() end |
#describe_resize(params = {}) ⇒ Types::ResizeProgressMessage
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.
7034 7035 7036 7037 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7034 def describe_resize(params = {}, = {}) req = build_request(:describe_resize, params) req.send_request() end |
#describe_scheduled_actions(params = {}) ⇒ Types::ScheduledActionsMessage
Describes properties of scheduled actions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7136 7137 7138 7139 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7136 def describe_scheduled_actions(params = {}, = {}) req = build_request(:describe_scheduled_actions, params) req.send_request() end |
#describe_snapshot_copy_grants(params = {}) ⇒ Types::SnapshotCopyGrantMessage
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 in the Amazon Redshift Cluster Management Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7225 7226 7227 7228 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7225 def describe_snapshot_copy_grants(params = {}, = {}) req = build_request(:describe_snapshot_copy_grants, params) req.send_request() end |
#describe_snapshot_schedules(params = {}) ⇒ Types::DescribeSnapshotSchedulesOutputMessage
Returns a list of snapshot schedules.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7300 7301 7302 7303 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7300 def describe_snapshot_schedules(params = {}, = {}) req = build_request(:describe_snapshot_schedules, params) req.send_request() end |
#describe_storage(params = {}) ⇒ Types::CustomerStorageMessage
Returns account level backups storage size and provisional storage.
7321 7322 7323 7324 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7321 def describe_storage(params = {}, = {}) req = build_request(:describe_storage, params) req.send_request() end |
#describe_table_restore_status(params = {}) ⇒ Types::TableRestoreStatusMessage
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
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7394 7395 7396 7397 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7394 def describe_table_restore_status(params = {}, = {}) req = build_request(:describe_table_restore_status, params) req.send_request() end |
#describe_tags(params = {}) ⇒ Types::TaggedResourceListMessage
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
andMarker
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7532 7533 7534 7535 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7532 def (params = {}, = {}) req = build_request(:describe_tags, params) req.send_request() end |
#describe_usage_limits(params = {}) ⇒ Types::UsageLimitList
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7641 7642 7643 7644 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7641 def describe_usage_limits(params = {}, = {}) req = build_request(:describe_usage_limits, params) req.send_request() end |
#disable_logging(params = {}) ⇒ Types::LoggingStatus
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
7687 7688 7689 7690 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7687 def disable_logging(params = {}, = {}) req = build_request(:disable_logging, params) req.send_request() end |
#disable_snapshot_copy(params = {}) ⇒ Types::DisableSnapshotCopyResult
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.
7855 7856 7857 7858 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7855 def disable_snapshot_copy(params = {}, = {}) req = build_request(:disable_snapshot_copy, params) req.send_request() end |
#disassociate_data_share_consumer(params = {}) ⇒ Types::DataShare
From a datashare consumer account, remove association for the specified datashare.
7918 7919 7920 7921 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7918 def disassociate_data_share_consumer(params = {}, = {}) req = build_request(:disassociate_data_share_consumer, params) req.send_request() end |
#enable_logging(params = {}) ⇒ Types::LoggingStatus
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
7994 7995 7996 7997 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7994 def enable_logging(params = {}, = {}) req = build_request(:enable_logging, params) req.send_request() end |
#enable_snapshot_copy(params = {}) ⇒ Types::EnableSnapshotCopyResult
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
8193 8194 8195 8196 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8193 def enable_snapshot_copy(params = {}, = {}) req = build_request(:enable_snapshot_copy, params) req.send_request() end |
#failover_primary_compute(params = {}) ⇒ Types::FailoverPrimaryComputeResult
Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
8353 8354 8355 8356 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8353 def failover_primary_compute(params = {}, = {}) req = build_request(:failover_primary_compute, params) req.send_request() end |
#get_cluster_credentials(params = {}) ⇒ Types::ClusterCredentials
Returns a database user name and temporary password with temporary
authorization to log on to an Amazon Redshift database. The action
returns the database user name prefixed with IAM:
if AutoCreate
is
False
or IAMA:
if AutoCreate
is True
. You can optionally
specify one or more database user groups that the user will join at
log on. By default, the temporary credentials expire in 900 seconds.
You can optionally specify a duration between 900 seconds (15 minutes)
and 3600 seconds (60 minutes). For more information, see Using IAM
Authentication to Generate Database User Credentials in the Amazon
Redshift Cluster Management Guide.
The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups
parameter is specified, the IAM policy must allow
the redshift:JoinGroup
action with access to the listed dbgroups
.
In addition, if the AutoCreate
parameter is set to True
, then the
policy must include the redshift:CreateClusterUser
permission.
If the DbName
parameter is specified, the IAM policy must allow
access to the resource dbname
for the specified database name.
8517 8518 8519 8520 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8517 def get_cluster_credentials(params = {}, = {}) req = build_request(:get_cluster_credentials, params) req.send_request() end |
#get_cluster_credentials_with_iam(params = {}) ⇒ Types::ClusterExtendedCredentials
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) 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) in the Amazon Redshift Cluster Management Guide.
8585 8586 8587 8588 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8585 def get_cluster_credentials_with_iam(params = {}, = {}) req = build_request(:get_cluster_credentials_with_iam, params) req.send_request() end |
#get_reserved_node_exchange_configuration_options(params = {}) ⇒ Types::GetReservedNodeExchangeConfigurationOptionsOutputMessage
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8676 8677 8678 8679 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8676 def (params = {}, = {}) req = build_request(:get_reserved_node_exchange_configuration_options, params) req.send_request() end |
#get_reserved_node_exchange_offerings(params = {}) ⇒ Types::GetReservedNodeExchangeOfferingsOutputMessage
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8731 8732 8733 8734 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8731 def get_reserved_node_exchange_offerings(params = {}, = {}) req = build_request(:get_reserved_node_exchange_offerings, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResult
Get the resource policy for a specified resource.
8761 8762 8763 8764 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8761 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() end |
#list_recommendations(params = {}) ⇒ Types::ListRecommendationsResult
List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8841 8842 8843 8844 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8841 def list_recommendations(params = {}, = {}) req = build_request(:list_recommendations, params) req.send_request() end |
#modify_aqua_configuration(params = {}) ⇒ Types::ModifyAquaOutputMessage
This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
8877 8878 8879 8880 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8877 def modify_aqua_configuration(params = {}, = {}) req = build_request(:modify_aqua_configuration, params) req.send_request() end |
#modify_authentication_profile(params = {}) ⇒ Types::ModifyAuthenticationProfileResult
Modifies an authentication profile.
8913 8914 8915 8916 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8913 def modify_authentication_profile(params = {}, = {}) req = build_request(:modify_authentication_profile, params) req.send_request() end |
#modify_cluster(params = {}) ⇒ Types::ModifyClusterResult
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 in the Amazon Redshift Cluster Management Guide.
VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:
Creating a public cluster
Restoring a public cluster
Modifying a private cluster to be public
Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group
For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
9430 9431 9432 9433 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9430 def modify_cluster(params = {}, = {}) req = build_request(:modify_cluster, params) req.send_request() end |
#modify_cluster_db_revision(params = {}) ⇒ Types::ModifyClusterDbRevisionResult
Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
9597 9598 9599 9600 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9597 def modify_cluster_db_revision(params = {}, = {}) req = build_request(:modify_cluster_db_revision, params) req.send_request() end |
#modify_cluster_iam_roles(params = {}) ⇒ Types::ModifyClusterIamRolesResult
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 in the Amazon Redshift Cluster Management Guide.
9780 9781 9782 9783 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9780 def modify_cluster_iam_roles(params = {}, = {}) req = build_request(:modify_cluster_iam_roles, params) req.send_request() end |
#modify_cluster_maintenance(params = {}) ⇒ Types::ModifyClusterMaintenanceResult
Modifies the maintenance settings of a cluster.
9963 9964 9965 9966 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9963 def modify_cluster_maintenance(params = {}, = {}) req = build_request(:modify_cluster_maintenance, params) req.send_request() end |
#modify_cluster_parameter_group(params = {}) ⇒ Types::ClusterParameterGroupNameMessage
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 in the Amazon Redshift Cluster Management Guide.
10026 10027 10028 10029 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10026 def modify_cluster_parameter_group(params = {}, = {}) req = build_request(:modify_cluster_parameter_group, params) req.send_request() end |
#modify_cluster_snapshot(params = {}) ⇒ Types::ModifyClusterSnapshotResult
Modifies the settings for a snapshot.
This exanmple modifies the manual retention period setting for a cluster snapshot.
10113 10114 10115 10116 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10113 def modify_cluster_snapshot(params = {}, = {}) req = build_request(:modify_cluster_snapshot, params) req.send_request() end |
#modify_cluster_snapshot_schedule(params = {}) ⇒ Struct
Modifies a snapshot schedule for a cluster.
10146 10147 10148 10149 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10146 def modify_cluster_snapshot_schedule(params = {}, = {}) req = build_request(:modify_cluster_snapshot_schedule, params) req.send_request() end |
#modify_cluster_subnet_group(params = {}) ⇒ Types::ModifyClusterSubnetGroupResult
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.
VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:
Creating a public cluster
Restoring a public cluster
Modifying a private cluster to be public
Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group
For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
10221 10222 10223 10224 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10221 def modify_cluster_subnet_group(params = {}, = {}) req = build_request(:modify_cluster_subnet_group, params) req.send_request() end |
#modify_custom_domain_association(params = {}) ⇒ Types::ModifyCustomDomainAssociationResult
Contains information for changing a custom domain association.
10265 10266 10267 10268 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10265 def modify_custom_domain_association(params = {}, = {}) req = build_request(:modify_custom_domain_association, params) req.send_request() end |
#modify_endpoint_access(params = {}) ⇒ Types::EndpointAccess
Modifies a Redshift-managed VPC endpoint.
10325 10326 10327 10328 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10325 def modify_endpoint_access(params = {}, = {}) req = build_request(:modify_endpoint_access, params) req.send_request() end |
#modify_event_subscription(params = {}) ⇒ Types::ModifyEventSubscriptionResult
Modifies an existing Amazon Redshift event notification subscription.
10416 10417 10418 10419 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10416 def modify_event_subscription(params = {}, = {}) req = build_request(:modify_event_subscription, params) req.send_request() end |
#modify_integration(params = {}) ⇒ Types::Integration
Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.
10478 10479 10480 10481 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10478 def modify_integration(params = {}, = {}) req = build_request(:modify_integration, params) req.send_request() end |
#modify_redshift_idc_application(params = {}) ⇒ Types::ModifyRedshiftIdcApplicationResult
Changes an existing Amazon Redshift IAM Identity Center application.
10576 10577 10578 10579 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10576 def modify_redshift_idc_application(params = {}, = {}) req = build_request(:modify_redshift_idc_application, params) req.send_request() end |
#modify_scheduled_action(params = {}) ⇒ Types::ScheduledAction
Modifies a scheduled action.
10679 10680 10681 10682 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10679 def modify_scheduled_action(params = {}, = {}) req = build_request(:modify_scheduled_action, params) req.send_request() end |
#modify_snapshot_copy_retention_period(params = {}) ⇒ Types::ModifySnapshotCopyRetentionPeriodResult
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.
10882 10883 10884 10885 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10882 def modify_snapshot_copy_retention_period(params = {}, = {}) req = build_request(:modify_snapshot_copy_retention_period, params) req.send_request() end |
#modify_snapshot_schedule(params = {}) ⇒ Types::SnapshotSchedule
Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
10935 10936 10937 10938 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10935 def modify_snapshot_schedule(params = {}, = {}) req = build_request(:modify_snapshot_schedule, params) req.send_request() end |
#modify_usage_limit(params = {}) ⇒ Types::UsageLimit
Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.
10990 10991 10992 10993 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10990 def modify_usage_limit(params = {}, = {}) req = build_request(:modify_usage_limit, params) req.send_request() end |
#pause_cluster(params = {}) ⇒ Types::PauseClusterResult
Pauses a cluster.
11148 11149 11150 11151 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11148 def pause_cluster(params = {}, = {}) req = build_request(:pause_cluster, params) req.send_request() end |
#purchase_reserved_node_offering(params = {}) ⇒ Types::PurchaseReservedNodeOfferingResult
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
11209 11210 11211 11212 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11209 def purchase_reserved_node_offering(params = {}, = {}) req = build_request(:purchase_reserved_node_offering, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult
Updates the resource policy for a specified resource.
11243 11244 11245 11246 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11243 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#reboot_cluster(params = {}) ⇒ Types::RebootClusterResult
Reboots a cluster. This action is taken as soon as possible. It
results in a momentary outage to the cluster, during which the cluster
status is set to rebooting
. A cluster event is created when the
reboot is completed. Any pending cluster modifications (see
ModifyCluster) are applied at this reboot. For more information about
managing clusters, go to Amazon Redshift Clusters in the Amazon
Redshift Cluster Management Guide.
11411 11412 11413 11414 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11411 def reboot_cluster(params = {}, = {}) req = build_request(:reboot_cluster, params) req.send_request() end |
#register_namespace(params = {}) ⇒ Types::RegisterNamespaceOutputMessage
Registers a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.
11454 11455 11456 11457 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11454 def register_namespace(params = {}, = {}) req = build_request(:register_namespace, params) req.send_request() end |
#reject_data_share(params = {}) ⇒ Types::DataShare
From a datashare consumer account, rejects the specified datashare.
11499 11500 11501 11502 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11499 def reject_data_share(params = {}, = {}) req = build_request(:reject_data_share, params) req.send_request() end |
#reset_cluster_parameter_group(params = {}) ⇒ Types::ClusterParameterGroupNameMessage
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.
11560 11561 11562 11563 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11560 def reset_cluster_parameter_group(params = {}, = {}) req = build_request(:reset_cluster_parameter_group, params) req.send_request() end |
#resize_cluster(params = {}) ⇒ Types::ResizeClusterResult
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:
dc2.large
dc2.8xlarge
ra3.large
ra3.xlplus
ra3.4xlarge
ra3.16xlarge
- The type of nodes that you add must match the node type for the cluster.
11768 11769 11770 11771 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11768 def resize_cluster(params = {}, = {}) req = build_request(:resize_cluster, params) req.send_request() end |
#restore_from_cluster_snapshot(params = {}) ⇒ Types::RestoreFromClusterSnapshotResult
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.
VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:
Creating a public cluster
Restoring a public cluster
Modifying a private cluster to be public
Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group
For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
12273 12274 12275 12276 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12273 def restore_from_cluster_snapshot(params = {}, = {}) req = build_request(:restore_from_cluster_snapshot, params) req.send_request() end |
#restore_table_from_cluster_snapshot(params = {}) ⇒ Types::RestoreTableFromClusterSnapshotResult
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.
12373 12374 12375 12376 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12373 def restore_table_from_cluster_snapshot(params = {}, = {}) req = build_request(:restore_table_from_cluster_snapshot, params) req.send_request() end |
#resume_cluster(params = {}) ⇒ Types::ResumeClusterResult
Resumes a paused cluster.
12531 12532 12533 12534 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12531 def resume_cluster(params = {}, = {}) req = build_request(:resume_cluster, params) req.send_request() end |
#revoke_cluster_security_group_ingress(params = {}) ⇒ Types::RevokeClusterSecurityGroupIngressResult
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 in the Amazon Redshift Cluster Management Guide.
12608 12609 12610 12611 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12608 def revoke_cluster_security_group_ingress(params = {}, = {}) req = build_request(:revoke_cluster_security_group_ingress, params) req.send_request() end |
#revoke_endpoint_access(params = {}) ⇒ Types::EndpointAuthorization
Revokes access to a cluster.
12668 12669 12670 12671 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12668 def revoke_endpoint_access(params = {}, = {}) req = build_request(:revoke_endpoint_access, params) req.send_request() end |
#revoke_snapshot_access(params = {}) ⇒ Types::RevokeSnapshotAccessResult
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 in the Amazon Redshift Cluster Management Guide.
12764 12765 12766 12767 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12764 def revoke_snapshot_access(params = {}, = {}) req = build_request(:revoke_snapshot_access, params) req.send_request() end |
#rotate_encryption_key(params = {}) ⇒ Types::RotateEncryptionKeyResult
Rotates the encryption keys for a cluster.
12926 12927 12928 12929 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12926 def rotate_encryption_key(params = {}, = {}) req = build_request(:rotate_encryption_key, params) req.send_request() end |
#update_partner_status(params = {}) ⇒ Types::PartnerIntegrationOutputMessage
Updates the status of a partner integration.
12978 12979 12980 12981 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12978 def update_partner_status(params = {}, = {}) req = build_request(:update_partner_status, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
cluster_available | #describe_clusters | 60 | 30 |
cluster_deleted | #describe_clusters | 60 | 30 |
cluster_restored | #describe_clusters | 60 | 30 |
snapshot_available | #describe_cluster_snapshots | 15 | 20 |
13096 13097 13098 13099 13100 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 13096 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |