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 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 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.
-
#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 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 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.
-
#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.
609 610 611 612 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 609 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.
695 696 697 698 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 695 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.
752 753 754 755 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 752 def (params = {}, = {}) req = build_request(:authorize_data_share, params) req.send_request() end |
#authorize_endpoint_access(params = {}) ⇒ Types::EndpointAuthorization
Grants access to a cluster.
805 806 807 808 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 805 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.
908 909 910 911 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 908 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.
948 949 950 951 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 948 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.
1000 1001 1002 1003 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1000 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.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1062 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.
1194 1195 1196 1197 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1194 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.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1229 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.
1821 1822 1823 1824 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1821 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.
1910 1911 1912 1913 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1910 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.
1989 1990 1991 1992 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1989 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.
2103 2104 2105 2106 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2103 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.
2184 2185 2186 2187 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2184 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).
2229 2230 2231 2232 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2229 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.
2308 2309 2310 2311 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2308 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.
2443 2444 2445 2446 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2443 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.
2499 2500 2501 2502 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2499 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.
2578 2579 2580 2581 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2578 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 with Amazon Redshift.
2676 2677 2678 2679 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2676 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.
2766 2767 2768 2769 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2766 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.
2877 2878 2879 2880 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2877 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.
2948 2949 2950 2951 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2948 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.
3021 3022 3023 3024 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3021 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.
3065 3066 3067 3068 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3065 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.
3150 3151 3152 3153 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3150 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.
3201 3202 3203 3204 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3201 def (params = {}, = {}) req = build_request(:deauthorize_data_share, params) req.send_request() end |
#delete_authentication_profile(params = {}) ⇒ Types::DeleteAuthenticationProfileResult
Deletes an authentication profile.
3229 3230 3231 3232 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3229 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.
3455 3456 3457 3458 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3455 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.
3488 3489 3490 3491 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3488 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.
3523 3524 3525 3526 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3523 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.
3613 3614 3615 3616 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3613 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.
3635 3636 3637 3638 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3635 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.
3663 3664 3665 3666 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3663 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.
3718 3719 3720 3721 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3718 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.
3741 3742 3743 3744 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3741 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.
3763 3764 3765 3766 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3763 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.
3785 3786 3787 3788 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3785 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 with Amazon Redshift.
3838 3839 3840 3841 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3838 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.
3883 3884 3885 3886 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3883 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.
3905 3906 3907 3908 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3905 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.
3928 3929 3930 3931 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3928 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.
3950 3951 3952 3953 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3950 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.
3972 3973 3974 3975 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3972 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.
3994 3995 3996 3997 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3994 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.
4023 4024 4025 4026 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4023 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_usage_limit(params = {}) ⇒ Struct
Deletes a usage limit from a cluster.
4045 4046 4047 4048 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4045 def delete_usage_limit(params = {}, = {}) req = build_request(:delete_usage_limit, params) req.send_request() end |
#describe_account_attributes(params = {}) ⇒ Types::AccountAttributeList
Returns a list of attributes attached to an account
4076 4077 4078 4079 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4076 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.
4107 4108 4109 4110 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4107 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.
4174 4175 4176 4177 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4174 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.
4280 4281 4282 4283 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4280 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.
4369 4370 4371 4372 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4369 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.
4489 4490 4491 4492 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4489 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
4704 4705 4706 4707 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4704 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.
4807 4808 4809 4810 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4807 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.
4860 4861 4862 4863 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4860 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.
4940 4941 4942 4943 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4940 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
5176 5177 5178 5179 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5176 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.
5226 5227 5228 5229 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5226 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.
5290 5291 5292 5293 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5290 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.
5360 5361 5362 5363 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5360 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.
5430 5431 5432 5433 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5430 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.
5502 5503 5504 5505 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5502 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.
5579 5580 5581 5582 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5579 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.
5648 5649 5650 5651 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5648 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.
5693 5694 5695 5696 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5693 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.
5796 5797 5798 5799 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5796 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.
5931 5932 5933 5934 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5931 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.
6026 6027 6028 6029 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6026 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.
6123 6124 6125 6126 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6123 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.
6190 6191 6192 6193 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6190 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 integrations with Amazon Redshift.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6266 6267 6268 6269 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6266 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.
6312 6313 6314 6315 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6312 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.
6407 6408 6409 6410 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6407 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.
6492 6493 6494 6495 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6492 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.
6543 6544 6545 6546 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6543 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.
6608 6609 6610 6611 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6608 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.
6673 6674 6675 6676 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6673 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.
6751 6752 6753 6754 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6751 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.
6820 6821 6822 6823 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6820 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.
6892 6893 6894 6895 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6892 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.
6994 6995 6996 6997 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6994 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.
7083 7084 7085 7086 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7083 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.
7158 7159 7160 7161 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7158 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.
7179 7180 7181 7182 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7179 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.
7252 7253 7254 7255 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7252 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.
7390 7391 7392 7393 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7390 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.
7499 7500 7501 7502 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7499 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.
7545 7546 7547 7548 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7545 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.
7713 7714 7715 7716 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7713 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.
7774 7775 7776 7777 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7774 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.
7850 7851 7852 7853 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7850 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.
8049 8050 8051 8052 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8049 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.
8209 8210 8211 8212 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8209 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.
8373 8374 8375 8376 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8373 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.
8441 8442 8443 8444 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8441 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.
8532 8533 8534 8535 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8532 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.
8587 8588 8589 8590 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8587 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.
8617 8618 8619 8620 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8617 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.
8697 8698 8699 8700 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8697 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).
8733 8734 8735 8736 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8733 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.
8769 8770 8771 8772 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8769 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.
9265 9266 9267 9268 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9265 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.
9432 9433 9434 9435 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9432 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.
9615 9616 9617 9618 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9615 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.
9798 9799 9800 9801 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9798 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.
9861 9862 9863 9864 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9861 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.
9948 9949 9950 9951 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9948 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.
9981 9982 9983 9984 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9981 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.
10034 10035 10036 10037 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10034 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.
10078 10079 10080 10081 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10078 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.
10138 10139 10140 10141 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10138 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.
10229 10230 10231 10232 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10229 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 with Amazon Redshift.
10290 10291 10292 10293 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10290 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.
10374 10375 10376 10377 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10374 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.
10477 10478 10479 10480 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10477 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.
10680 10681 10682 10683 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10680 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.
10733 10734 10735 10736 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10733 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.
10788 10789 10790 10791 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10788 def modify_usage_limit(params = {}, = {}) req = build_request(:modify_usage_limit, params) req.send_request() end |
#pause_cluster(params = {}) ⇒ Types::PauseClusterResult
Pauses a cluster.
10946 10947 10948 10949 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10946 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.
11007 11008 11009 11010 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11007 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.
11041 11042 11043 11044 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11041 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.
11209 11210 11211 11212 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11209 def reboot_cluster(params = {}, = {}) req = build_request(:reboot_cluster, params) req.send_request() end |
#reject_data_share(params = {}) ⇒ Types::DataShare
From a datashare consumer account, rejects the specified datashare.
11252 11253 11254 11255 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11252 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.
11313 11314 11315 11316 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11313 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.
11522 11523 11524 11525 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11522 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.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
12006 12007 12008 12009 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12006 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.
12106 12107 12108 12109 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12106 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.
12264 12265 12266 12267 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12264 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.
12341 12342 12343 12344 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12341 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.
12401 12402 12403 12404 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12401 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.
12497 12498 12499 12500 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12497 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.
12659 12660 12661 12662 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12659 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.
12711 12712 12713 12714 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12711 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 |
12829 12830 12831 12832 12833 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12829 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |