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.
444 445 446 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 444 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.
496 497 498 499 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 496 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.
542 543 544 545 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 542 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.
611 612 613 614 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 611 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.
697 698 699 700 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 697 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.
756 757 758 759 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 756 def (params = {}, = {}) req = build_request(:authorize_data_share, params) req.send_request() end |
#authorize_endpoint_access(params = {}) ⇒ Types::EndpointAuthorization
Grants access to a cluster.
809 810 811 812 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 809 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.
912 913 914 915 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 912 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.
952 953 954 955 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 952 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.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1004 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.
1066 1067 1068 1069 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1066 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.
1198 1199 1200 1201 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1198 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.
1233 1234 1235 1236 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1233 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.
1844 1845 1846 1847 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1844 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.
1933 1934 1935 1936 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1933 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.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2012 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.
2126 2127 2128 2129 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2126 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.
2207 2208 2209 2210 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2207 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).
2252 2253 2254 2255 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2252 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.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2331 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.
2466 2467 2468 2469 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2466 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.
2522 2523 2524 2525 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2522 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.
2601 2602 2603 2604 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2601 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.
2700 2701 2702 2703 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2700 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.
2799 2800 2801 2802 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2799 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.
2910 2911 2912 2913 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2910 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.
2981 2982 2983 2984 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2981 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.
3054 3055 3056 3057 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3054 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.
3098 3099 3100 3101 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3098 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.
3183 3184 3185 3186 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3183 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.
3236 3237 3238 3239 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3236 def (params = {}, = {}) req = build_request(:deauthorize_data_share, params) req.send_request() end |
#delete_authentication_profile(params = {}) ⇒ Types::DeleteAuthenticationProfileResult
Deletes an authentication profile.
3264 3265 3266 3267 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3264 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.
3490 3491 3492 3493 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3490 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.
3523 3524 3525 3526 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3523 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.
3558 3559 3560 3561 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3558 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.
3648 3649 3650 3651 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3648 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.
3670 3671 3672 3673 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3670 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.
3698 3699 3700 3701 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3698 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.
3753 3754 3755 3756 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3753 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.
3776 3777 3778 3779 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3776 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.
3798 3799 3800 3801 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3798 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.
3820 3821 3822 3823 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3820 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.
3874 3875 3876 3877 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3874 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.
3919 3920 3921 3922 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3919 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.
3941 3942 3943 3944 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3941 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.
3964 3965 3966 3967 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3964 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.
3986 3987 3988 3989 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3986 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.
4008 4009 4010 4011 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4008 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.
4030 4031 4032 4033 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4030 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.
4059 4060 4061 4062 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4059 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_usage_limit(params = {}) ⇒ Struct
Deletes a usage limit from a cluster.
4081 4082 4083 4084 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4081 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.
4124 4125 4126 4127 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4124 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
4155 4156 4157 4158 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4155 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.
4186 4187 4188 4189 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4186 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.
4253 4254 4255 4256 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4253 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.
4359 4360 4361 4362 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4359 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.
4448 4449 4450 4451 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4448 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.
4568 4569 4570 4571 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4568 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
4783 4784 4785 4786 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4783 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.
4886 4887 4888 4889 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4886 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.
4939 4940 4941 4942 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4939 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.
5019 5020 5021 5022 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5019 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
5255 5256 5257 5258 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5255 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.
5305 5306 5307 5308 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5305 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.
5370 5371 5372 5373 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5370 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.
5441 5442 5443 5444 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5441 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.
5512 5513 5514 5515 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5512 def describe_data_shares_for_producer(params = {}, = {}) req = build_request(:describe_data_shares_for_producer, params) req.send_request( |