@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonRedshift extends Object implements AmazonRedshift
AmazonRedshift
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
ReservedNode |
acceptReservedNodeExchange(AcceptReservedNodeExchangeRequest request)
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.
|
AddPartnerResult |
addPartner(AddPartnerRequest request)
Adds a partner integration to a cluster.
|
AssociateDataShareConsumerResult |
associateDataShareConsumer(AssociateDataShareConsumerRequest request)
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the
specified namespace (ConsumerArn).
|
ClusterSecurityGroup |
authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest request)
Adds an inbound (ingress) rule to an Amazon Redshift security group.
|
AuthorizeDataShareResult |
authorizeDataShare(AuthorizeDataShareRequest request)
From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or
managing entities.
|
AuthorizeEndpointAccessResult |
authorizeEndpointAccess(AuthorizeEndpointAccessRequest request)
Grants access to a cluster.
|
Snapshot |
authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest request)
Authorizes the specified Amazon Web Services account to restore the specified snapshot.
|
BatchDeleteClusterSnapshotsResult |
batchDeleteClusterSnapshots(BatchDeleteClusterSnapshotsRequest request)
Deletes a set of cluster snapshots.
|
BatchModifyClusterSnapshotsResult |
batchModifyClusterSnapshots(BatchModifyClusterSnapshotsRequest request)
Modifies the settings for a set of cluster snapshots.
|
CancelResizeResult |
cancelResize(CancelResizeRequest request)
Cancels a resize operation for a cluster.
|
Snapshot |
copyClusterSnapshot(CopyClusterSnapshotRequest request)
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
|
CreateAuthenticationProfileResult |
createAuthenticationProfile(CreateAuthenticationProfileRequest request)
Creates an authentication profile with the specified parameters.
|
Cluster |
createCluster(CreateClusterRequest request)
Creates a new cluster with the specified parameters.
|
ClusterParameterGroup |
createClusterParameterGroup(CreateClusterParameterGroupRequest request)
Creates an Amazon Redshift parameter group.
|
ClusterSecurityGroup |
createClusterSecurityGroup(CreateClusterSecurityGroupRequest request)
Creates a new Amazon Redshift security group.
|
Snapshot |
createClusterSnapshot(CreateClusterSnapshotRequest request)
Creates a manual snapshot of the specified cluster.
|
ClusterSubnetGroup |
createClusterSubnetGroup(CreateClusterSubnetGroupRequest request)
Creates a new Amazon Redshift subnet group.
|
CreateCustomDomainAssociationResult |
createCustomDomainAssociation(CreateCustomDomainAssociationRequest request)
Used to create a custom domain name for a cluster.
|
CreateEndpointAccessResult |
createEndpointAccess(CreateEndpointAccessRequest request)
Creates a Redshift-managed VPC endpoint.
|
EventSubscription |
createEventSubscription(CreateEventSubscriptionRequest request)
Creates an Amazon Redshift event notification subscription.
|
HsmClientCertificate |
createHsmClientCertificate(CreateHsmClientCertificateRequest request)
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.
|
HsmConfiguration |
createHsmConfiguration(CreateHsmConfigurationRequest request)
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).
|
RedshiftIdcApplication |
createRedshiftIdcApplication(CreateRedshiftIdcApplicationRequest request)
Creates an Amazon Redshift application for use with IAM Identity Center.
|
CreateScheduledActionResult |
createScheduledAction(CreateScheduledActionRequest request)
Creates a scheduled action.
|
SnapshotCopyGrant |
createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest request)
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.
|
CreateSnapshotScheduleResult |
createSnapshotSchedule(CreateSnapshotScheduleRequest request)
Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup
schedule.
|
CreateTagsResult |
createTags(CreateTagsRequest request)
Adds tags to a cluster.
|
CreateUsageLimitResult |
createUsageLimit(CreateUsageLimitRequest request)
Creates a usage limit for a specified Amazon Redshift feature on a cluster.
|
DeauthorizeDataShareResult |
deauthorizeDataShare(DeauthorizeDataShareRequest request)
From a datashare producer account, removes authorization from the specified datashare.
|
DeleteAuthenticationProfileResult |
deleteAuthenticationProfile(DeleteAuthenticationProfileRequest request)
Deletes an authentication profile.
|
Cluster |
deleteCluster(DeleteClusterRequest request)
Deletes a previously provisioned cluster without its final snapshot being created.
|
DeleteClusterParameterGroupResult |
deleteClusterParameterGroup(DeleteClusterParameterGroupRequest request)
Deletes a specified Amazon Redshift parameter group.
|
DeleteClusterSecurityGroupResult |
deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest request)
Deletes an Amazon Redshift security group.
|
Snapshot |
deleteClusterSnapshot(DeleteClusterSnapshotRequest request)
Deletes the specified manual snapshot.
|
DeleteClusterSubnetGroupResult |
deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest request)
Deletes the specified cluster subnet group.
|
DeleteCustomDomainAssociationResult |
deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest request)
Contains information about deleting a custom domain association for a cluster.
|
DeleteEndpointAccessResult |
deleteEndpointAccess(DeleteEndpointAccessRequest request)
Deletes a Redshift-managed VPC endpoint.
|
DeleteEventSubscriptionResult |
deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an Amazon Redshift event notification subscription.
|
DeleteHsmClientCertificateResult |
deleteHsmClientCertificate(DeleteHsmClientCertificateRequest request)
Deletes the specified HSM client certificate.
|
DeleteHsmConfigurationResult |
deleteHsmConfiguration(DeleteHsmConfigurationRequest request)
Deletes the specified Amazon Redshift HSM configuration.
|
DeletePartnerResult |
deletePartner(DeletePartnerRequest request)
Deletes a partner integration from a cluster.
|
DeleteRedshiftIdcApplicationResult |
deleteRedshiftIdcApplication(DeleteRedshiftIdcApplicationRequest request)
Deletes an Amazon Redshift IAM Identity Center application.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes the resource policy for a specified resource.
|
DeleteScheduledActionResult |
deleteScheduledAction(DeleteScheduledActionRequest request)
Deletes a scheduled action.
|
DeleteSnapshotCopyGrantResult |
deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest request)
Deletes the specified snapshot copy grant.
|
DeleteSnapshotScheduleResult |
deleteSnapshotSchedule(DeleteSnapshotScheduleRequest request)
Deletes a snapshot schedule.
|
DeleteTagsResult |
deleteTags(DeleteTagsRequest request)
Deletes tags from a resource.
|
DeleteUsageLimitResult |
deleteUsageLimit(DeleteUsageLimitRequest request)
Deletes a usage limit from a cluster.
|
DescribeAccountAttributesResult |
describeAccountAttributes(DescribeAccountAttributesRequest request)
Returns a list of attributes attached to an account
|
DescribeAuthenticationProfilesResult |
describeAuthenticationProfiles(DescribeAuthenticationProfilesRequest request)
Describes an authentication profile.
|
DescribeClusterDbRevisionsResult |
describeClusterDbRevisions(DescribeClusterDbRevisionsRequest request)
Returns an array of
ClusterDbRevision objects. |
DescribeClusterParameterGroupsResult |
describeClusterParameterGroups()
Simplified method form for invoking the DescribeClusterParameterGroups operation.
|
DescribeClusterParameterGroupsResult |
describeClusterParameterGroups(DescribeClusterParameterGroupsRequest request)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
DescribeClusterParametersResult |
describeClusterParameters(DescribeClusterParametersRequest request)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
DescribeClustersResult |
describeClusters()
Simplified method form for invoking the DescribeClusters operation.
|
DescribeClustersResult |
describeClusters(DescribeClustersRequest request)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
DescribeClusterSecurityGroupsResult |
describeClusterSecurityGroups()
Simplified method form for invoking the DescribeClusterSecurityGroups operation.
|
DescribeClusterSecurityGroupsResult |
describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest request)
Returns information about Amazon Redshift security groups.
|
DescribeClusterSnapshotsResult |
describeClusterSnapshots()
Simplified method form for invoking the DescribeClusterSnapshots operation.
|
DescribeClusterSnapshotsResult |
describeClusterSnapshots(DescribeClusterSnapshotsRequest request)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
DescribeClusterSubnetGroupsResult |
describeClusterSubnetGroups()
Simplified method form for invoking the DescribeClusterSubnetGroups operation.
|
DescribeClusterSubnetGroupsResult |
describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest request)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
DescribeClusterTracksResult |
describeClusterTracks(DescribeClusterTracksRequest request)
Returns a list of all the available maintenance tracks.
|
DescribeClusterVersionsResult |
describeClusterVersions()
Simplified method form for invoking the DescribeClusterVersions operation.
|
DescribeClusterVersionsResult |
describeClusterVersions(DescribeClusterVersionsRequest request)
Returns descriptions of the available Amazon Redshift cluster versions.
|
DescribeCustomDomainAssociationsResult |
describeCustomDomainAssociations(DescribeCustomDomainAssociationsRequest request)
Contains information about custom domain associations for a cluster.
|
DescribeDataSharesResult |
describeDataShares(DescribeDataSharesRequest request)
Shows the status of any inbound or outbound datashares available in the specified account.
|
DescribeDataSharesForConsumerResult |
describeDataSharesForConsumer(DescribeDataSharesForConsumerRequest request)
Returns a list of datashares where the account identifier being called is a consumer account identifier.
|
DescribeDataSharesForProducerResult |
describeDataSharesForProducer(DescribeDataSharesForProducerRequest request)
Returns a list of datashares when the account identifier being called is a producer account identifier.
|
DefaultClusterParameters |
describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest request)
Returns a list of parameter settings for the specified parameter group family.
|
DescribeEndpointAccessResult |
describeEndpointAccess(DescribeEndpointAccessRequest request)
Describes a Redshift-managed VPC endpoint.
|
DescribeEndpointAuthorizationResult |
describeEndpointAuthorization(DescribeEndpointAuthorizationRequest request)
Describes an endpoint authorization.
|
DescribeEventCategoriesResult |
describeEventCategories()
Simplified method form for invoking the DescribeEventCategories operation.
|
DescribeEventCategoriesResult |
describeEventCategories(DescribeEventCategoriesRequest request)
Displays a list of event categories for all event source types, or for a specified source type.
|
DescribeEventsResult |
describeEvents()
Simplified method form for invoking the DescribeEvents operation.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest request)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions()
Simplified method form for invoking the DescribeEventSubscriptions operation.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
DescribeHsmClientCertificatesResult |
describeHsmClientCertificates()
Simplified method form for invoking the DescribeHsmClientCertificates operation.
|
DescribeHsmClientCertificatesResult |
describeHsmClientCertificates(DescribeHsmClientCertificatesRequest request)
Returns information about the specified HSM client certificate.
|
DescribeHsmConfigurationsResult |
describeHsmConfigurations()
Simplified method form for invoking the DescribeHsmConfigurations operation.
|
DescribeHsmConfigurationsResult |
describeHsmConfigurations(DescribeHsmConfigurationsRequest request)
Returns information about the specified Amazon Redshift HSM configuration.
|
DescribeInboundIntegrationsResult |
describeInboundIntegrations(DescribeInboundIntegrationsRequest request)
Returns a list of inbound integrations.
|
DescribeLoggingStatusResult |
describeLoggingStatus(DescribeLoggingStatusRequest request)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon
Redshift cluster.
|
DescribeNodeConfigurationOptionsResult |
describeNodeConfigurationOptions(DescribeNodeConfigurationOptionsRequest request)
Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the
specified action type.
|
DescribeOrderableClusterOptionsResult |
describeOrderableClusterOptions()
Simplified method form for invoking the DescribeOrderableClusterOptions operation.
|
DescribeOrderableClusterOptionsResult |
describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest request)
Returns a list of orderable cluster options.
|
DescribePartnersResult |
describePartners(DescribePartnersRequest request)
Returns information about the partner integrations defined for a cluster.
|
DescribeRedshiftIdcApplicationsResult |
describeRedshiftIdcApplications(DescribeRedshiftIdcApplicationsRequest request)
Lists the Amazon Redshift IAM Identity Center applications.
|
DescribeReservedNodeExchangeStatusResult |
describeReservedNodeExchangeStatus(DescribeReservedNodeExchangeStatusRequest request)
Returns exchange status details and associated metadata for a reserved-node exchange.
|
DescribeReservedNodeOfferingsResult |
describeReservedNodeOfferings()
Simplified method form for invoking the DescribeReservedNodeOfferings operation.
|
DescribeReservedNodeOfferingsResult |
describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest request)
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.
|
DescribeReservedNodesResult |
describeReservedNodes()
Simplified method form for invoking the DescribeReservedNodes operation.
|
DescribeReservedNodesResult |
describeReservedNodes(DescribeReservedNodesRequest request)
Returns the descriptions of the reserved nodes.
|
DescribeResizeResult |
describeResize(DescribeResizeRequest request)
Returns information about the last resize operation for the specified cluster.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest request)
Describes properties of scheduled actions.
|
DescribeSnapshotCopyGrantsResult |
describeSnapshotCopyGrants()
Simplified method form for invoking the DescribeSnapshotCopyGrants operation.
|
DescribeSnapshotCopyGrantsResult |
describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest request)
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
|
DescribeSnapshotSchedulesResult |
describeSnapshotSchedules(DescribeSnapshotSchedulesRequest request)
Returns a list of snapshot schedules.
|
DescribeStorageResult |
describeStorage(DescribeStorageRequest request)
Returns account level backups storage size and provisional storage.
|
DescribeTableRestoreStatusResult |
describeTableRestoreStatus()
Simplified method form for invoking the DescribeTableRestoreStatus operation.
|
DescribeTableRestoreStatusResult |
describeTableRestoreStatus(DescribeTableRestoreStatusRequest request)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
DescribeTagsResult |
describeTags()
Simplified method form for invoking the DescribeTags operation.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest request)
Returns a list of tags.
|
DescribeUsageLimitsResult |
describeUsageLimits(DescribeUsageLimitsRequest request)
Shows usage limits on a cluster.
|
DisableLoggingResult |
disableLogging(DisableLoggingRequest request)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
Cluster |
disableSnapshotCopy(DisableSnapshotCopyRequest request)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
|
DisassociateDataShareConsumerResult |
disassociateDataShareConsumer(DisassociateDataShareConsumerRequest request)
From a datashare consumer account, remove association for the specified datashare.
|
EnableLoggingResult |
enableLogging(EnableLoggingRequest request)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
Cluster |
enableSnapshotCopy(EnableSnapshotCopyRequest request)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
|
Cluster |
failoverPrimaryCompute(FailoverPrimaryComputeRequest request)
Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetClusterCredentialsResult |
getClusterCredentials(GetClusterCredentialsRequest request)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database.
|
GetClusterCredentialsWithIAMResult |
getClusterCredentialsWithIAM(GetClusterCredentialsWithIAMRequest request)
Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift
database.
|
GetReservedNodeExchangeConfigurationOptionsResult |
getReservedNodeExchangeConfigurationOptions(GetReservedNodeExchangeConfigurationOptionsRequest request)
Gets the configuration options for the reserved-node exchange.
|
GetReservedNodeExchangeOfferingsResult |
getReservedNodeExchangeOfferings(GetReservedNodeExchangeOfferingsRequest request)
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given
DC1 reserved node.
|
GetResourcePolicyResult |
getResourcePolicy(GetResourcePolicyRequest request)
Get the resource policy for a specified resource.
|
ListRecommendationsResult |
listRecommendations(ListRecommendationsRequest request)
List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web
Services account.
|
ModifyAquaConfigurationResult |
modifyAquaConfiguration(ModifyAquaConfigurationRequest request)
This operation is retired.
|
ModifyAuthenticationProfileResult |
modifyAuthenticationProfile(ModifyAuthenticationProfileRequest request)
Modifies an authentication profile.
|
Cluster |
modifyCluster(ModifyClusterRequest request)
Modifies the settings for a cluster.
|
Cluster |
modifyClusterDbRevision(ModifyClusterDbRevisionRequest request)
Modifies the database revision of a cluster.
|
Cluster |
modifyClusterIamRoles(ModifyClusterIamRolesRequest request)
Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other
Amazon Web Services services.
|
Cluster |
modifyClusterMaintenance(ModifyClusterMaintenanceRequest request)
Modifies the maintenance settings of a cluster.
|
ModifyClusterParameterGroupResult |
modifyClusterParameterGroup(ModifyClusterParameterGroupRequest request)
Modifies the parameters of a parameter group.
|
Snapshot |
modifyClusterSnapshot(ModifyClusterSnapshotRequest request)
Modifies the settings for a snapshot.
|
ModifyClusterSnapshotScheduleResult |
modifyClusterSnapshotSchedule(ModifyClusterSnapshotScheduleRequest request)
Modifies a snapshot schedule for a cluster.
|
ClusterSubnetGroup |
modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest request)
Modifies a cluster subnet group to include the specified list of VPC subnets.
|
ModifyCustomDomainAssociationResult |
modifyCustomDomainAssociation(ModifyCustomDomainAssociationRequest request)
Contains information for changing a custom domain association.
|
ModifyEndpointAccessResult |
modifyEndpointAccess(ModifyEndpointAccessRequest request)
Modifies a Redshift-managed VPC endpoint.
|
EventSubscription |
modifyEventSubscription(ModifyEventSubscriptionRequest request)
Modifies an existing Amazon Redshift event notification subscription.
|
RedshiftIdcApplication |
modifyRedshiftIdcApplication(ModifyRedshiftIdcApplicationRequest request)
Changes an existing Amazon Redshift IAM Identity Center application.
|
ModifyScheduledActionResult |
modifyScheduledAction(ModifyScheduledActionRequest request)
Modifies a scheduled action.
|
Cluster |
modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest request)
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.
|
ModifySnapshotScheduleResult |
modifySnapshotSchedule(ModifySnapshotScheduleRequest request)
Modifies a snapshot schedule.
|
ModifyUsageLimitResult |
modifyUsageLimit(ModifyUsageLimitRequest request)
Modifies a usage limit in a cluster.
|
Cluster |
pauseCluster(PauseClusterRequest request)
Pauses a cluster.
|
ReservedNode |
purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest request)
Allows you to purchase reserved nodes.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Updates the resource policy for a specified resource.
|
Cluster |
rebootCluster(RebootClusterRequest request)
Reboots a cluster.
|
RejectDataShareResult |
rejectDataShare(RejectDataShareRequest request)
From a datashare consumer account, rejects the specified datashare.
|
ResetClusterParameterGroupResult |
resetClusterParameterGroup(ResetClusterParameterGroupRequest request)
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".
|
Cluster |
resizeCluster(ResizeClusterRequest request)
Changes the size of the cluster.
|
Cluster |
restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest request)
Creates a new cluster from a snapshot.
|
TableRestoreStatus |
restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest request)
Creates a new table from a table in an Amazon Redshift cluster snapshot.
|
Cluster |
resumeCluster(ResumeClusterRequest request)
Resumes a paused cluster.
|
ClusterSecurityGroup |
revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest request)
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2
security group.
|
RevokeEndpointAccessResult |
revokeEndpointAccess(RevokeEndpointAccessRequest request)
Revokes access to a cluster.
|
Snapshot |
revokeSnapshotAccess(RevokeSnapshotAccessRequest request)
Removes the ability of the specified Amazon Web Services account to restore the specified snapshot.
|
Cluster |
rotateEncryptionKey(RotateEncryptionKeyRequest request)
Rotates the encryption keys for a cluster.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("redshift.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonRedshift.setEndpoint(String) , sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdatePartnerStatusResult |
updatePartnerStatus(UpdatePartnerStatusRequest request)
Updates the status of a partner integration.
|
AmazonRedshiftWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonRedshift
Callers can pass in just the endpoint (ex: "redshift.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "redshift.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonRedshift
endpoint
- The endpoint (ex: "redshift.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"redshift.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AmazonRedshift
AmazonRedshift.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonRedshift
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public ReservedNode acceptReservedNodeExchange(AcceptReservedNodeExchangeRequest request)
AmazonRedshift
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.
acceptReservedNodeExchange
in interface AmazonRedshift
public AddPartnerResult addPartner(AddPartnerRequest request)
AmazonRedshift
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.
addPartner
in interface AmazonRedshift
public AssociateDataShareConsumerResult associateDataShareConsumer(AssociateDataShareConsumerRequest request)
AmazonRedshift
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.
associateDataShareConsumer
in interface AmazonRedshift
public ClusterSecurityGroup authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest request)
AmazonRedshift
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.
authorizeClusterSecurityGroupIngress
in interface AmazonRedshift
public AuthorizeDataShareResult authorizeDataShare(AuthorizeDataShareRequest request)
AmazonRedshift
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.
authorizeDataShare
in interface AmazonRedshift
public AuthorizeEndpointAccessResult authorizeEndpointAccess(AuthorizeEndpointAccessRequest request)
AmazonRedshift
Grants access to a cluster.
authorizeEndpointAccess
in interface AmazonRedshift
public Snapshot authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest request)
AmazonRedshift
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.
authorizeSnapshotAccess
in interface AmazonRedshift
public BatchDeleteClusterSnapshotsResult batchDeleteClusterSnapshots(BatchDeleteClusterSnapshotsRequest request)
AmazonRedshift
Deletes a set of cluster snapshots.
batchDeleteClusterSnapshots
in interface AmazonRedshift
public BatchModifyClusterSnapshotsResult batchModifyClusterSnapshots(BatchModifyClusterSnapshotsRequest request)
AmazonRedshift
Modifies the settings for a set of cluster snapshots.
batchModifyClusterSnapshots
in interface AmazonRedshift
public CancelResizeResult cancelResize(CancelResizeRequest request)
AmazonRedshift
Cancels a resize operation for a cluster.
cancelResize
in interface AmazonRedshift
public Snapshot copyClusterSnapshot(CopyClusterSnapshotRequest request)
AmazonRedshift
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.
copyClusterSnapshot
in interface AmazonRedshift
public CreateAuthenticationProfileResult createAuthenticationProfile(CreateAuthenticationProfileRequest request)
AmazonRedshift
Creates an authentication profile with the specified parameters.
createAuthenticationProfile
in interface AmazonRedshift
public Cluster createCluster(CreateClusterRequest request)
AmazonRedshift
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.
createCluster
in interface AmazonRedshift
public ClusterParameterGroup createClusterParameterGroup(CreateClusterParameterGroupRequest request)
AmazonRedshift
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.
createClusterParameterGroup
in interface AmazonRedshift
public ClusterSecurityGroup createClusterSecurityGroup(CreateClusterSecurityGroupRequest request)
AmazonRedshift
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.
createClusterSecurityGroup
in interface AmazonRedshift
public Snapshot createClusterSnapshot(CreateClusterSnapshotRequest request)
AmazonRedshift
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.
createClusterSnapshot
in interface AmazonRedshift
public ClusterSubnetGroup createClusterSubnetGroup(CreateClusterSubnetGroupRequest request)
AmazonRedshift
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.
createClusterSubnetGroup
in interface AmazonRedshift
public CreateCustomDomainAssociationResult createCustomDomainAssociation(CreateCustomDomainAssociationRequest request)
AmazonRedshift
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).
createCustomDomainAssociation
in interface AmazonRedshift
public CreateEndpointAccessResult createEndpointAccess(CreateEndpointAccessRequest request)
AmazonRedshift
Creates a Redshift-managed VPC endpoint.
createEndpointAccess
in interface AmazonRedshift
public EventSubscription createEventSubscription(CreateEventSubscriptionRequest request)
AmazonRedshift
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.
createEventSubscription
in interface AmazonRedshift
public HsmClientCertificate createHsmClientCertificate(CreateHsmClientCertificateRequest request)
AmazonRedshift
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.
createHsmClientCertificate
in interface AmazonRedshift
public HsmConfiguration createHsmConfiguration(CreateHsmConfigurationRequest request)
AmazonRedshift
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.
createHsmConfiguration
in interface AmazonRedshift
public RedshiftIdcApplication createRedshiftIdcApplication(CreateRedshiftIdcApplicationRequest request)
AmazonRedshift
Creates an Amazon Redshift application for use with IAM Identity Center.
createRedshiftIdcApplication
in interface AmazonRedshift
public CreateScheduledActionResult createScheduledAction(CreateScheduledActionRequest request)
AmazonRedshift
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.
createScheduledAction
in interface AmazonRedshift
public SnapshotCopyGrant createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest request)
AmazonRedshift
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.
createSnapshotCopyGrant
in interface AmazonRedshift
request
- The result of the CreateSnapshotCopyGrant
action.public CreateSnapshotScheduleResult createSnapshotSchedule(CreateSnapshotScheduleRequest request)
AmazonRedshift
Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
createSnapshotSchedule
in interface AmazonRedshift
public CreateTagsResult createTags(CreateTagsRequest request)
AmazonRedshift
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.
createTags
in interface AmazonRedshift
request
- Contains the output from the CreateTags
action.public CreateUsageLimitResult createUsageLimit(CreateUsageLimitRequest request)
AmazonRedshift
Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
createUsageLimit
in interface AmazonRedshift
public DeauthorizeDataShareResult deauthorizeDataShare(DeauthorizeDataShareRequest request)
AmazonRedshift
From a datashare producer account, removes authorization from the specified datashare.
deauthorizeDataShare
in interface AmazonRedshift
public DeleteAuthenticationProfileResult deleteAuthenticationProfile(DeleteAuthenticationProfileRequest request)
AmazonRedshift
Deletes an authentication profile.
deleteAuthenticationProfile
in interface AmazonRedshift
public Cluster deleteCluster(DeleteClusterRequest request)
AmazonRedshift
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.
deleteCluster
in interface AmazonRedshift
public DeleteClusterParameterGroupResult deleteClusterParameterGroup(DeleteClusterParameterGroupRequest request)
AmazonRedshift
Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
deleteClusterParameterGroup
in interface AmazonRedshift
public DeleteClusterSecurityGroupResult deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest request)
AmazonRedshift
Deletes an Amazon Redshift security group.
You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
deleteClusterSecurityGroup
in interface AmazonRedshift
public Snapshot deleteClusterSnapshot(DeleteClusterSnapshotRequest request)
AmazonRedshift
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.
deleteClusterSnapshot
in interface AmazonRedshift
public DeleteClusterSubnetGroupResult deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest request)
AmazonRedshift
Deletes the specified cluster subnet group.
deleteClusterSubnetGroup
in interface AmazonRedshift
public DeleteCustomDomainAssociationResult deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest request)
AmazonRedshift
Contains information about deleting a custom domain association for a cluster.
deleteCustomDomainAssociation
in interface AmazonRedshift
public DeleteEndpointAccessResult deleteEndpointAccess(DeleteEndpointAccessRequest request)
AmazonRedshift
Deletes a Redshift-managed VPC endpoint.
deleteEndpointAccess
in interface AmazonRedshift
public DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest request)
AmazonRedshift
Deletes an Amazon Redshift event notification subscription.
deleteEventSubscription
in interface AmazonRedshift
public DeleteHsmClientCertificateResult deleteHsmClientCertificate(DeleteHsmClientCertificateRequest request)
AmazonRedshift
Deletes the specified HSM client certificate.
deleteHsmClientCertificate
in interface AmazonRedshift
public DeleteHsmConfigurationResult deleteHsmConfiguration(DeleteHsmConfigurationRequest request)
AmazonRedshift
Deletes the specified Amazon Redshift HSM configuration.
deleteHsmConfiguration
in interface AmazonRedshift
public DeletePartnerResult deletePartner(DeletePartnerRequest request)
AmazonRedshift
Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.
deletePartner
in interface AmazonRedshift
public DeleteRedshiftIdcApplicationResult deleteRedshiftIdcApplication(DeleteRedshiftIdcApplicationRequest request)
AmazonRedshift
Deletes an Amazon Redshift IAM Identity Center application.
deleteRedshiftIdcApplication
in interface AmazonRedshift
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AmazonRedshift
Deletes the resource policy for a specified resource.
deleteResourcePolicy
in interface AmazonRedshift
public DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest request)
AmazonRedshift
Deletes a scheduled action.
deleteScheduledAction
in interface AmazonRedshift
public DeleteSnapshotCopyGrantResult deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest request)
AmazonRedshift
Deletes the specified snapshot copy grant.
deleteSnapshotCopyGrant
in interface AmazonRedshift
request
- The result of the DeleteSnapshotCopyGrant
action.public DeleteSnapshotScheduleResult deleteSnapshotSchedule(DeleteSnapshotScheduleRequest request)
AmazonRedshift
Deletes a snapshot schedule.
deleteSnapshotSchedule
in interface AmazonRedshift
public DeleteTagsResult deleteTags(DeleteTagsRequest request)
AmazonRedshift
Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
deleteTags
in interface AmazonRedshift
request
- Contains the output from the DeleteTags
action.public DeleteUsageLimitResult deleteUsageLimit(DeleteUsageLimitRequest request)
AmazonRedshift
Deletes a usage limit from a cluster.
deleteUsageLimit
in interface AmazonRedshift
public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
AmazonRedshift
Returns a list of attributes attached to an account
describeAccountAttributes
in interface AmazonRedshift
public DescribeAuthenticationProfilesResult describeAuthenticationProfiles(DescribeAuthenticationProfilesRequest request)
AmazonRedshift
Describes an authentication profile.
describeAuthenticationProfiles
in interface AmazonRedshift
public DescribeClusterDbRevisionsResult describeClusterDbRevisions(DescribeClusterDbRevisionsRequest request)
AmazonRedshift
Returns an array of ClusterDbRevision
objects.
describeClusterDbRevisions
in interface AmazonRedshift
public DescribeClusterParameterGroupsResult describeClusterParameterGroups(DescribeClusterParameterGroupsRequest request)
AmazonRedshift
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.
describeClusterParameterGroups
in interface AmazonRedshift
public DescribeClusterParameterGroupsResult describeClusterParameterGroups()
AmazonRedshift
describeClusterParameterGroups
in interface AmazonRedshift
AmazonRedshift.describeClusterParameterGroups(DescribeClusterParameterGroupsRequest)
public DescribeClusterParametersResult describeClusterParameters(DescribeClusterParametersRequest request)
AmazonRedshift
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.
describeClusterParameters
in interface AmazonRedshift
public DescribeClusterSecurityGroupsResult describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest request)
AmazonRedshift
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.
describeClusterSecurityGroups
in interface AmazonRedshift
public DescribeClusterSecurityGroupsResult describeClusterSecurityGroups()
AmazonRedshift
describeClusterSecurityGroups
in interface AmazonRedshift
AmazonRedshift.describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest)
public DescribeClusterSnapshotsResult describeClusterSnapshots(DescribeClusterSnapshotsRequest request)
AmazonRedshift
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.
describeClusterSnapshots
in interface AmazonRedshift
public DescribeClusterSnapshotsResult describeClusterSnapshots()
AmazonRedshift
describeClusterSnapshots
in interface AmazonRedshift
AmazonRedshift.describeClusterSnapshots(DescribeClusterSnapshotsRequest)
public DescribeClusterSubnetGroupsResult describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest request)
AmazonRedshift
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.
describeClusterSubnetGroups
in interface AmazonRedshift
public DescribeClusterSubnetGroupsResult describeClusterSubnetGroups()
AmazonRedshift
describeClusterSubnetGroups
in interface AmazonRedshift
AmazonRedshift.describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest)
public DescribeClusterTracksResult describeClusterTracks(DescribeClusterTracksRequest request)
AmazonRedshift
Returns a list of all the available maintenance tracks.
describeClusterTracks
in interface AmazonRedshift
public DescribeClusterVersionsResult describeClusterVersions(DescribeClusterVersionsRequest request)
AmazonRedshift
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.
describeClusterVersions
in interface AmazonRedshift
public DescribeClusterVersionsResult describeClusterVersions()
AmazonRedshift
describeClusterVersions
in interface AmazonRedshift
AmazonRedshift.describeClusterVersions(DescribeClusterVersionsRequest)
public DescribeClustersResult describeClusters(DescribeClustersRequest request)
AmazonRedshift
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.
describeClusters
in interface AmazonRedshift
public DescribeClustersResult describeClusters()
AmazonRedshift
describeClusters
in interface AmazonRedshift
AmazonRedshift.describeClusters(DescribeClustersRequest)
public DescribeCustomDomainAssociationsResult describeCustomDomainAssociations(DescribeCustomDomainAssociationsRequest request)
AmazonRedshift
Contains information about custom domain associations for a cluster.
describeCustomDomainAssociations
in interface AmazonRedshift
public DescribeDataSharesResult describeDataShares(DescribeDataSharesRequest request)
AmazonRedshift
Shows the status of any inbound or outbound datashares available in the specified account.
describeDataShares
in interface AmazonRedshift
public DescribeDataSharesForConsumerResult describeDataSharesForConsumer(DescribeDataSharesForConsumerRequest request)
AmazonRedshift
Returns a list of datashares where the account identifier being called is a consumer account identifier.
describeDataSharesForConsumer
in interface AmazonRedshift
public DescribeDataSharesForProducerResult describeDataSharesForProducer(DescribeDataSharesForProducerRequest request)
AmazonRedshift
Returns a list of datashares when the account identifier being called is a producer account identifier.
describeDataSharesForProducer
in interface AmazonRedshift
public DefaultClusterParameters describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest request)
AmazonRedshift
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.
describeDefaultClusterParameters
in interface AmazonRedshift
public DescribeEndpointAccessResult describeEndpointAccess(DescribeEndpointAccessRequest request)
AmazonRedshift
Describes a Redshift-managed VPC endpoint.
describeEndpointAccess
in interface AmazonRedshift
public DescribeEndpointAuthorizationResult describeEndpointAuthorization(DescribeEndpointAuthorizationRequest request)
AmazonRedshift
Describes an endpoint authorization.
describeEndpointAuthorization
in interface AmazonRedshift
public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
AmazonRedshift
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.
describeEventCategories
in interface AmazonRedshift
public DescribeEventCategoriesResult describeEventCategories()
AmazonRedshift
describeEventCategories
in interface AmazonRedshift
AmazonRedshift.describeEventCategories(DescribeEventCategoriesRequest)
public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
AmazonRedshift
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.
describeEventSubscriptions
in interface AmazonRedshift
public DescribeEventSubscriptionsResult describeEventSubscriptions()
AmazonRedshift
describeEventSubscriptions
in interface AmazonRedshift
AmazonRedshift.describeEventSubscriptions(DescribeEventSubscriptionsRequest)
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
AmazonRedshift
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.
describeEvents
in interface AmazonRedshift
public DescribeEventsResult describeEvents()
AmazonRedshift
describeEvents
in interface AmazonRedshift
AmazonRedshift.describeEvents(DescribeEventsRequest)
public DescribeHsmClientCertificatesResult describeHsmClientCertificates(DescribeHsmClientCertificatesRequest request)
AmazonRedshift
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.
describeHsmClientCertificates
in interface AmazonRedshift
public DescribeHsmClientCertificatesResult describeHsmClientCertificates()
AmazonRedshift
describeHsmClientCertificates
in interface AmazonRedshift
AmazonRedshift.describeHsmClientCertificates(DescribeHsmClientCertificatesRequest)
public DescribeHsmConfigurationsResult describeHsmConfigurations(DescribeHsmConfigurationsRequest request)
AmazonRedshift
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.
describeHsmConfigurations
in interface AmazonRedshift
public DescribeHsmConfigurationsResult describeHsmConfigurations()
AmazonRedshift
describeHsmConfigurations
in interface AmazonRedshift
AmazonRedshift.describeHsmConfigurations(DescribeHsmConfigurationsRequest)
public DescribeInboundIntegrationsResult describeInboundIntegrations(DescribeInboundIntegrationsRequest request)
AmazonRedshift
Returns a list of inbound integrations.
describeInboundIntegrations
in interface AmazonRedshift
public DescribeLoggingStatusResult describeLoggingStatus(DescribeLoggingStatusRequest request)
AmazonRedshift
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
describeLoggingStatus
in interface AmazonRedshift
public DescribeNodeConfigurationOptionsResult describeNodeConfigurationOptions(DescribeNodeConfigurationOptionsRequest request)
AmazonRedshift
Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
describeNodeConfigurationOptions
in interface AmazonRedshift
public DescribeOrderableClusterOptionsResult describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest request)
AmazonRedshift
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.
describeOrderableClusterOptions
in interface AmazonRedshift
public DescribeOrderableClusterOptionsResult describeOrderableClusterOptions()
AmazonRedshift
describeOrderableClusterOptions
in interface AmazonRedshift
AmazonRedshift.describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest)
public DescribePartnersResult describePartners(DescribePartnersRequest request)
AmazonRedshift
Returns information about the partner integrations defined for a cluster.
describePartners
in interface AmazonRedshift
public DescribeRedshiftIdcApplicationsResult describeRedshiftIdcApplications(DescribeRedshiftIdcApplicationsRequest request)
AmazonRedshift
Lists the Amazon Redshift IAM Identity Center applications.
describeRedshiftIdcApplications
in interface AmazonRedshift
public DescribeReservedNodeExchangeStatusResult describeReservedNodeExchangeStatus(DescribeReservedNodeExchangeStatusRequest request)
AmazonRedshift
Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.
describeReservedNodeExchangeStatus
in interface AmazonRedshift
public DescribeReservedNodeOfferingsResult describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest request)
AmazonRedshift
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.
describeReservedNodeOfferings
in interface AmazonRedshift
public DescribeReservedNodeOfferingsResult describeReservedNodeOfferings()
AmazonRedshift
describeReservedNodeOfferings
in interface AmazonRedshift
AmazonRedshift.describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest)
public DescribeReservedNodesResult describeReservedNodes(DescribeReservedNodesRequest request)
AmazonRedshift
Returns the descriptions of the reserved nodes.
describeReservedNodes
in interface AmazonRedshift
public DescribeReservedNodesResult describeReservedNodes()
AmazonRedshift
describeReservedNodes
in interface AmazonRedshift
AmazonRedshift.describeReservedNodes(DescribeReservedNodesRequest)
public DescribeResizeResult describeResize(DescribeResizeRequest request)
AmazonRedshift
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.
describeResize
in interface AmazonRedshift
public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest request)
AmazonRedshift
Describes properties of scheduled actions.
describeScheduledActions
in interface AmazonRedshift
public DescribeSnapshotCopyGrantsResult describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest request)
AmazonRedshift
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.
describeSnapshotCopyGrants
in interface AmazonRedshift
request
- The result of the DescribeSnapshotCopyGrants
action.public DescribeSnapshotCopyGrantsResult describeSnapshotCopyGrants()
AmazonRedshift
describeSnapshotCopyGrants
in interface AmazonRedshift
AmazonRedshift.describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest)
public DescribeSnapshotSchedulesResult describeSnapshotSchedules(DescribeSnapshotSchedulesRequest request)
AmazonRedshift
Returns a list of snapshot schedules.
describeSnapshotSchedules
in interface AmazonRedshift
public DescribeStorageResult describeStorage(DescribeStorageRequest request)
AmazonRedshift
Returns account level backups storage size and provisional storage.
describeStorage
in interface AmazonRedshift
public DescribeTableRestoreStatusResult describeTableRestoreStatus(DescribeTableRestoreStatusRequest request)
AmazonRedshift
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
.
describeTableRestoreStatus
in interface AmazonRedshift
public DescribeTableRestoreStatusResult describeTableRestoreStatus()
AmazonRedshift
describeTableRestoreStatus
in interface AmazonRedshift
AmazonRedshift.describeTableRestoreStatus(DescribeTableRestoreStatusRequest)
public DescribeTagsResult describeTags(DescribeTagsRequest request)
AmazonRedshift
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags
:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords
and Marker
parameters together with the ARN parameter.
The MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
describeTags
in interface AmazonRedshift
public DescribeTagsResult describeTags()
AmazonRedshift
describeTags
in interface AmazonRedshift
AmazonRedshift.describeTags(DescribeTagsRequest)
public DescribeUsageLimitsResult describeUsageLimits(DescribeUsageLimitsRequest request)
AmazonRedshift
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.
describeUsageLimits
in interface AmazonRedshift
public DisableLoggingResult disableLogging(DisableLoggingRequest request)
AmazonRedshift
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
disableLogging
in interface AmazonRedshift
public Cluster disableSnapshotCopy(DisableSnapshotCopyRequest request)
AmazonRedshift
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.
disableSnapshotCopy
in interface AmazonRedshift
public DisassociateDataShareConsumerResult disassociateDataShareConsumer(DisassociateDataShareConsumerRequest request)
AmazonRedshift
From a datashare consumer account, remove association for the specified datashare.
disassociateDataShareConsumer
in interface AmazonRedshift
public EnableLoggingResult enableLogging(EnableLoggingRequest request)
AmazonRedshift
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
enableLogging
in interface AmazonRedshift
public Cluster enableSnapshotCopy(EnableSnapshotCopyRequest request)
AmazonRedshift
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
enableSnapshotCopy
in interface AmazonRedshift
public Cluster failoverPrimaryCompute(FailoverPrimaryComputeRequest request)
AmazonRedshift
Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
failoverPrimaryCompute
in interface AmazonRedshift
public GetClusterCredentialsResult getClusterCredentials(GetClusterCredentialsRequest request)
AmazonRedshift
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.
getClusterCredentials
in interface AmazonRedshift
request
- The request parameters to get cluster credentials.public GetClusterCredentialsWithIAMResult getClusterCredentialsWithIAM(GetClusterCredentialsWithIAMRequest request)
AmazonRedshift
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.
getClusterCredentialsWithIAM
in interface AmazonRedshift
public GetReservedNodeExchangeConfigurationOptionsResult getReservedNodeExchangeConfigurationOptions(GetReservedNodeExchangeConfigurationOptionsRequest request)
AmazonRedshift
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.
getReservedNodeExchangeConfigurationOptions
in interface AmazonRedshift
public GetReservedNodeExchangeOfferingsResult getReservedNodeExchangeOfferings(GetReservedNodeExchangeOfferingsRequest request)
AmazonRedshift
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
getReservedNodeExchangeOfferings
in interface AmazonRedshift
public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)
AmazonRedshift
Get the resource policy for a specified resource.
getResourcePolicy
in interface AmazonRedshift
public ListRecommendationsResult listRecommendations(ListRecommendationsRequest request)
AmazonRedshift
List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.
listRecommendations
in interface AmazonRedshift
public ModifyAquaConfigurationResult modifyAquaConfiguration(ModifyAquaConfigurationRequest request)
AmazonRedshift
This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
modifyAquaConfiguration
in interface AmazonRedshift
public ModifyAuthenticationProfileResult modifyAuthenticationProfile(ModifyAuthenticationProfileRequest request)
AmazonRedshift
Modifies an authentication profile.
modifyAuthenticationProfile
in interface AmazonRedshift
public Cluster modifyCluster(ModifyClusterRequest request)
AmazonRedshift
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.
modifyCluster
in interface AmazonRedshift
public Cluster modifyClusterDbRevision(ModifyClusterDbRevisionRequest request)
AmazonRedshift
Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
modifyClusterDbRevision
in interface AmazonRedshift
public Cluster modifyClusterIamRoles(ModifyClusterIamRolesRequest request)
AmazonRedshift
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.
modifyClusterIamRoles
in interface AmazonRedshift
public Cluster modifyClusterMaintenance(ModifyClusterMaintenanceRequest request)
AmazonRedshift
Modifies the maintenance settings of a cluster.
modifyClusterMaintenance
in interface AmazonRedshift
public ModifyClusterParameterGroupResult modifyClusterParameterGroup(ModifyClusterParameterGroupRequest request)
AmazonRedshift
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.
modifyClusterParameterGroup
in interface AmazonRedshift
request
- Describes a modify cluster parameter group operation.public Snapshot modifyClusterSnapshot(ModifyClusterSnapshotRequest request)
AmazonRedshift
Modifies the settings for a snapshot.
This exanmple modifies the manual retention period setting for a cluster snapshot.
modifyClusterSnapshot
in interface AmazonRedshift
public ModifyClusterSnapshotScheduleResult modifyClusterSnapshotSchedule(ModifyClusterSnapshotScheduleRequest request)
AmazonRedshift
Modifies a snapshot schedule for a cluster.
modifyClusterSnapshotSchedule
in interface AmazonRedshift
public ClusterSubnetGroup modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest request)
AmazonRedshift
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.
modifyClusterSubnetGroup
in interface AmazonRedshift
public ModifyCustomDomainAssociationResult modifyCustomDomainAssociation(ModifyCustomDomainAssociationRequest request)
AmazonRedshift
Contains information for changing a custom domain association.
modifyCustomDomainAssociation
in interface AmazonRedshift
public ModifyEndpointAccessResult modifyEndpointAccess(ModifyEndpointAccessRequest request)
AmazonRedshift
Modifies a Redshift-managed VPC endpoint.
modifyEndpointAccess
in interface AmazonRedshift
public EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest request)
AmazonRedshift
Modifies an existing Amazon Redshift event notification subscription.
modifyEventSubscription
in interface AmazonRedshift
public RedshiftIdcApplication modifyRedshiftIdcApplication(ModifyRedshiftIdcApplicationRequest request)
AmazonRedshift
Changes an existing Amazon Redshift IAM Identity Center application.
modifyRedshiftIdcApplication
in interface AmazonRedshift
public ModifyScheduledActionResult modifyScheduledAction(ModifyScheduledActionRequest request)
AmazonRedshift
Modifies a scheduled action.
modifyScheduledAction
in interface AmazonRedshift
public Cluster modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest request)
AmazonRedshift
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.
modifySnapshotCopyRetentionPeriod
in interface AmazonRedshift
public ModifySnapshotScheduleResult modifySnapshotSchedule(ModifySnapshotScheduleRequest request)
AmazonRedshift
Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
modifySnapshotSchedule
in interface AmazonRedshift
public ModifyUsageLimitResult modifyUsageLimit(ModifyUsageLimitRequest request)
AmazonRedshift
Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.
modifyUsageLimit
in interface AmazonRedshift
public Cluster pauseCluster(PauseClusterRequest request)
AmazonRedshift
Pauses a cluster.
pauseCluster
in interface AmazonRedshift
request
- Describes a pause cluster operation. For example, a scheduled action to run the PauseCluster
API operation.public ReservedNode purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest request)
AmazonRedshift
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.
purchaseReservedNodeOffering
in interface AmazonRedshift
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AmazonRedshift
Updates the resource policy for a specified resource.
putResourcePolicy
in interface AmazonRedshift
public Cluster rebootCluster(RebootClusterRequest request)
AmazonRedshift
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.
rebootCluster
in interface AmazonRedshift
public RejectDataShareResult rejectDataShare(RejectDataShareRequest request)
AmazonRedshift
From a datashare consumer account, rejects the specified datashare.
rejectDataShare
in interface AmazonRedshift
public ResetClusterParameterGroupResult resetClusterParameterGroup(ResetClusterParameterGroupRequest request)
AmazonRedshift
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.
resetClusterParameterGroup
in interface AmazonRedshift
public Cluster resizeCluster(ResizeClusterRequest request)
AmazonRedshift
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.xlplus
ra3.4xlarge
ra3.16xlarge
The type of nodes that you add must match the node type for the cluster.
resizeCluster
in interface AmazonRedshift
request
- Describes a resize cluster operation. For example, a scheduled action to run the
ResizeCluster
API operation.public Cluster restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest request)
AmazonRedshift
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.
restoreFromClusterSnapshot
in interface AmazonRedshift
public TableRestoreStatus restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest request)
AmazonRedshift
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.
restoreTableFromClusterSnapshot
in interface AmazonRedshift
public Cluster resumeCluster(ResumeClusterRequest request)
AmazonRedshift
Resumes a paused cluster.
resumeCluster
in interface AmazonRedshift
request
- Describes a resume cluster operation. For example, a scheduled action to run the
ResumeCluster
API operation.public ClusterSecurityGroup revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest request)
AmazonRedshift
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.
revokeClusterSecurityGroupIngress
in interface AmazonRedshift
public RevokeEndpointAccessResult revokeEndpointAccess(RevokeEndpointAccessRequest request)
AmazonRedshift
Revokes access to a cluster.
revokeEndpointAccess
in interface AmazonRedshift
public Snapshot revokeSnapshotAccess(RevokeSnapshotAccessRequest request)
AmazonRedshift
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.
revokeSnapshotAccess
in interface AmazonRedshift
public Cluster rotateEncryptionKey(RotateEncryptionKeyRequest request)
AmazonRedshift
Rotates the encryption keys for a cluster.
rotateEncryptionKey
in interface AmazonRedshift
public UpdatePartnerStatusResult updatePartnerStatus(UpdatePartnerStatusRequest request)
AmazonRedshift
Updates the status of a partner integration.
updatePartnerStatus
in interface AmazonRedshift
public void shutdown()
AmazonRedshift
shutdown
in interface AmazonRedshift
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonRedshift
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonRedshift
request
- The originally executed request.public AmazonRedshiftWaiters waiters()
waiters
in interface AmazonRedshift