Interface RedshiftAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Overview
This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.
Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.
If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacceptReservedNodeExchange
(Consumer<AcceptReservedNodeExchangeRequest.Builder> acceptReservedNodeExchangeRequest) 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
(AcceptReservedNodeExchangeRequest acceptReservedNodeExchangeRequest) 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.default CompletableFuture
<AddPartnerResponse> addPartner
(Consumer<AddPartnerRequest.Builder> addPartnerRequest) Adds a partner integration to a cluster.default CompletableFuture
<AddPartnerResponse> addPartner
(AddPartnerRequest addPartnerRequest) Adds a partner integration to a cluster.associateDataShareConsumer
(Consumer<AssociateDataShareConsumerRequest.Builder> associateDataShareConsumerRequest) From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn).associateDataShareConsumer
(AssociateDataShareConsumerRequest associateDataShareConsumerRequest) From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn).authorizeClusterSecurityGroupIngress
(Consumer<AuthorizeClusterSecurityGroupIngressRequest.Builder> authorizeClusterSecurityGroupIngressRequest) Adds an inbound (ingress) rule to an Amazon Redshift security group.authorizeClusterSecurityGroupIngress
(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest) Adds an inbound (ingress) rule to an Amazon Redshift security group.authorizeDataShare
(Consumer<AuthorizeDataShareRequest.Builder> authorizeDataShareRequest) From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities.authorizeDataShare
(AuthorizeDataShareRequest authorizeDataShareRequest) From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities.authorizeEndpointAccess
(Consumer<AuthorizeEndpointAccessRequest.Builder> authorizeEndpointAccessRequest) Grants access to a cluster.authorizeEndpointAccess
(AuthorizeEndpointAccessRequest authorizeEndpointAccessRequest) Grants access to a cluster.authorizeSnapshotAccess
(Consumer<AuthorizeSnapshotAccessRequest.Builder> authorizeSnapshotAccessRequest) Authorizes the specified Amazon Web Services account to restore the specified snapshot.authorizeSnapshotAccess
(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest) Authorizes the specified Amazon Web Services account to restore the specified snapshot.batchDeleteClusterSnapshots
(Consumer<BatchDeleteClusterSnapshotsRequest.Builder> batchDeleteClusterSnapshotsRequest) Deletes a set of cluster snapshots.batchDeleteClusterSnapshots
(BatchDeleteClusterSnapshotsRequest batchDeleteClusterSnapshotsRequest) Deletes a set of cluster snapshots.batchModifyClusterSnapshots
(Consumer<BatchModifyClusterSnapshotsRequest.Builder> batchModifyClusterSnapshotsRequest) Modifies the settings for a set of cluster snapshots.batchModifyClusterSnapshots
(BatchModifyClusterSnapshotsRequest batchModifyClusterSnapshotsRequest) Modifies the settings for a set of cluster snapshots.static RedshiftAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aRedshiftAsyncClient
.default CompletableFuture
<CancelResizeResponse> cancelResize
(Consumer<CancelResizeRequest.Builder> cancelResizeRequest) Cancels a resize operation for a cluster.default CompletableFuture
<CancelResizeResponse> cancelResize
(CancelResizeRequest cancelResizeRequest) Cancels a resize operation for a cluster.copyClusterSnapshot
(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest) Copies the specified automated cluster snapshot to a new manual cluster snapshot.copyClusterSnapshot
(CopyClusterSnapshotRequest copyClusterSnapshotRequest) Copies the specified automated cluster snapshot to a new manual cluster snapshot.static RedshiftAsyncClient
create()
Create aRedshiftAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAuthenticationProfile
(Consumer<CreateAuthenticationProfileRequest.Builder> createAuthenticationProfileRequest) Creates an authentication profile with the specified parameters.createAuthenticationProfile
(CreateAuthenticationProfileRequest createAuthenticationProfileRequest) Creates an authentication profile with the specified parameters.default CompletableFuture
<CreateClusterResponse> createCluster
(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates a new cluster with the specified parameters.default CompletableFuture
<CreateClusterResponse> createCluster
(CreateClusterRequest createClusterRequest) Creates a new cluster with the specified parameters.createClusterParameterGroup
(Consumer<CreateClusterParameterGroupRequest.Builder> createClusterParameterGroupRequest) Creates an Amazon Redshift parameter group.createClusterParameterGroup
(CreateClusterParameterGroupRequest createClusterParameterGroupRequest) Creates an Amazon Redshift parameter group.createClusterSecurityGroup
(Consumer<CreateClusterSecurityGroupRequest.Builder> createClusterSecurityGroupRequest) Creates a new Amazon Redshift security group.createClusterSecurityGroup
(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest) Creates a new Amazon Redshift security group.createClusterSnapshot
(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest) Creates a manual snapshot of the specified cluster.createClusterSnapshot
(CreateClusterSnapshotRequest createClusterSnapshotRequest) Creates a manual snapshot of the specified cluster.createClusterSubnetGroup
(Consumer<CreateClusterSubnetGroupRequest.Builder> createClusterSubnetGroupRequest) Creates a new Amazon Redshift subnet group.createClusterSubnetGroup
(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest) Creates a new Amazon Redshift subnet group.createCustomDomainAssociation
(Consumer<CreateCustomDomainAssociationRequest.Builder> createCustomDomainAssociationRequest) Used to create a custom domain name for a cluster.createCustomDomainAssociation
(CreateCustomDomainAssociationRequest createCustomDomainAssociationRequest) Used to create a custom domain name for a cluster.createEndpointAccess
(Consumer<CreateEndpointAccessRequest.Builder> createEndpointAccessRequest) Creates a Redshift-managed VPC endpoint.createEndpointAccess
(CreateEndpointAccessRequest createEndpointAccessRequest) Creates a Redshift-managed VPC endpoint.createEventSubscription
(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) Creates an Amazon Redshift event notification subscription.createEventSubscription
(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an Amazon Redshift event notification subscription.createHsmClientCertificate
(Consumer<CreateHsmClientCertificateRequest.Builder> createHsmClientCertificateRequest) 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.createHsmClientCertificate
(CreateHsmClientCertificateRequest createHsmClientCertificateRequest) 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.createHsmConfiguration
(Consumer<CreateHsmConfigurationRequest.Builder> createHsmConfigurationRequest) 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).createHsmConfiguration
(CreateHsmConfigurationRequest createHsmConfigurationRequest) 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).createRedshiftIdcApplication
(Consumer<CreateRedshiftIdcApplicationRequest.Builder> createRedshiftIdcApplicationRequest) Creates an Amazon Redshift application for use with IAM Identity Center.createRedshiftIdcApplication
(CreateRedshiftIdcApplicationRequest createRedshiftIdcApplicationRequest) Creates an Amazon Redshift application for use with IAM Identity Center.createScheduledAction
(Consumer<CreateScheduledActionRequest.Builder> createScheduledActionRequest) Creates a scheduled action.createScheduledAction
(CreateScheduledActionRequest createScheduledActionRequest) Creates a scheduled action.createSnapshotCopyGrant
(Consumer<CreateSnapshotCopyGrantRequest.Builder> createSnapshotCopyGrantRequest) 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.createSnapshotCopyGrant
(CreateSnapshotCopyGrantRequest createSnapshotCopyGrantRequest) 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.createSnapshotSchedule
(Consumer<CreateSnapshotScheduleRequest.Builder> createSnapshotScheduleRequest) Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.createSnapshotSchedule
(CreateSnapshotScheduleRequest createSnapshotScheduleRequest) Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.default CompletableFuture
<CreateTagsResponse> createTags
(Consumer<CreateTagsRequest.Builder> createTagsRequest) Adds tags to a cluster.default CompletableFuture
<CreateTagsResponse> createTags
(CreateTagsRequest createTagsRequest) Adds tags to a cluster.createUsageLimit
(Consumer<CreateUsageLimitRequest.Builder> createUsageLimitRequest) Creates a usage limit for a specified Amazon Redshift feature on a cluster.createUsageLimit
(CreateUsageLimitRequest createUsageLimitRequest) Creates a usage limit for a specified Amazon Redshift feature on a cluster.deauthorizeDataShare
(Consumer<DeauthorizeDataShareRequest.Builder> deauthorizeDataShareRequest) From a datashare producer account, removes authorization from the specified datashare.deauthorizeDataShare
(DeauthorizeDataShareRequest deauthorizeDataShareRequest) From a datashare producer account, removes authorization from the specified datashare.deleteAuthenticationProfile
(Consumer<DeleteAuthenticationProfileRequest.Builder> deleteAuthenticationProfileRequest) Deletes an authentication profile.deleteAuthenticationProfile
(DeleteAuthenticationProfileRequest deleteAuthenticationProfileRequest) Deletes an authentication profile.default CompletableFuture
<DeleteClusterResponse> deleteCluster
(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes a previously provisioned cluster without its final snapshot being created.default CompletableFuture
<DeleteClusterResponse> deleteCluster
(DeleteClusterRequest deleteClusterRequest) Deletes a previously provisioned cluster without its final snapshot being created.deleteClusterParameterGroup
(Consumer<DeleteClusterParameterGroupRequest.Builder> deleteClusterParameterGroupRequest) Deletes a specified Amazon Redshift parameter group.deleteClusterParameterGroup
(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest) Deletes a specified Amazon Redshift parameter group.deleteClusterSecurityGroup
(Consumer<DeleteClusterSecurityGroupRequest.Builder> deleteClusterSecurityGroupRequest) Deletes an Amazon Redshift security group.deleteClusterSecurityGroup
(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest) Deletes an Amazon Redshift security group.deleteClusterSnapshot
(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest) Deletes the specified manual snapshot.deleteClusterSnapshot
(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) Deletes the specified manual snapshot.deleteClusterSubnetGroup
(Consumer<DeleteClusterSubnetGroupRequest.Builder> deleteClusterSubnetGroupRequest) Deletes the specified cluster subnet group.deleteClusterSubnetGroup
(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest) Deletes the specified cluster subnet group.deleteCustomDomainAssociation
(Consumer<DeleteCustomDomainAssociationRequest.Builder> deleteCustomDomainAssociationRequest) Contains information about deleting a custom domain association for a cluster.deleteCustomDomainAssociation
(DeleteCustomDomainAssociationRequest deleteCustomDomainAssociationRequest) Contains information about deleting a custom domain association for a cluster.deleteEndpointAccess
(Consumer<DeleteEndpointAccessRequest.Builder> deleteEndpointAccessRequest) Deletes a Redshift-managed VPC endpoint.deleteEndpointAccess
(DeleteEndpointAccessRequest deleteEndpointAccessRequest) Deletes a Redshift-managed VPC endpoint.deleteEventSubscription
(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) Deletes an Amazon Redshift event notification subscription.deleteEventSubscription
(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an Amazon Redshift event notification subscription.deleteHsmClientCertificate
(Consumer<DeleteHsmClientCertificateRequest.Builder> deleteHsmClientCertificateRequest) Deletes the specified HSM client certificate.deleteHsmClientCertificate
(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest) Deletes the specified HSM client certificate.deleteHsmConfiguration
(Consumer<DeleteHsmConfigurationRequest.Builder> deleteHsmConfigurationRequest) Deletes the specified Amazon Redshift HSM configuration.deleteHsmConfiguration
(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest) Deletes the specified Amazon Redshift HSM configuration.default CompletableFuture
<DeletePartnerResponse> deletePartner
(Consumer<DeletePartnerRequest.Builder> deletePartnerRequest) Deletes a partner integration from a cluster.default CompletableFuture
<DeletePartnerResponse> deletePartner
(DeletePartnerRequest deletePartnerRequest) Deletes a partner integration from a cluster.deleteRedshiftIdcApplication
(Consumer<DeleteRedshiftIdcApplicationRequest.Builder> deleteRedshiftIdcApplicationRequest) Deletes an Amazon Redshift IAM Identity Center application.deleteRedshiftIdcApplication
(DeleteRedshiftIdcApplicationRequest deleteRedshiftIdcApplicationRequest) Deletes an Amazon Redshift IAM Identity Center application.deleteResourcePolicy
(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes the resource policy for a specified resource.deleteResourcePolicy
(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes the resource policy for a specified resource.deleteScheduledAction
(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest) Deletes a scheduled action.deleteScheduledAction
(DeleteScheduledActionRequest deleteScheduledActionRequest) Deletes a scheduled action.deleteSnapshotCopyGrant
(Consumer<DeleteSnapshotCopyGrantRequest.Builder> deleteSnapshotCopyGrantRequest) Deletes the specified snapshot copy grant.deleteSnapshotCopyGrant
(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest) Deletes the specified snapshot copy grant.deleteSnapshotSchedule
(Consumer<DeleteSnapshotScheduleRequest.Builder> deleteSnapshotScheduleRequest) Deletes a snapshot schedule.deleteSnapshotSchedule
(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest) Deletes a snapshot schedule.default CompletableFuture
<DeleteTagsResponse> deleteTags
(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) Deletes tags from a resource.default CompletableFuture
<DeleteTagsResponse> deleteTags
(DeleteTagsRequest deleteTagsRequest) Deletes tags from a resource.deleteUsageLimit
(Consumer<DeleteUsageLimitRequest.Builder> deleteUsageLimitRequest) Deletes a usage limit from a cluster.deleteUsageLimit
(DeleteUsageLimitRequest deleteUsageLimitRequest) Deletes a usage limit from a cluster.Returns a list of attributes attached to an accountdescribeAccountAttributes
(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Returns a list of attributes attached to an accountdescribeAccountAttributes
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Returns a list of attributes attached to an accountdescribeAuthenticationProfiles
(Consumer<DescribeAuthenticationProfilesRequest.Builder> describeAuthenticationProfilesRequest) Describes an authentication profile.describeAuthenticationProfiles
(DescribeAuthenticationProfilesRequest describeAuthenticationProfilesRequest) Describes an authentication profile.Returns an array ofClusterDbRevision
objects.describeClusterDbRevisions
(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) Returns an array ofClusterDbRevision
objects.describeClusterDbRevisions
(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) Returns an array ofClusterDbRevision
objects.This is a variant ofdescribeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation.describeClusterDbRevisionsPaginator
(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) This is a variant ofdescribeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation.describeClusterDbRevisionsPaginator
(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) This is a variant ofdescribeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation.Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.describeClusterParameterGroups
(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.describeClusterParameterGroups
(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.This is a variant ofdescribeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.describeClusterParameterGroupsPaginator
(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) This is a variant ofdescribeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.describeClusterParameterGroupsPaginator
(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) This is a variant ofdescribeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.describeClusterParameters
(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.describeClusterParameters
(DescribeClusterParametersRequest describeClusterParametersRequest) Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.describeClusterParametersPaginator
(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) This is a variant ofdescribeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation.describeClusterParametersPaginator
(DescribeClusterParametersRequest describeClusterParametersRequest) This is a variant ofdescribeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation.Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties.describeClusters
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties.describeClusters
(DescribeClustersRequest describeClustersRequest) Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties.describeClusterSecurityGroups
(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) Returns information about Amazon Redshift security groups.describeClusterSecurityGroups
(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) Returns information about Amazon Redshift security groups.describeClusterSecurityGroupsPaginator
(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) This is a variant ofdescribeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation.describeClusterSecurityGroupsPaginator
(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) This is a variant ofdescribeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation.Returns one or more snapshot objects, which contain metadata about your cluster snapshots.describeClusterSnapshots
(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) Returns one or more snapshot objects, which contain metadata about your cluster snapshots.describeClusterSnapshots
(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) Returns one or more snapshot objects, which contain metadata about your cluster snapshots.This is a variant ofdescribeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.describeClusterSnapshotsPaginator
(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) This is a variant ofdescribeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.describeClusterSnapshotsPaginator
(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) This is a variant ofdescribeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.default DescribeClustersPublisher
This is a variant ofdescribeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.default DescribeClustersPublisher
describeClustersPaginator
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.default DescribeClustersPublisher
describeClustersPaginator
(DescribeClustersRequest describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.describeClusterSubnetGroups
(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.describeClusterSubnetGroups
(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.This is a variant ofdescribeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.describeClusterSubnetGroupsPaginator
(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) This is a variant ofdescribeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.describeClusterSubnetGroupsPaginator
(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) This is a variant ofdescribeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.Returns a list of all the available maintenance tracks.describeClusterTracks
(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest) Returns a list of all the available maintenance tracks.describeClusterTracks
(DescribeClusterTracksRequest describeClusterTracksRequest) Returns a list of all the available maintenance tracks.default DescribeClusterTracksPublisher
This is a variant ofdescribeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation.default DescribeClusterTracksPublisher
describeClusterTracksPaginator
(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest) This is a variant ofdescribeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation.default DescribeClusterTracksPublisher
describeClusterTracksPaginator
(DescribeClusterTracksRequest describeClusterTracksRequest) This is a variant ofdescribeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation.Returns descriptions of the available Amazon Redshift cluster versions.describeClusterVersions
(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) Returns descriptions of the available Amazon Redshift cluster versions.describeClusterVersions
(DescribeClusterVersionsRequest describeClusterVersionsRequest) Returns descriptions of the available Amazon Redshift cluster versions.default DescribeClusterVersionsPublisher
This is a variant ofdescribeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.default DescribeClusterVersionsPublisher
describeClusterVersionsPaginator
(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) This is a variant ofdescribeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.default DescribeClusterVersionsPublisher
describeClusterVersionsPaginator
(DescribeClusterVersionsRequest describeClusterVersionsRequest) This is a variant ofdescribeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.describeCustomDomainAssociations
(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest) Contains information about custom domain associations for a cluster.describeCustomDomainAssociations
(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) Contains information about custom domain associations for a cluster.describeCustomDomainAssociationsPaginator
(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest) This is a variant ofdescribeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation.describeCustomDomainAssociationsPaginator
(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) This is a variant ofdescribeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation.describeDataShares
(Consumer<DescribeDataSharesRequest.Builder> describeDataSharesRequest) Shows the status of any inbound or outbound datashares available in the specified account.describeDataShares
(DescribeDataSharesRequest describeDataSharesRequest) Shows the status of any inbound or outbound datashares available in the specified account.describeDataSharesForConsumer
(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest) Returns a list of datashares where the account identifier being called is a consumer account identifier.describeDataSharesForConsumer
(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest) Returns a list of datashares where the account identifier being called is a consumer account identifier.describeDataSharesForConsumerPaginator
(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest) This is a variant ofdescribeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)
operation.describeDataSharesForConsumerPaginator
(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest) This is a variant ofdescribeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)
operation.describeDataSharesForProducer
(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest) Returns a list of datashares when the account identifier being called is a producer account identifier.describeDataSharesForProducer
(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest) Returns a list of datashares when the account identifier being called is a producer account identifier.describeDataSharesForProducerPaginator
(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest) This is a variant ofdescribeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)
operation.describeDataSharesForProducerPaginator
(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest) This is a variant ofdescribeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)
operation.default DescribeDataSharesPublisher
describeDataSharesPaginator
(Consumer<DescribeDataSharesRequest.Builder> describeDataSharesRequest) This is a variant ofdescribeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)
operation.default DescribeDataSharesPublisher
describeDataSharesPaginator
(DescribeDataSharesRequest describeDataSharesRequest) This is a variant ofdescribeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)
operation.describeDefaultClusterParameters
(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) Returns a list of parameter settings for the specified parameter group family.describeDefaultClusterParameters
(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) Returns a list of parameter settings for the specified parameter group family.describeDefaultClusterParametersPaginator
(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) This is a variant ofdescribeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation.describeDefaultClusterParametersPaginator
(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) This is a variant ofdescribeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation.describeEndpointAccess
(Consumer<DescribeEndpointAccessRequest.Builder> describeEndpointAccessRequest) Describes a Redshift-managed VPC endpoint.describeEndpointAccess
(DescribeEndpointAccessRequest describeEndpointAccessRequest) Describes a Redshift-managed VPC endpoint.default DescribeEndpointAccessPublisher
describeEndpointAccessPaginator
(Consumer<DescribeEndpointAccessRequest.Builder> describeEndpointAccessRequest) This is a variant ofdescribeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation.default DescribeEndpointAccessPublisher
describeEndpointAccessPaginator
(DescribeEndpointAccessRequest describeEndpointAccessRequest) This is a variant ofdescribeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation.describeEndpointAuthorization
(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest) Describes an endpoint authorization.describeEndpointAuthorization
(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) Describes an endpoint authorization.describeEndpointAuthorizationPaginator
(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest) This is a variant ofdescribeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation.describeEndpointAuthorizationPaginator
(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) This is a variant ofdescribeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation.Displays a list of event categories for all event source types, or for a specified source type.describeEventCategories
(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) Displays a list of event categories for all event source types, or for a specified source type.describeEventCategories
(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of event categories for all event source types, or for a specified source type.default CompletableFuture
<DescribeEventsResponse> Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.default CompletableFuture
<DescribeEventsResponse> describeEvents
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.default CompletableFuture
<DescribeEventsResponse> describeEvents
(DescribeEventsRequest describeEventsRequest) Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.default DescribeEventsPublisher
This is a variant ofdescribeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.default DescribeEventsPublisher
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.default DescribeEventsPublisher
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.describeEventSubscriptions
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.describeEventSubscriptions
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.Returns information about the specified HSM client certificate.describeHsmClientCertificates
(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) Returns information about the specified HSM client certificate.describeHsmClientCertificates
(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) Returns information about the specified HSM client certificate.This is a variant ofdescribeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.describeHsmClientCertificatesPaginator
(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) This is a variant ofdescribeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.describeHsmClientCertificatesPaginator
(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) This is a variant ofdescribeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.Returns information about the specified Amazon Redshift HSM configuration.describeHsmConfigurations
(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) Returns information about the specified Amazon Redshift HSM configuration.describeHsmConfigurations
(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) Returns information about the specified Amazon Redshift HSM configuration.This is a variant ofdescribeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.describeHsmConfigurationsPaginator
(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) This is a variant ofdescribeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.describeHsmConfigurationsPaginator
(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) This is a variant ofdescribeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.describeInboundIntegrations
(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest) Returns a list of inbound integrations.describeInboundIntegrations
(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) Returns a list of inbound integrations.describeInboundIntegrationsPaginator
(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest) This is a variant ofdescribeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation.describeInboundIntegrationsPaginator
(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) This is a variant ofdescribeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation.describeLoggingStatus
(Consumer<DescribeLoggingStatusRequest.Builder> describeLoggingStatusRequest) Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.describeLoggingStatus
(DescribeLoggingStatusRequest describeLoggingStatusRequest) Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.describeNodeConfigurationOptions
(Consumer<DescribeNodeConfigurationOptionsRequest.Builder> describeNodeConfigurationOptionsRequest) Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.describeNodeConfigurationOptions
(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest) Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.describeNodeConfigurationOptionsPaginator
(Consumer<DescribeNodeConfigurationOptionsRequest.Builder> describeNodeConfigurationOptionsRequest) This is a variant ofdescribeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation.describeNodeConfigurationOptionsPaginator
(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest) This is a variant ofdescribeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation.Returns a list of orderable cluster options.describeOrderableClusterOptions
(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) Returns a list of orderable cluster options.describeOrderableClusterOptions
(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) Returns a list of orderable cluster options.This is a variant ofdescribeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.describeOrderableClusterOptionsPaginator
(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) This is a variant ofdescribeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.describeOrderableClusterOptionsPaginator
(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) This is a variant ofdescribeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.describePartners
(Consumer<DescribePartnersRequest.Builder> describePartnersRequest) Returns information about the partner integrations defined for a cluster.describePartners
(DescribePartnersRequest describePartnersRequest) Returns information about the partner integrations defined for a cluster.describeRedshiftIdcApplications
(Consumer<DescribeRedshiftIdcApplicationsRequest.Builder> describeRedshiftIdcApplicationsRequest) Lists the Amazon Redshift IAM Identity Center applications.describeRedshiftIdcApplications
(DescribeRedshiftIdcApplicationsRequest describeRedshiftIdcApplicationsRequest) Lists the Amazon Redshift IAM Identity Center applications.describeRedshiftIdcApplicationsPaginator
(Consumer<DescribeRedshiftIdcApplicationsRequest.Builder> describeRedshiftIdcApplicationsRequest) This is a variant ofdescribeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation.describeRedshiftIdcApplicationsPaginator
(DescribeRedshiftIdcApplicationsRequest describeRedshiftIdcApplicationsRequest) This is a variant ofdescribeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation.describeReservedNodeExchangeStatus
(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest) Returns exchange status details and associated metadata for a reserved-node exchange.describeReservedNodeExchangeStatus
(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest) Returns exchange status details and associated metadata for a reserved-node exchange.describeReservedNodeExchangeStatusPaginator
(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest) This is a variant ofdescribeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation.describeReservedNodeExchangeStatusPaginator
(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest) This is a variant ofdescribeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation.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.describeReservedNodeOfferings
(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) 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.describeReservedNodeOfferings
(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) 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.This is a variant ofdescribeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.describeReservedNodeOfferingsPaginator
(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) This is a variant ofdescribeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.describeReservedNodeOfferingsPaginator
(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) This is a variant ofdescribeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.Returns the descriptions of the reserved nodes.describeReservedNodes
(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) Returns the descriptions of the reserved nodes.describeReservedNodes
(DescribeReservedNodesRequest describeReservedNodesRequest) Returns the descriptions of the reserved nodes.default DescribeReservedNodesPublisher
This is a variant ofdescribeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.default DescribeReservedNodesPublisher
describeReservedNodesPaginator
(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) This is a variant ofdescribeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.default DescribeReservedNodesPublisher
describeReservedNodesPaginator
(DescribeReservedNodesRequest describeReservedNodesRequest) This is a variant ofdescribeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.default CompletableFuture
<DescribeResizeResponse> describeResize
(Consumer<DescribeResizeRequest.Builder> describeResizeRequest) Returns information about the last resize operation for the specified cluster.default CompletableFuture
<DescribeResizeResponse> describeResize
(DescribeResizeRequest describeResizeRequest) Returns information about the last resize operation for the specified cluster.describeScheduledActions
(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) Describes properties of scheduled actions.describeScheduledActions
(DescribeScheduledActionsRequest describeScheduledActionsRequest) Describes properties of scheduled actions.describeScheduledActionsPaginator
(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) This is a variant ofdescribeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation.describeScheduledActionsPaginator
(DescribeScheduledActionsRequest describeScheduledActionsRequest) This is a variant ofdescribeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation.Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.describeSnapshotCopyGrants
(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.describeSnapshotCopyGrants
(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.This is a variant ofdescribeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation.describeSnapshotCopyGrantsPaginator
(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) This is a variant ofdescribeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation.describeSnapshotCopyGrantsPaginator
(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) This is a variant ofdescribeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation.Returns a list of snapshot schedules.describeSnapshotSchedules
(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest) Returns a list of snapshot schedules.describeSnapshotSchedules
(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) Returns a list of snapshot schedules.This is a variant ofdescribeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation.describeSnapshotSchedulesPaginator
(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest) This is a variant ofdescribeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation.describeSnapshotSchedulesPaginator
(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) This is a variant ofdescribeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation.default CompletableFuture
<DescribeStorageResponse> Returns account level backups storage size and provisional storage.default CompletableFuture
<DescribeStorageResponse> describeStorage
(Consumer<DescribeStorageRequest.Builder> describeStorageRequest) Returns account level backups storage size and provisional storage.default CompletableFuture
<DescribeStorageResponse> describeStorage
(DescribeStorageRequest describeStorageRequest) Returns account level backups storage size and provisional storage.describeTableRestoreStatus
(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action.describeTableRestoreStatus
(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action.describeTableRestoreStatusPaginator
(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) This is a variant ofdescribeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation.describeTableRestoreStatusPaginator
(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) This is a variant ofdescribeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation.default CompletableFuture
<DescribeTagsResponse> Returns a list of tags.default CompletableFuture
<DescribeTagsResponse> describeTags
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) Returns a list of tags.default CompletableFuture
<DescribeTagsResponse> describeTags
(DescribeTagsRequest describeTagsRequest) Returns a list of tags.default DescribeTagsPublisher
This is a variant ofdescribeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation.default DescribeTagsPublisher
describeTagsPaginator
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) This is a variant ofdescribeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation.default DescribeTagsPublisher
describeTagsPaginator
(DescribeTagsRequest describeTagsRequest) This is a variant ofdescribeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation.describeUsageLimits
(Consumer<DescribeUsageLimitsRequest.Builder> describeUsageLimitsRequest) Shows usage limits on a cluster.describeUsageLimits
(DescribeUsageLimitsRequest describeUsageLimitsRequest) Shows usage limits on a cluster.default DescribeUsageLimitsPublisher
describeUsageLimitsPaginator
(Consumer<DescribeUsageLimitsRequest.Builder> describeUsageLimitsRequest) This is a variant ofdescribeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation.default DescribeUsageLimitsPublisher
describeUsageLimitsPaginator
(DescribeUsageLimitsRequest describeUsageLimitsRequest) This is a variant ofdescribeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation.default CompletableFuture
<DisableLoggingResponse> disableLogging
(Consumer<DisableLoggingRequest.Builder> disableLoggingRequest) Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.default CompletableFuture
<DisableLoggingResponse> disableLogging
(DisableLoggingRequest disableLoggingRequest) Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.disableSnapshotCopy
(Consumer<DisableSnapshotCopyRequest.Builder> disableSnapshotCopyRequest) Disables the automatic copying of snapshots from one region to another region for a specified cluster.disableSnapshotCopy
(DisableSnapshotCopyRequest disableSnapshotCopyRequest) Disables the automatic copying of snapshots from one region to another region for a specified cluster.disassociateDataShareConsumer
(Consumer<DisassociateDataShareConsumerRequest.Builder> disassociateDataShareConsumerRequest) From a datashare consumer account, remove association for the specified datashare.disassociateDataShareConsumer
(DisassociateDataShareConsumerRequest disassociateDataShareConsumerRequest) From a datashare consumer account, remove association for the specified datashare.default CompletableFuture
<EnableLoggingResponse> enableLogging
(Consumer<EnableLoggingRequest.Builder> enableLoggingRequest) Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.default CompletableFuture
<EnableLoggingResponse> enableLogging
(EnableLoggingRequest enableLoggingRequest) Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.enableSnapshotCopy
(Consumer<EnableSnapshotCopyRequest.Builder> enableSnapshotCopyRequest) Enables the automatic copy of snapshots from one region to another region for a specified cluster.enableSnapshotCopy
(EnableSnapshotCopyRequest enableSnapshotCopyRequest) Enables the automatic copy of snapshots from one region to another region for a specified cluster.failoverPrimaryCompute
(Consumer<FailoverPrimaryComputeRequest.Builder> failoverPrimaryComputeRequest) Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.failoverPrimaryCompute
(FailoverPrimaryComputeRequest failoverPrimaryComputeRequest) Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.getClusterCredentials
(Consumer<GetClusterCredentialsRequest.Builder> getClusterCredentialsRequest) Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database.getClusterCredentials
(GetClusterCredentialsRequest getClusterCredentialsRequest) Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database.getClusterCredentialsWithIAM
(Consumer<GetClusterCredentialsWithIamRequest.Builder> getClusterCredentialsWithIamRequest) Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database.getClusterCredentialsWithIAM
(GetClusterCredentialsWithIamRequest getClusterCredentialsWithIamRequest) Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database.getReservedNodeExchangeConfigurationOptions
(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest) Gets the configuration options for the reserved-node exchange.getReservedNodeExchangeConfigurationOptions
(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest) Gets the configuration options for the reserved-node exchange.getReservedNodeExchangeConfigurationOptionsPaginator
(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest) getReservedNodeExchangeConfigurationOptionsPaginator
(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest) getReservedNodeExchangeOfferings
(Consumer<GetReservedNodeExchangeOfferingsRequest.Builder> getReservedNodeExchangeOfferingsRequest) Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.getReservedNodeExchangeOfferings
(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest) Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.getReservedNodeExchangeOfferingsPaginator
(Consumer<GetReservedNodeExchangeOfferingsRequest.Builder> getReservedNodeExchangeOfferingsRequest) This is a variant ofgetReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation.getReservedNodeExchangeOfferingsPaginator
(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest) This is a variant ofgetReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation.getResourcePolicy
(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Get the resource policy for a specified resource.getResourcePolicy
(GetResourcePolicyRequest getResourcePolicyRequest) Get the resource policy for a specified resource.listRecommendations
(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest) List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.listRecommendations
(ListRecommendationsRequest listRecommendationsRequest) List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.default ListRecommendationsPublisher
listRecommendationsPaginator
(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest) This is a variant oflistRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation.default ListRecommendationsPublisher
listRecommendationsPaginator
(ListRecommendationsRequest listRecommendationsRequest) This is a variant oflistRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation.modifyAquaConfiguration
(Consumer<ModifyAquaConfigurationRequest.Builder> modifyAquaConfigurationRequest) This operation is retired.modifyAquaConfiguration
(ModifyAquaConfigurationRequest modifyAquaConfigurationRequest) This operation is retired.modifyAuthenticationProfile
(Consumer<ModifyAuthenticationProfileRequest.Builder> modifyAuthenticationProfileRequest) Modifies an authentication profile.modifyAuthenticationProfile
(ModifyAuthenticationProfileRequest modifyAuthenticationProfileRequest) Modifies an authentication profile.default CompletableFuture
<ModifyClusterResponse> modifyCluster
(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest) Modifies the settings for a cluster.default CompletableFuture
<ModifyClusterResponse> modifyCluster
(ModifyClusterRequest modifyClusterRequest) Modifies the settings for a cluster.modifyClusterDbRevision
(Consumer<ModifyClusterDbRevisionRequest.Builder> modifyClusterDbRevisionRequest) Modifies the database revision of a cluster.modifyClusterDbRevision
(ModifyClusterDbRevisionRequest modifyClusterDbRevisionRequest) Modifies the database revision of a cluster.modifyClusterIamRoles
(Consumer<ModifyClusterIamRolesRequest.Builder> modifyClusterIamRolesRequest) Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.modifyClusterIamRoles
(ModifyClusterIamRolesRequest modifyClusterIamRolesRequest) Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.modifyClusterMaintenance
(Consumer<ModifyClusterMaintenanceRequest.Builder> modifyClusterMaintenanceRequest) Modifies the maintenance settings of a cluster.modifyClusterMaintenance
(ModifyClusterMaintenanceRequest modifyClusterMaintenanceRequest) Modifies the maintenance settings of a cluster.modifyClusterParameterGroup
(Consumer<ModifyClusterParameterGroupRequest.Builder> modifyClusterParameterGroupRequest) Modifies the parameters of a parameter group.modifyClusterParameterGroup
(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest) Modifies the parameters of a parameter group.modifyClusterSnapshot
(Consumer<ModifyClusterSnapshotRequest.Builder> modifyClusterSnapshotRequest) Modifies the settings for a snapshot.modifyClusterSnapshot
(ModifyClusterSnapshotRequest modifyClusterSnapshotRequest) Modifies the settings for a snapshot.modifyClusterSnapshotSchedule
(Consumer<ModifyClusterSnapshotScheduleRequest.Builder> modifyClusterSnapshotScheduleRequest) Modifies a snapshot schedule for a cluster.modifyClusterSnapshotSchedule
(ModifyClusterSnapshotScheduleRequest modifyClusterSnapshotScheduleRequest) Modifies a snapshot schedule for a cluster.modifyClusterSubnetGroup
(Consumer<ModifyClusterSubnetGroupRequest.Builder> modifyClusterSubnetGroupRequest) Modifies a cluster subnet group to include the specified list of VPC subnets.modifyClusterSubnetGroup
(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest) Modifies a cluster subnet group to include the specified list of VPC subnets.modifyCustomDomainAssociation
(Consumer<ModifyCustomDomainAssociationRequest.Builder> modifyCustomDomainAssociationRequest) Contains information for changing a custom domain association.modifyCustomDomainAssociation
(ModifyCustomDomainAssociationRequest modifyCustomDomainAssociationRequest) Contains information for changing a custom domain association.modifyEndpointAccess
(Consumer<ModifyEndpointAccessRequest.Builder> modifyEndpointAccessRequest) Modifies a Redshift-managed VPC endpoint.modifyEndpointAccess
(ModifyEndpointAccessRequest modifyEndpointAccessRequest) Modifies a Redshift-managed VPC endpoint.modifyEventSubscription
(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) Modifies an existing Amazon Redshift event notification subscription.modifyEventSubscription
(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing Amazon Redshift event notification subscription.modifyRedshiftIdcApplication
(Consumer<ModifyRedshiftIdcApplicationRequest.Builder> modifyRedshiftIdcApplicationRequest) Changes an existing Amazon Redshift IAM Identity Center application.modifyRedshiftIdcApplication
(ModifyRedshiftIdcApplicationRequest modifyRedshiftIdcApplicationRequest) Changes an existing Amazon Redshift IAM Identity Center application.modifyScheduledAction
(Consumer<ModifyScheduledActionRequest.Builder> modifyScheduledActionRequest) Modifies a scheduled action.modifyScheduledAction
(ModifyScheduledActionRequest modifyScheduledActionRequest) Modifies a scheduled action.modifySnapshotCopyRetentionPeriod
(Consumer<ModifySnapshotCopyRetentionPeriodRequest.Builder> modifySnapshotCopyRetentionPeriodRequest) 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.modifySnapshotCopyRetentionPeriod
(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest) 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.modifySnapshotSchedule
(Consumer<ModifySnapshotScheduleRequest.Builder> modifySnapshotScheduleRequest) Modifies a snapshot schedule.modifySnapshotSchedule
(ModifySnapshotScheduleRequest modifySnapshotScheduleRequest) Modifies a snapshot schedule.modifyUsageLimit
(Consumer<ModifyUsageLimitRequest.Builder> modifyUsageLimitRequest) Modifies a usage limit in a cluster.modifyUsageLimit
(ModifyUsageLimitRequest modifyUsageLimitRequest) Modifies a usage limit in a cluster.default CompletableFuture
<PauseClusterResponse> pauseCluster
(Consumer<PauseClusterRequest.Builder> pauseClusterRequest) Pauses a cluster.default CompletableFuture
<PauseClusterResponse> pauseCluster
(PauseClusterRequest pauseClusterRequest) Pauses a cluster.purchaseReservedNodeOffering
(Consumer<PurchaseReservedNodeOfferingRequest.Builder> purchaseReservedNodeOfferingRequest) Allows you to purchase reserved nodes.purchaseReservedNodeOffering
(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest) Allows you to purchase reserved nodes.putResourcePolicy
(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Updates the resource policy for a specified resource.putResourcePolicy
(PutResourcePolicyRequest putResourcePolicyRequest) Updates the resource policy for a specified resource.default CompletableFuture
<RebootClusterResponse> rebootCluster
(Consumer<RebootClusterRequest.Builder> rebootClusterRequest) Reboots a cluster.default CompletableFuture
<RebootClusterResponse> rebootCluster
(RebootClusterRequest rebootClusterRequest) Reboots a cluster.default CompletableFuture
<RejectDataShareResponse> rejectDataShare
(Consumer<RejectDataShareRequest.Builder> rejectDataShareRequest) From a datashare consumer account, rejects the specified datashare.default CompletableFuture
<RejectDataShareResponse> rejectDataShare
(RejectDataShareRequest rejectDataShareRequest) From a datashare consumer account, rejects the specified datashare.resetClusterParameterGroup
(Consumer<ResetClusterParameterGroupRequest.Builder> resetClusterParameterGroupRequest) 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".resetClusterParameterGroup
(ResetClusterParameterGroupRequest resetClusterParameterGroupRequest) 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".default CompletableFuture
<ResizeClusterResponse> resizeCluster
(Consumer<ResizeClusterRequest.Builder> resizeClusterRequest) Changes the size of the cluster.default CompletableFuture
<ResizeClusterResponse> resizeCluster
(ResizeClusterRequest resizeClusterRequest) Changes the size of the cluster.restoreFromClusterSnapshot
(Consumer<RestoreFromClusterSnapshotRequest.Builder> restoreFromClusterSnapshotRequest) Creates a new cluster from a snapshot.restoreFromClusterSnapshot
(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest) Creates a new cluster from a snapshot.restoreTableFromClusterSnapshot
(Consumer<RestoreTableFromClusterSnapshotRequest.Builder> restoreTableFromClusterSnapshotRequest) Creates a new table from a table in an Amazon Redshift cluster snapshot.restoreTableFromClusterSnapshot
(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest) Creates a new table from a table in an Amazon Redshift cluster snapshot.default CompletableFuture
<ResumeClusterResponse> resumeCluster
(Consumer<ResumeClusterRequest.Builder> resumeClusterRequest) Resumes a paused cluster.default CompletableFuture
<ResumeClusterResponse> resumeCluster
(ResumeClusterRequest resumeClusterRequest) Resumes a paused cluster.revokeClusterSecurityGroupIngress
(Consumer<RevokeClusterSecurityGroupIngressRequest.Builder> revokeClusterSecurityGroupIngressRequest) Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group.revokeClusterSecurityGroupIngress
(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest) Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group.revokeEndpointAccess
(Consumer<RevokeEndpointAccessRequest.Builder> revokeEndpointAccessRequest) Revokes access to a cluster.revokeEndpointAccess
(RevokeEndpointAccessRequest revokeEndpointAccessRequest) Revokes access to a cluster.revokeSnapshotAccess
(Consumer<RevokeSnapshotAccessRequest.Builder> revokeSnapshotAccessRequest) Removes the ability of the specified Amazon Web Services account to restore the specified snapshot.revokeSnapshotAccess
(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest) Removes the ability of the specified Amazon Web Services account to restore the specified snapshot.rotateEncryptionKey
(Consumer<RotateEncryptionKeyRequest.Builder> rotateEncryptionKeyRequest) Rotates the encryption keys for a cluster.rotateEncryptionKey
(RotateEncryptionKeyRequest rotateEncryptionKeyRequest) Rotates the encryption keys for a cluster.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationupdatePartnerStatus
(Consumer<UpdatePartnerStatusRequest.Builder> updatePartnerStatusRequest) Updates the status of a partner integration.updatePartnerStatus
(UpdatePartnerStatusRequest updatePartnerStatusRequest) Updates the status of a partner integration.default RedshiftAsyncWaiter
waiter()
Create an instance ofRedshiftAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acceptReservedNodeExchange
default CompletableFuture<AcceptReservedNodeExchangeResponse> acceptReservedNodeExchange(AcceptReservedNodeExchangeRequest acceptReservedNodeExchangeRequest) 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.
- Parameters:
acceptReservedNodeExchangeRequest
-- Returns:
- A Java Future containing the result of the AcceptReservedNodeExchange operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ReservedNodeAlreadyExistsException User already has a reservation with the given identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acceptReservedNodeExchange
default CompletableFuture<AcceptReservedNodeExchangeResponse> acceptReservedNodeExchange(Consumer<AcceptReservedNodeExchangeRequest.Builder> acceptReservedNodeExchangeRequest) 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.
This is a convenience which creates an instance of the
AcceptReservedNodeExchangeRequest.Builder
avoiding the need to create one manually viaAcceptReservedNodeExchangeRequest.builder()
- Parameters:
acceptReservedNodeExchangeRequest
- AConsumer
that will call methods onAcceptReservedNodeExchangeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AcceptReservedNodeExchange operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ReservedNodeAlreadyExistsException User already has a reservation with the given identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addPartner
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.
- Parameters:
addPartnerRequest
-- Returns:
- A Java Future containing the result of the AddPartner operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PartnerNotFoundException The name of the partner was not found.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnauthorizedPartnerIntegrationException The partner integration is not authorized.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addPartner
default CompletableFuture<AddPartnerResponse> addPartner(Consumer<AddPartnerRequest.Builder> addPartnerRequest) 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.
This is a convenience which creates an instance of the
AddPartnerRequest.Builder
avoiding the need to create one manually viaAddPartnerRequest.builder()
- Parameters:
addPartnerRequest
- AConsumer
that will call methods onAddPartnerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddPartner operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PartnerNotFoundException The name of the partner was not found.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnauthorizedPartnerIntegrationException The partner integration is not authorized.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
authorizeClusterSecurityGroupIngress
default CompletableFuture<AuthorizeClusterSecurityGroupIngressResponse> authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest) 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.
- Parameters:
authorizeClusterSecurityGroupIngressRequest
-- Returns:
- A Java Future containing the result of the AuthorizeClusterSecurityGroupIngress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - AuthorizationAlreadyExistsException The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
- AuthorizationQuotaExceededException The authorization quota for the cluster security group has been reached.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
authorizeClusterSecurityGroupIngress
default CompletableFuture<AuthorizeClusterSecurityGroupIngressResponse> authorizeClusterSecurityGroupIngress(Consumer<AuthorizeClusterSecurityGroupIngressRequest.Builder> authorizeClusterSecurityGroupIngressRequest) 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.
This is a convenience which creates an instance of the
AuthorizeClusterSecurityGroupIngressRequest.Builder
avoiding the need to create one manually viaAuthorizeClusterSecurityGroupIngressRequest.builder()
- Parameters:
authorizeClusterSecurityGroupIngressRequest
- AConsumer
that will call methods onAuthorizeClusterSecurityGroupIngressRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AuthorizeClusterSecurityGroupIngress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - AuthorizationAlreadyExistsException The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
- AuthorizationQuotaExceededException The authorization quota for the cluster security group has been reached.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
authorizeEndpointAccess
default CompletableFuture<AuthorizeEndpointAccessResponse> authorizeEndpointAccess(AuthorizeEndpointAccessRequest authorizeEndpointAccessRequest) Grants access to a cluster.
- Parameters:
authorizeEndpointAccessRequest
-- Returns:
- A Java Future containing the result of the AuthorizeEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - EndpointAuthorizationsPerClusterLimitExceededException The number of endpoint authorizations per cluster has exceeded its limit.
- UnsupportedOperationException The requested operation isn't supported.
- EndpointAuthorizationAlreadyExistsException The authorization already exists for this endpoint.
- InvalidAuthorizationStateException The status of the authorization is not valid.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
authorizeEndpointAccess
default CompletableFuture<AuthorizeEndpointAccessResponse> authorizeEndpointAccess(Consumer<AuthorizeEndpointAccessRequest.Builder> authorizeEndpointAccessRequest) Grants access to a cluster.
This is a convenience which creates an instance of the
AuthorizeEndpointAccessRequest.Builder
avoiding the need to create one manually viaAuthorizeEndpointAccessRequest.builder()
- Parameters:
authorizeEndpointAccessRequest
- AConsumer
that will call methods onAuthorizeEndpointAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AuthorizeEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - EndpointAuthorizationsPerClusterLimitExceededException The number of endpoint authorizations per cluster has exceeded its limit.
- UnsupportedOperationException The requested operation isn't supported.
- EndpointAuthorizationAlreadyExistsException The authorization already exists for this endpoint.
- InvalidAuthorizationStateException The status of the authorization is not valid.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
authorizeSnapshotAccess
default CompletableFuture<AuthorizeSnapshotAccessResponse> authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest) 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.
- Parameters:
authorizeSnapshotAccessRequest
-- Returns:
- A Java Future containing the result of the AuthorizeSnapshotAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- AuthorizationAlreadyExistsException The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
- AuthorizationQuotaExceededException The authorization quota for the cluster security group has been reached.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
authorizeSnapshotAccess
default CompletableFuture<AuthorizeSnapshotAccessResponse> authorizeSnapshotAccess(Consumer<AuthorizeSnapshotAccessRequest.Builder> authorizeSnapshotAccessRequest) 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.
This is a convenience which creates an instance of the
AuthorizeSnapshotAccessRequest.Builder
avoiding the need to create one manually viaAuthorizeSnapshotAccessRequest.builder()
- Parameters:
authorizeSnapshotAccessRequest
- AConsumer
that will call methods onAuthorizeSnapshotAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AuthorizeSnapshotAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- AuthorizationAlreadyExistsException The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
- AuthorizationQuotaExceededException The authorization quota for the cluster security group has been reached.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteClusterSnapshots
default CompletableFuture<BatchDeleteClusterSnapshotsResponse> batchDeleteClusterSnapshots(BatchDeleteClusterSnapshotsRequest batchDeleteClusterSnapshotsRequest) Deletes a set of cluster snapshots.
- Parameters:
batchDeleteClusterSnapshotsRequest
-- Returns:
- A Java Future containing the result of the BatchDeleteClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BatchDeleteRequestSizeExceededException The maximum number for a batch delete of snapshots has been reached. The limit is 100.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteClusterSnapshots
default CompletableFuture<BatchDeleteClusterSnapshotsResponse> batchDeleteClusterSnapshots(Consumer<BatchDeleteClusterSnapshotsRequest.Builder> batchDeleteClusterSnapshotsRequest) Deletes a set of cluster snapshots.
This is a convenience which creates an instance of the
BatchDeleteClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaBatchDeleteClusterSnapshotsRequest.builder()
- Parameters:
batchDeleteClusterSnapshotsRequest
- AConsumer
that will call methods onBatchDeleteClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDeleteClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BatchDeleteRequestSizeExceededException The maximum number for a batch delete of snapshots has been reached. The limit is 100.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchModifyClusterSnapshots
default CompletableFuture<BatchModifyClusterSnapshotsResponse> batchModifyClusterSnapshots(BatchModifyClusterSnapshotsRequest batchModifyClusterSnapshotsRequest) Modifies the settings for a set of cluster snapshots.
- Parameters:
batchModifyClusterSnapshotsRequest
-- Returns:
- A Java Future containing the result of the BatchModifyClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- BatchModifyClusterSnapshotsLimitExceededException The maximum number for snapshot identifiers has been reached. The limit is 100.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
- See Also:
-
batchModifyClusterSnapshots
default CompletableFuture<BatchModifyClusterSnapshotsResponse> batchModifyClusterSnapshots(Consumer<BatchModifyClusterSnapshotsRequest.Builder> batchModifyClusterSnapshotsRequest) Modifies the settings for a set of cluster snapshots.
This is a convenience which creates an instance of the
BatchModifyClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaBatchModifyClusterSnapshotsRequest.builder()
- Parameters:
batchModifyClusterSnapshotsRequest
- AConsumer
that will call methods onBatchModifyClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchModifyClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- BatchModifyClusterSnapshotsLimitExceededException The maximum number for snapshot identifiers has been reached. The limit is 100.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
- See Also:
-
cancelResize
default CompletableFuture<CancelResizeResponse> cancelResize(CancelResizeRequest cancelResizeRequest) Cancels a resize operation for a cluster.
- Parameters:
cancelResizeRequest
-- Returns:
- A Java Future containing the result of the CancelResize operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ResizeNotFoundException A resize operation for the specified cluster is not found.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
cancelResize
default CompletableFuture<CancelResizeResponse> cancelResize(Consumer<CancelResizeRequest.Builder> cancelResizeRequest) Cancels a resize operation for a cluster.
This is a convenience which creates an instance of the
CancelResizeRequest.Builder
avoiding the need to create one manually viaCancelResizeRequest.builder()
- Parameters:
cancelResizeRequest
- AConsumer
that will call methods onCancelResizeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelResize operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ResizeNotFoundException A resize operation for the specified cluster is not found.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
copyClusterSnapshot
default CompletableFuture<CopyClusterSnapshotResponse> copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest) 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.
- Parameters:
copyClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the CopyClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotAlreadyExistsException The value specified as a snapshot identifier is already used by an existing snapshot.
- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterSnapshotQuotaExceededException The request would result in the user exceeding the allowed number of cluster snapshots.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
copyClusterSnapshot
default CompletableFuture<CopyClusterSnapshotResponse> copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest) 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.
This is a convenience which creates an instance of the
CopyClusterSnapshotRequest.Builder
avoiding the need to create one manually viaCopyClusterSnapshotRequest.builder()
- Parameters:
copyClusterSnapshotRequest
- AConsumer
that will call methods onCopyClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotAlreadyExistsException The value specified as a snapshot identifier is already used by an existing snapshot.
- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterSnapshotQuotaExceededException The request would result in the user exceeding the allowed number of cluster snapshots.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
createAuthenticationProfile
default CompletableFuture<CreateAuthenticationProfileResponse> createAuthenticationProfile(CreateAuthenticationProfileRequest createAuthenticationProfileRequest) Creates an authentication profile with the specified parameters.
- Parameters:
createAuthenticationProfileRequest
-- Returns:
- A Java Future containing the result of the CreateAuthenticationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AuthenticationProfileAlreadyExistsException The authentication profile already exists.
- AuthenticationProfileQuotaExceededException The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.
- InvalidAuthenticationProfileRequestException The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAuthenticationProfile
default CompletableFuture<CreateAuthenticationProfileResponse> createAuthenticationProfile(Consumer<CreateAuthenticationProfileRequest.Builder> createAuthenticationProfileRequest) Creates an authentication profile with the specified parameters.
This is a convenience which creates an instance of the
CreateAuthenticationProfileRequest.Builder
avoiding the need to create one manually viaCreateAuthenticationProfileRequest.builder()
- Parameters:
createAuthenticationProfileRequest
- AConsumer
that will call methods onCreateAuthenticationProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAuthenticationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AuthenticationProfileAlreadyExistsException The authentication profile already exists.
- AuthenticationProfileQuotaExceededException The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.
- InvalidAuthenticationProfileRequestException The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCluster
default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest) 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.
- Parameters:
createClusterRequest
-- Returns:
- A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterAlreadyExistsException The account already has a cluster with the given identifier.
- InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- ClusterQuotaExceededException The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- InvalidVpcNetworkStateException The cluster subnet group does not cover all Availability Zones.
- InvalidClusterSubnetGroupStateException The cluster subnet group cannot be deleted because it is in use.
- InvalidSubnetException The requested subnet is not valid, or not all of the subnets are in the same VPC.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidElasticIpException The Elastic IP (EIP) is invalid or cannot be found.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidClusterTrackException The provided cluster track name is not valid.
- SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- Ipv6CidrBlockNotFoundException There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
- UnsupportedOperationException The requested operation isn't supported.
- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCluster
default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) 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.
This is a convenience which creates an instance of the
CreateClusterRequest.Builder
avoiding the need to create one manually viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterAlreadyExistsException The account already has a cluster with the given identifier.
- InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- ClusterQuotaExceededException The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- InvalidVpcNetworkStateException The cluster subnet group does not cover all Availability Zones.
- InvalidClusterSubnetGroupStateException The cluster subnet group cannot be deleted because it is in use.
- InvalidSubnetException The requested subnet is not valid, or not all of the subnets are in the same VPC.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidElasticIpException The Elastic IP (EIP) is invalid or cannot be found.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidClusterTrackException The provided cluster track name is not valid.
- SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- Ipv6CidrBlockNotFoundException There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
- UnsupportedOperationException The requested operation isn't supported.
- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createClusterParameterGroup
default CompletableFuture<CreateClusterParameterGroupResponse> createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest) 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.
- Parameters:
createClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CreateClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- ClusterParameterGroupAlreadyExistsException A cluster parameter group with the same name already exists.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createClusterParameterGroup
default CompletableFuture<CreateClusterParameterGroupResponse> createClusterParameterGroup(Consumer<CreateClusterParameterGroupRequest.Builder> createClusterParameterGroupRequest) 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.
This is a convenience which creates an instance of the
CreateClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaCreateClusterParameterGroupRequest.builder()
- Parameters:
createClusterParameterGroupRequest
- AConsumer
that will call methods onCreateClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- ClusterParameterGroupAlreadyExistsException A cluster parameter group with the same name already exists.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createClusterSecurityGroup
default CompletableFuture<CreateClusterSecurityGroupResponse> createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest) 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.
- Parameters:
createClusterSecurityGroupRequest
-- Returns:
- A Java Future containing the result of the CreateClusterSecurityGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupAlreadyExistsException A cluster security group with the same name already exists.
- ClusterSecurityGroupQuotaExceededException The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createClusterSecurityGroup
default CompletableFuture<CreateClusterSecurityGroupResponse> createClusterSecurityGroup(Consumer<CreateClusterSecurityGroupRequest.Builder> createClusterSecurityGroupRequest) 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.
This is a convenience which creates an instance of the
CreateClusterSecurityGroupRequest.Builder
avoiding the need to create one manually viaCreateClusterSecurityGroupRequest.builder()
- Parameters:
createClusterSecurityGroupRequest
- AConsumer
that will call methods onCreateClusterSecurityGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateClusterSecurityGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupAlreadyExistsException A cluster security group with the same name already exists.
- ClusterSecurityGroupQuotaExceededException The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createClusterSnapshot
default CompletableFuture<CreateClusterSnapshotResponse> createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest) 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.
- Parameters:
createClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the CreateClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotAlreadyExistsException The value specified as a snapshot identifier is already used by an existing snapshot.
- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotQuotaExceededException The request would result in the user exceeding the allowed number of cluster snapshots.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createClusterSnapshot
default CompletableFuture<CreateClusterSnapshotResponse> createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest) 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.
This is a convenience which creates an instance of the
CreateClusterSnapshotRequest.Builder
avoiding the need to create one manually viaCreateClusterSnapshotRequest.builder()
- Parameters:
createClusterSnapshotRequest
- AConsumer
that will call methods onCreateClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotAlreadyExistsException The value specified as a snapshot identifier is already used by an existing snapshot.
- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotQuotaExceededException The request would result in the user exceeding the allowed number of cluster snapshots.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createClusterSubnetGroup
default CompletableFuture<CreateClusterSubnetGroupResponse> createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest) 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.
- Parameters:
createClusterSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the CreateClusterSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupAlreadyExistsException A ClusterSubnetGroupName is already used by an existing cluster subnet group.
- ClusterSubnetGroupQuotaExceededException The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- ClusterSubnetQuotaExceededException The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- InvalidSubnetException The requested subnet is not valid, or not all of the subnets are in the same VPC.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createClusterSubnetGroup
default CompletableFuture<CreateClusterSubnetGroupResponse> createClusterSubnetGroup(Consumer<CreateClusterSubnetGroupRequest.Builder> createClusterSubnetGroupRequest) 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.
This is a convenience which creates an instance of the
CreateClusterSubnetGroupRequest.Builder
avoiding the need to create one manually viaCreateClusterSubnetGroupRequest.builder()
- Parameters:
createClusterSubnetGroupRequest
- AConsumer
that will call methods onCreateClusterSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateClusterSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupAlreadyExistsException A ClusterSubnetGroupName is already used by an existing cluster subnet group.
- ClusterSubnetGroupQuotaExceededException The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- ClusterSubnetQuotaExceededException The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- InvalidSubnetException The requested subnet is not valid, or not all of the subnets are in the same VPC.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomDomainAssociation
default CompletableFuture<CreateCustomDomainAssociationResponse> createCustomDomainAssociation(CreateCustomDomainAssociationRequest createCustomDomainAssociationRequest) 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).
- Parameters:
createCustomDomainAssociationRequest
-- Returns:
- A Java Future containing the result of the CreateCustomDomainAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedOperationException The requested operation isn't supported.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - CustomCnameAssociationException An error occurred when an attempt was made to change the custom domain association.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomDomainAssociation
default CompletableFuture<CreateCustomDomainAssociationResponse> createCustomDomainAssociation(Consumer<CreateCustomDomainAssociationRequest.Builder> createCustomDomainAssociationRequest) 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).
This is a convenience which creates an instance of the
CreateCustomDomainAssociationRequest.Builder
avoiding the need to create one manually viaCreateCustomDomainAssociationRequest.builder()
- Parameters:
createCustomDomainAssociationRequest
- AConsumer
that will call methods onCreateCustomDomainAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCustomDomainAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedOperationException The requested operation isn't supported.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - CustomCnameAssociationException An error occurred when an attempt was made to change the custom domain association.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEndpointAccess
default CompletableFuture<CreateEndpointAccessResponse> createEndpointAccess(CreateEndpointAccessRequest createEndpointAccessRequest) Creates a Redshift-managed VPC endpoint.
- Parameters:
createEndpointAccessRequest
-- Returns:
- A Java Future containing the result of the CreateEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - AccessToClusterDeniedException You are not authorized to access the cluster.
- EndpointsPerClusterLimitExceededException The number of Redshift-managed VPC endpoints per cluster has exceeded its limit.
- EndpointsPerAuthorizationLimitExceededException The number of Redshift-managed VPC endpoints per authorization has exceeded its limit.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- EndpointAlreadyExistsException The account already has a Redshift-managed VPC endpoint with the given identifier.
- UnsupportedOperationException The requested operation isn't supported.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
createEndpointAccess
default CompletableFuture<CreateEndpointAccessResponse> createEndpointAccess(Consumer<CreateEndpointAccessRequest.Builder> createEndpointAccessRequest) Creates a Redshift-managed VPC endpoint.
This is a convenience which creates an instance of the
CreateEndpointAccessRequest.Builder
avoiding the need to create one manually viaCreateEndpointAccessRequest.builder()
- Parameters:
createEndpointAccessRequest
- AConsumer
that will call methods onCreateEndpointAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - AccessToClusterDeniedException You are not authorized to access the cluster.
- EndpointsPerClusterLimitExceededException The number of Redshift-managed VPC endpoints per cluster has exceeded its limit.
- EndpointsPerAuthorizationLimitExceededException The number of Redshift-managed VPC endpoints per authorization has exceeded its limit.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- EndpointAlreadyExistsException The account already has a Redshift-managed VPC endpoint with the given identifier.
- UnsupportedOperationException The requested operation isn't supported.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
createEventSubscription
default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) 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.
- Parameters:
createEventSubscriptionRequest
-- Returns:
- A Java Future containing the result of the CreateEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- SubscriptionAlreadyExistException There is already an existing event notification subscription with the specified name.
- SnsInvalidTopicException Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
- SnsNoAuthorizationException You do not have permission to publish to the specified Amazon SNS topic.
- SnsTopicArnNotFoundException An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
- SubscriptionEventIdNotFoundException An Amazon Redshift event with the specified event ID does not exist.
- SubscriptionCategoryNotFoundException The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
- SubscriptionSeverityNotFoundException The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
- SourceNotFoundException The specified Amazon Redshift event source could not be found.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEventSubscription
default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) 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.
This is a convenience which creates an instance of the
CreateEventSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateEventSubscriptionRequest.builder()
- Parameters:
createEventSubscriptionRequest
- AConsumer
that will call methods onCreateEventSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- SubscriptionAlreadyExistException There is already an existing event notification subscription with the specified name.
- SnsInvalidTopicException Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
- SnsNoAuthorizationException You do not have permission to publish to the specified Amazon SNS topic.
- SnsTopicArnNotFoundException An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
- SubscriptionEventIdNotFoundException An Amazon Redshift event with the specified event ID does not exist.
- SubscriptionCategoryNotFoundException The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
- SubscriptionSeverityNotFoundException The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
- SourceNotFoundException The specified Amazon Redshift event source could not be found.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHsmClientCertificate
default CompletableFuture<CreateHsmClientCertificateResponse> createHsmClientCertificate(CreateHsmClientCertificateRequest createHsmClientCertificateRequest) 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.
- Parameters:
createHsmClientCertificateRequest
-- Returns:
- A Java Future containing the result of the CreateHsmClientCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmClientCertificateAlreadyExistsException There is already an existing Amazon Redshift HSM client certificate with the specified identifier.
- HsmClientCertificateQuotaExceededException The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHsmClientCertificate
default CompletableFuture<CreateHsmClientCertificateResponse> createHsmClientCertificate(Consumer<CreateHsmClientCertificateRequest.Builder> createHsmClientCertificateRequest) 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.
This is a convenience which creates an instance of the
CreateHsmClientCertificateRequest.Builder
avoiding the need to create one manually viaCreateHsmClientCertificateRequest.builder()
- Parameters:
createHsmClientCertificateRequest
- AConsumer
that will call methods onCreateHsmClientCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateHsmClientCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmClientCertificateAlreadyExistsException There is already an existing Amazon Redshift HSM client certificate with the specified identifier.
- HsmClientCertificateQuotaExceededException The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHsmConfiguration
default CompletableFuture<CreateHsmConfigurationResponse> createHsmConfiguration(CreateHsmConfigurationRequest createHsmConfigurationRequest) 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.
- Parameters:
createHsmConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateHsmConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmConfigurationAlreadyExistsException There is already an existing Amazon Redshift HSM configuration with the specified identifier.
- HsmConfigurationQuotaExceededException The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHsmConfiguration
default CompletableFuture<CreateHsmConfigurationResponse> createHsmConfiguration(Consumer<CreateHsmConfigurationRequest.Builder> createHsmConfigurationRequest) 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.
This is a convenience which creates an instance of the
CreateHsmConfigurationRequest.Builder
avoiding the need to create one manually viaCreateHsmConfigurationRequest.builder()
- Parameters:
createHsmConfigurationRequest
- AConsumer
that will call methods onCreateHsmConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateHsmConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmConfigurationAlreadyExistsException There is already an existing Amazon Redshift HSM configuration with the specified identifier.
- HsmConfigurationQuotaExceededException The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRedshiftIdcApplication
default CompletableFuture<CreateRedshiftIdcApplicationResponse> createRedshiftIdcApplication(CreateRedshiftIdcApplicationRequest createRedshiftIdcApplicationRequest) Creates an Amazon Redshift application for use with IAM Identity Center.
- Parameters:
createRedshiftIdcApplicationRequest
-- Returns:
- A Java Future containing the result of the CreateRedshiftIdcApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationAlreadyExistsException The application you attempted to add already exists.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- RedshiftIdcApplicationQuotaExceededException The maximum number of Redshift IAM Identity Center applications was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRedshiftIdcApplication
default CompletableFuture<CreateRedshiftIdcApplicationResponse> createRedshiftIdcApplication(Consumer<CreateRedshiftIdcApplicationRequest.Builder> createRedshiftIdcApplicationRequest) Creates an Amazon Redshift application for use with IAM Identity Center.
This is a convenience which creates an instance of the
CreateRedshiftIdcApplicationRequest.Builder
avoiding the need to create one manually viaCreateRedshiftIdcApplicationRequest.builder()
- Parameters:
createRedshiftIdcApplicationRequest
- AConsumer
that will call methods onCreateRedshiftIdcApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRedshiftIdcApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationAlreadyExistsException The application you attempted to add already exists.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- RedshiftIdcApplicationQuotaExceededException The maximum number of Redshift IAM Identity Center applications was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createScheduledAction
default CompletableFuture<CreateScheduledActionResponse> createScheduledAction(CreateScheduledActionRequest createScheduledActionRequest) 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.- Parameters:
createScheduledActionRequest
-- Returns:
- A Java Future containing the result of the CreateScheduledAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ScheduledActionAlreadyExistsException The scheduled action already exists.
- ScheduledActionQuotaExceededException The quota for scheduled actions exceeded.
- ScheduledActionTypeUnsupportedException The action type specified for a scheduled action is not supported.
- InvalidScheduleException The schedule you submitted isn't valid.
- InvalidScheduledActionException The scheduled action is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
createScheduledAction
default CompletableFuture<CreateScheduledActionResponse> createScheduledAction(Consumer<CreateScheduledActionRequest.Builder> createScheduledActionRequest) 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.
This is a convenience which creates an instance of the
CreateScheduledActionRequest.Builder
avoiding the need to create one manually viaCreateScheduledActionRequest.builder()
- Parameters:
createScheduledActionRequest
- AConsumer
that will call methods onCreateScheduledActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateScheduledAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ScheduledActionAlreadyExistsException The scheduled action already exists.
- ScheduledActionQuotaExceededException The quota for scheduled actions exceeded.
- ScheduledActionTypeUnsupportedException The action type specified for a scheduled action is not supported.
- InvalidScheduleException The schedule you submitted isn't valid.
- InvalidScheduledActionException The scheduled action is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
createSnapshotCopyGrant
default CompletableFuture<CreateSnapshotCopyGrantResponse> createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest createSnapshotCopyGrantRequest) 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.
- Parameters:
createSnapshotCopyGrantRequest
- The result of theCreateSnapshotCopyGrant
action.- Returns:
- A Java Future containing the result of the CreateSnapshotCopyGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotCopyGrantAlreadyExistsException The snapshot copy grant can't be created because a grant with the same name already exists.
- SnapshotCopyGrantQuotaExceededException The Amazon Web Services account has exceeded the maximum number of snapshot copy grants in this region.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSnapshotCopyGrant
default CompletableFuture<CreateSnapshotCopyGrantResponse> createSnapshotCopyGrant(Consumer<CreateSnapshotCopyGrantRequest.Builder> createSnapshotCopyGrantRequest) 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.
This is a convenience which creates an instance of the
CreateSnapshotCopyGrantRequest.Builder
avoiding the need to create one manually viaCreateSnapshotCopyGrantRequest.builder()
- Parameters:
createSnapshotCopyGrantRequest
- AConsumer
that will call methods onCreateSnapshotCopyGrantRequest.Builder
to create a request. The result of theCreateSnapshotCopyGrant
action.- Returns:
- A Java Future containing the result of the CreateSnapshotCopyGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotCopyGrantAlreadyExistsException The snapshot copy grant can't be created because a grant with the same name already exists.
- SnapshotCopyGrantQuotaExceededException The Amazon Web Services account has exceeded the maximum number of snapshot copy grants in this region.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSnapshotSchedule
default CompletableFuture<CreateSnapshotScheduleResponse> createSnapshotSchedule(CreateSnapshotScheduleRequest createSnapshotScheduleRequest) Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
- Parameters:
createSnapshotScheduleRequest
-- Returns:
- A Java Future containing the result of the CreateSnapshotSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotScheduleAlreadyExistsException The specified snapshot schedule already exists.
- InvalidScheduleException The schedule you submitted isn't valid.
- SnapshotScheduleQuotaExceededException You have exceeded the quota of snapshot schedules.
- TagLimitExceededException You have exceeded the number of tags allowed.
- ScheduleDefinitionTypeUnsupportedException The definition you submitted is not supported.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSnapshotSchedule
default CompletableFuture<CreateSnapshotScheduleResponse> createSnapshotSchedule(Consumer<CreateSnapshotScheduleRequest.Builder> createSnapshotScheduleRequest) Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
This is a convenience which creates an instance of the
CreateSnapshotScheduleRequest.Builder
avoiding the need to create one manually viaCreateSnapshotScheduleRequest.builder()
- Parameters:
createSnapshotScheduleRequest
- AConsumer
that will call methods onCreateSnapshotScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSnapshotSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotScheduleAlreadyExistsException The specified snapshot schedule already exists.
- InvalidScheduleException The schedule you submitted isn't valid.
- SnapshotScheduleQuotaExceededException You have exceeded the quota of snapshot schedules.
- TagLimitExceededException You have exceeded the number of tags allowed.
- ScheduleDefinitionTypeUnsupportedException The definition you submitted is not supported.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTags
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.
- Parameters:
createTagsRequest
- Contains the output from theCreateTags
action.- Returns:
- A Java Future containing the result of the CreateTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagLimitExceededException You have exceeded the number of tags allowed.
- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTags
default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) 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.
This is a convenience which creates an instance of the
CreateTagsRequest.Builder
avoiding the need to create one manually viaCreateTagsRequest.builder()
- Parameters:
createTagsRequest
- AConsumer
that will call methods onCreateTagsRequest.Builder
to create a request. Contains the output from theCreateTags
action.- Returns:
- A Java Future containing the result of the CreateTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagLimitExceededException You have exceeded the number of tags allowed.
- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUsageLimit
default CompletableFuture<CreateUsageLimitResponse> createUsageLimit(CreateUsageLimitRequest createUsageLimitRequest) Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
- Parameters:
createUsageLimitRequest
-- Returns:
- A Java Future containing the result of the CreateUsageLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- UsageLimitAlreadyExistsException The usage limit already exists.
- InvalidUsageLimitException The usage limit is not valid.
- TagLimitExceededException You have exceeded the number of tags allowed.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
createUsageLimit
default CompletableFuture<CreateUsageLimitResponse> createUsageLimit(Consumer<CreateUsageLimitRequest.Builder> createUsageLimitRequest) Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
This is a convenience which creates an instance of the
CreateUsageLimitRequest.Builder
avoiding the need to create one manually viaCreateUsageLimitRequest.builder()
- Parameters:
createUsageLimitRequest
- AConsumer
that will call methods onCreateUsageLimitRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUsageLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- UsageLimitAlreadyExistsException The usage limit already exists.
- InvalidUsageLimitException The usage limit is not valid.
- TagLimitExceededException You have exceeded the number of tags allowed.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
deleteAuthenticationProfile
default CompletableFuture<DeleteAuthenticationProfileResponse> deleteAuthenticationProfile(DeleteAuthenticationProfileRequest deleteAuthenticationProfileRequest) Deletes an authentication profile.
- Parameters:
deleteAuthenticationProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteAuthenticationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AuthenticationProfileNotFoundException The authentication profile can't be found.
- InvalidAuthenticationProfileRequestException The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAuthenticationProfile
default CompletableFuture<DeleteAuthenticationProfileResponse> deleteAuthenticationProfile(Consumer<DeleteAuthenticationProfileRequest.Builder> deleteAuthenticationProfileRequest) Deletes an authentication profile.
This is a convenience which creates an instance of the
DeleteAuthenticationProfileRequest.Builder
avoiding the need to create one manually viaDeleteAuthenticationProfileRequest.builder()
- Parameters:
deleteAuthenticationProfileRequest
- AConsumer
that will call methods onDeleteAuthenticationProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAuthenticationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AuthenticationProfileNotFoundException The authentication profile can't be found.
- InvalidAuthenticationProfileRequestException The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCluster
default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest) 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.
- Parameters:
deleteClusterRequest
-- Returns:
- A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterSnapshotAlreadyExistsException The value specified as a snapshot identifier is already used by an existing snapshot.
- ClusterSnapshotQuotaExceededException The request would result in the user exceeding the allowed number of cluster snapshots.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
deleteCluster
default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) 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.
This is a convenience which creates an instance of the
DeleteClusterRequest.Builder
avoiding the need to create one manually viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterSnapshotAlreadyExistsException The value specified as a snapshot identifier is already used by an existing snapshot.
- ClusterSnapshotQuotaExceededException The request would result in the user exceeding the allowed number of cluster snapshots.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
deleteClusterParameterGroup
default CompletableFuture<DeleteClusterParameterGroupResponse> deleteClusterParameterGroup(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest) Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
- Parameters:
deleteClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterParameterGroupStateException The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteClusterParameterGroup
default CompletableFuture<DeleteClusterParameterGroupResponse> deleteClusterParameterGroup(Consumer<DeleteClusterParameterGroupRequest.Builder> deleteClusterParameterGroupRequest) Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
This is a convenience which creates an instance of the
DeleteClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaDeleteClusterParameterGroupRequest.builder()
- Parameters:
deleteClusterParameterGroupRequest
- AConsumer
that will call methods onDeleteClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterParameterGroupStateException The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteClusterSecurityGroup
default CompletableFuture<DeleteClusterSecurityGroupResponse> deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest) 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.
- Parameters:
deleteClusterSecurityGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteClusterSecurityGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
- See Also:
-
deleteClusterSecurityGroup
default CompletableFuture<DeleteClusterSecurityGroupResponse> deleteClusterSecurityGroup(Consumer<DeleteClusterSecurityGroupRequest.Builder> deleteClusterSecurityGroupRequest) 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.
This is a convenience which creates an instance of the
DeleteClusterSecurityGroupRequest.Builder
avoiding the need to create one manually viaDeleteClusterSecurityGroupRequest.builder()
- Parameters:
deleteClusterSecurityGroupRequest
- AConsumer
that will call methods onDeleteClusterSecurityGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteClusterSecurityGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
- See Also:
-
deleteClusterSnapshot
default CompletableFuture<DeleteClusterSnapshotResponse> deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) 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.
- Parameters:
deleteClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the DeleteClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
- See Also:
-
deleteClusterSnapshot
default CompletableFuture<DeleteClusterSnapshotResponse> deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest) 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.
This is a convenience which creates an instance of the
DeleteClusterSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteClusterSnapshotRequest.builder()
- Parameters:
deleteClusterSnapshotRequest
- AConsumer
that will call methods onDeleteClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
- See Also:
-
deleteClusterSubnetGroup
default CompletableFuture<DeleteClusterSubnetGroupResponse> deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest) Deletes the specified cluster subnet group.
- Parameters:
deleteClusterSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteClusterSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSubnetGroupStateException The cluster subnet group cannot be deleted because it is in use.
- InvalidClusterSubnetStateException The state of the subnet is invalid.
- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteClusterSubnetGroup
default CompletableFuture<DeleteClusterSubnetGroupResponse> deleteClusterSubnetGroup(Consumer<DeleteClusterSubnetGroupRequest.Builder> deleteClusterSubnetGroupRequest) Deletes the specified cluster subnet group.
This is a convenience which creates an instance of the
DeleteClusterSubnetGroupRequest.Builder
avoiding the need to create one manually viaDeleteClusterSubnetGroupRequest.builder()
- Parameters:
deleteClusterSubnetGroupRequest
- AConsumer
that will call methods onDeleteClusterSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteClusterSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSubnetGroupStateException The cluster subnet group cannot be deleted because it is in use.
- InvalidClusterSubnetStateException The state of the subnet is invalid.
- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomDomainAssociation
default CompletableFuture<DeleteCustomDomainAssociationResponse> deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest deleteCustomDomainAssociationRequest) Contains information about deleting a custom domain association for a cluster.
- Parameters:
deleteCustomDomainAssociationRequest
-- Returns:
- A Java Future containing the result of the DeleteCustomDomainAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedOperationException The requested operation isn't supported.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - CustomCnameAssociationException An error occurred when an attempt was made to change the custom domain association.
- CustomDomainAssociationNotFoundException An error occurred. The custom domain name couldn't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomDomainAssociation
default CompletableFuture<DeleteCustomDomainAssociationResponse> deleteCustomDomainAssociation(Consumer<DeleteCustomDomainAssociationRequest.Builder> deleteCustomDomainAssociationRequest) Contains information about deleting a custom domain association for a cluster.
This is a convenience which creates an instance of the
DeleteCustomDomainAssociationRequest.Builder
avoiding the need to create one manually viaDeleteCustomDomainAssociationRequest.builder()
- Parameters:
deleteCustomDomainAssociationRequest
- AConsumer
that will call methods onDeleteCustomDomainAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCustomDomainAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedOperationException The requested operation isn't supported.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - CustomCnameAssociationException An error occurred when an attempt was made to change the custom domain association.
- CustomDomainAssociationNotFoundException An error occurred. The custom domain name couldn't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEndpointAccess
default CompletableFuture<DeleteEndpointAccessResponse> deleteEndpointAccess(DeleteEndpointAccessRequest deleteEndpointAccessRequest) Deletes a Redshift-managed VPC endpoint.
- Parameters:
deleteEndpointAccessRequest
-- Returns:
- A Java Future containing the result of the DeleteEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidEndpointStateException The status of the endpoint is not valid.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
deleteEndpointAccess
default CompletableFuture<DeleteEndpointAccessResponse> deleteEndpointAccess(Consumer<DeleteEndpointAccessRequest.Builder> deleteEndpointAccessRequest) Deletes a Redshift-managed VPC endpoint.
This is a convenience which creates an instance of the
DeleteEndpointAccessRequest.Builder
avoiding the need to create one manually viaDeleteEndpointAccessRequest.builder()
- Parameters:
deleteEndpointAccessRequest
- AConsumer
that will call methods onDeleteEndpointAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidEndpointStateException The status of the endpoint is not valid.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
deleteEventSubscription
default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an Amazon Redshift event notification subscription.
- Parameters:
deleteEventSubscriptionRequest
-- Returns:
- A Java Future containing the result of the DeleteEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- InvalidSubscriptionStateException The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEventSubscription
default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) Deletes an Amazon Redshift event notification subscription.
This is a convenience which creates an instance of the
DeleteEventSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteEventSubscriptionRequest.builder()
- Parameters:
deleteEventSubscriptionRequest
- AConsumer
that will call methods onDeleteEventSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- InvalidSubscriptionStateException The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHsmClientCertificate
default CompletableFuture<DeleteHsmClientCertificateResponse> deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest) Deletes the specified HSM client certificate.
- Parameters:
deleteHsmClientCertificateRequest
-- Returns:
- A Java Future containing the result of the DeleteHsmClientCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidHsmClientCertificateStateException The specified HSM client certificate is not in the
available
state, or it is still in use by one or more Amazon Redshift clusters. - HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidHsmClientCertificateStateException The specified HSM client certificate is not in the
- See Also:
-
deleteHsmClientCertificate
default CompletableFuture<DeleteHsmClientCertificateResponse> deleteHsmClientCertificate(Consumer<DeleteHsmClientCertificateRequest.Builder> deleteHsmClientCertificateRequest) Deletes the specified HSM client certificate.
This is a convenience which creates an instance of the
DeleteHsmClientCertificateRequest.Builder
avoiding the need to create one manually viaDeleteHsmClientCertificateRequest.builder()
- Parameters:
deleteHsmClientCertificateRequest
- AConsumer
that will call methods onDeleteHsmClientCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteHsmClientCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidHsmClientCertificateStateException The specified HSM client certificate is not in the
available
state, or it is still in use by one or more Amazon Redshift clusters. - HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidHsmClientCertificateStateException The specified HSM client certificate is not in the
- See Also:
-
deleteHsmConfiguration
default CompletableFuture<DeleteHsmConfigurationResponse> deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest) Deletes the specified Amazon Redshift HSM configuration.
- Parameters:
deleteHsmConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteHsmConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidHsmConfigurationStateException The specified HSM configuration is not in the
available
state, or it is still in use by one or more Amazon Redshift clusters. - HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidHsmConfigurationStateException The specified HSM configuration is not in the
- See Also:
-
deleteHsmConfiguration
default CompletableFuture<DeleteHsmConfigurationResponse> deleteHsmConfiguration(Consumer<DeleteHsmConfigurationRequest.Builder> deleteHsmConfigurationRequest) Deletes the specified Amazon Redshift HSM configuration.
This is a convenience which creates an instance of the
DeleteHsmConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteHsmConfigurationRequest.builder()
- Parameters:
deleteHsmConfigurationRequest
- AConsumer
that will call methods onDeleteHsmConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteHsmConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidHsmConfigurationStateException The specified HSM configuration is not in the
available
state, or it is still in use by one or more Amazon Redshift clusters. - HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidHsmConfigurationStateException The specified HSM configuration is not in the
- See Also:
-
deletePartner
default CompletableFuture<DeletePartnerResponse> deletePartner(DeletePartnerRequest deletePartnerRequest) Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.
- Parameters:
deletePartnerRequest
-- Returns:
- A Java Future containing the result of the DeletePartner operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PartnerNotFoundException The name of the partner was not found.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnauthorizedPartnerIntegrationException The partner integration is not authorized.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePartner
default CompletableFuture<DeletePartnerResponse> deletePartner(Consumer<DeletePartnerRequest.Builder> deletePartnerRequest) Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.
This is a convenience which creates an instance of the
DeletePartnerRequest.Builder
avoiding the need to create one manually viaDeletePartnerRequest.builder()
- Parameters:
deletePartnerRequest
- AConsumer
that will call methods onDeletePartnerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePartner operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PartnerNotFoundException The name of the partner was not found.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnauthorizedPartnerIntegrationException The partner integration is not authorized.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRedshiftIdcApplication
default CompletableFuture<DeleteRedshiftIdcApplicationResponse> deleteRedshiftIdcApplication(DeleteRedshiftIdcApplicationRequest deleteRedshiftIdcApplicationRequest) Deletes an Amazon Redshift IAM Identity Center application.
- Parameters:
deleteRedshiftIdcApplicationRequest
-- Returns:
- A Java Future containing the result of the DeleteRedshiftIdcApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRedshiftIdcApplication
default CompletableFuture<DeleteRedshiftIdcApplicationResponse> deleteRedshiftIdcApplication(Consumer<DeleteRedshiftIdcApplicationRequest.Builder> deleteRedshiftIdcApplicationRequest) Deletes an Amazon Redshift IAM Identity Center application.
This is a convenience which creates an instance of the
DeleteRedshiftIdcApplicationRequest.Builder
avoiding the need to create one manually viaDeleteRedshiftIdcApplicationRequest.builder()
- Parameters:
deleteRedshiftIdcApplicationRequest
- AConsumer
that will call methods onDeleteRedshiftIdcApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRedshiftIdcApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes the resource policy for a specified resource.
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes the resource policy for a specified resource.
This is a convenience which creates an instance of the
DeleteResourcePolicyRequest.Builder
avoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScheduledAction
default CompletableFuture<DeleteScheduledActionResponse> deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) Deletes a scheduled action.
- Parameters:
deleteScheduledActionRequest
-- Returns:
- A Java Future containing the result of the DeleteScheduledAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ScheduledActionNotFoundException The scheduled action cannot be found.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScheduledAction
default CompletableFuture<DeleteScheduledActionResponse> deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest) Deletes a scheduled action.
This is a convenience which creates an instance of the
DeleteScheduledActionRequest.Builder
avoiding the need to create one manually viaDeleteScheduledActionRequest.builder()
- Parameters:
deleteScheduledActionRequest
- AConsumer
that will call methods onDeleteScheduledActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteScheduledAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ScheduledActionNotFoundException The scheduled action cannot be found.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSnapshotCopyGrant
default CompletableFuture<DeleteSnapshotCopyGrantResponse> deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest) Deletes the specified snapshot copy grant.
- Parameters:
deleteSnapshotCopyGrantRequest
- The result of theDeleteSnapshotCopyGrant
action.- Returns:
- A Java Future containing the result of the DeleteSnapshotCopyGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidSnapshotCopyGrantStateException The snapshot copy grant can't be deleted because it is used by one or more clusters.
- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSnapshotCopyGrant
default CompletableFuture<DeleteSnapshotCopyGrantResponse> deleteSnapshotCopyGrant(Consumer<DeleteSnapshotCopyGrantRequest.Builder> deleteSnapshotCopyGrantRequest) Deletes the specified snapshot copy grant.
This is a convenience which creates an instance of the
DeleteSnapshotCopyGrantRequest.Builder
avoiding the need to create one manually viaDeleteSnapshotCopyGrantRequest.builder()
- Parameters:
deleteSnapshotCopyGrantRequest
- AConsumer
that will call methods onDeleteSnapshotCopyGrantRequest.Builder
to create a request. The result of theDeleteSnapshotCopyGrant
action.- Returns:
- A Java Future containing the result of the DeleteSnapshotCopyGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidSnapshotCopyGrantStateException The snapshot copy grant can't be deleted because it is used by one or more clusters.
- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSnapshotSchedule
default CompletableFuture<DeleteSnapshotScheduleResponse> deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest) Deletes a snapshot schedule.
- Parameters:
deleteSnapshotScheduleRequest
-- Returns:
- A Java Future containing the result of the DeleteSnapshotSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSnapshotScheduleStateException The cluster snapshot schedule state is not valid.
- SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSnapshotSchedule
default CompletableFuture<DeleteSnapshotScheduleResponse> deleteSnapshotSchedule(Consumer<DeleteSnapshotScheduleRequest.Builder> deleteSnapshotScheduleRequest) Deletes a snapshot schedule.
This is a convenience which creates an instance of the
DeleteSnapshotScheduleRequest.Builder
avoiding the need to create one manually viaDeleteSnapshotScheduleRequest.builder()
- Parameters:
deleteSnapshotScheduleRequest
- AConsumer
that will call methods onDeleteSnapshotScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSnapshotSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSnapshotScheduleStateException The cluster snapshot schedule state is not valid.
- SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTags
Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
- Parameters:
deleteTagsRequest
- Contains the output from theDeleteTags
action.- Returns:
- A Java Future containing the result of the DeleteTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTags
default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
This is a convenience which creates an instance of the
DeleteTagsRequest.Builder
avoiding the need to create one manually viaDeleteTagsRequest.builder()
- Parameters:
deleteTagsRequest
- AConsumer
that will call methods onDeleteTagsRequest.Builder
to create a request. Contains the output from theDeleteTags
action.- Returns:
- A Java Future containing the result of the DeleteTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUsageLimit
default CompletableFuture<DeleteUsageLimitResponse> deleteUsageLimit(DeleteUsageLimitRequest deleteUsageLimitRequest) Deletes a usage limit from a cluster.
- Parameters:
deleteUsageLimitRequest
-- Returns:
- A Java Future containing the result of the DeleteUsageLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UsageLimitNotFoundException The usage limit identifier can't be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUsageLimit
default CompletableFuture<DeleteUsageLimitResponse> deleteUsageLimit(Consumer<DeleteUsageLimitRequest.Builder> deleteUsageLimitRequest) Deletes a usage limit from a cluster.
This is a convenience which creates an instance of the
DeleteUsageLimitRequest.Builder
avoiding the need to create one manually viaDeleteUsageLimitRequest.builder()
- Parameters:
deleteUsageLimitRequest
- AConsumer
that will call methods onDeleteUsageLimitRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUsageLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UsageLimitNotFoundException The usage limit identifier can't be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributes
default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) Returns a list of attributes attached to an account
- Parameters:
describeAccountAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributes
default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Returns a list of attributes attached to an account
This is a convenience which creates an instance of the
DescribeAccountAttributesRequest.Builder
avoiding the need to create one manually viaDescribeAccountAttributesRequest.builder()
- Parameters:
describeAccountAttributesRequest
- AConsumer
that will call methods onDescribeAccountAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributes
Returns a list of attributes attached to an account
- Returns:
- A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAuthenticationProfiles
default CompletableFuture<DescribeAuthenticationProfilesResponse> describeAuthenticationProfiles(DescribeAuthenticationProfilesRequest describeAuthenticationProfilesRequest) Describes an authentication profile.
- Parameters:
describeAuthenticationProfilesRequest
-- Returns:
- A Java Future containing the result of the DescribeAuthenticationProfiles operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AuthenticationProfileNotFoundException The authentication profile can't be found.
- InvalidAuthenticationProfileRequestException The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAuthenticationProfiles
default CompletableFuture<DescribeAuthenticationProfilesResponse> describeAuthenticationProfiles(Consumer<DescribeAuthenticationProfilesRequest.Builder> describeAuthenticationProfilesRequest) Describes an authentication profile.
This is a convenience which creates an instance of the
DescribeAuthenticationProfilesRequest.Builder
avoiding the need to create one manually viaDescribeAuthenticationProfilesRequest.builder()
- Parameters:
describeAuthenticationProfilesRequest
- AConsumer
that will call methods onDescribeAuthenticationProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAuthenticationProfiles operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AuthenticationProfileNotFoundException The authentication profile can't be found.
- InvalidAuthenticationProfileRequestException The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterDbRevisions
default CompletableFuture<DescribeClusterDbRevisionsResponse> describeClusterDbRevisions(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) Returns an array of
ClusterDbRevision
objects.- Parameters:
describeClusterDbRevisionsRequest
-- Returns:
- A Java Future containing the result of the DescribeClusterDbRevisions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterDbRevisions
default CompletableFuture<DescribeClusterDbRevisionsResponse> describeClusterDbRevisions(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) Returns an array of
ClusterDbRevision
objects.
This is a convenience which creates an instance of the
DescribeClusterDbRevisionsRequest.Builder
avoiding the need to create one manually viaDescribeClusterDbRevisionsRequest.builder()
- Parameters:
describeClusterDbRevisionsRequest
- AConsumer
that will call methods onDescribeClusterDbRevisionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusterDbRevisions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterDbRevisions
Returns an array of
ClusterDbRevision
objects.- Returns:
- A Java Future containing the result of the DescribeClusterDbRevisions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterDbRevisionsPaginator
This is a variant of
describeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsPublisher publisher = client.describeClusterDbRevisionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsPublisher publisher = client.describeClusterDbRevisionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterDbRevisionsPaginator
default DescribeClusterDbRevisionsPublisher describeClusterDbRevisionsPaginator(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) This is a variant of
describeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsPublisher publisher = client.describeClusterDbRevisionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsPublisher publisher = client.describeClusterDbRevisionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation.- Parameters:
describeClusterDbRevisionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterDbRevisionsPaginator
default DescribeClusterDbRevisionsPublisher describeClusterDbRevisionsPaginator(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) This is a variant of
describeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsPublisher publisher = client.describeClusterDbRevisionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsPublisher publisher = client.describeClusterDbRevisionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeClusterDbRevisionsRequest.Builder
avoiding the need to create one manually viaDescribeClusterDbRevisionsRequest.builder()
- Parameters:
describeClusterDbRevisionsRequest
- AConsumer
that will call methods onDescribeClusterDbRevisionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterParameterGroups
default CompletableFuture<DescribeClusterParameterGroupsResponse> describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
- Parameters:
describeClusterParameterGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeClusterParameterGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterParameterGroups
default CompletableFuture<DescribeClusterParameterGroupsResponse> describeClusterParameterGroups(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
This is a convenience which creates an instance of the
DescribeClusterParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeClusterParameterGroupsRequest.builder()
- Parameters:
describeClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusterParameterGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterParameterGroups
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
andenvironment
for tag keys, andadmin
andtest
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.
- Returns:
- A Java Future containing the result of the DescribeClusterParameterGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterParameterGroupsPaginator
This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterParameterGroupsPaginator
default DescribeClusterParameterGroupsPublisher describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.- Parameters:
describeClusterParameterGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterParameterGroupsPaginator
default DescribeClusterParameterGroupsPublisher describeClusterParameterGroupsPaginator(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeClusterParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeClusterParameterGroupsRequest.builder()
- Parameters:
describeClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterParameters
default CompletableFuture<DescribeClusterParametersResponse> describeClusterParameters(DescribeClusterParametersRequest describeClusterParametersRequest) 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.
- Parameters:
describeClusterParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeClusterParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterParameters
default CompletableFuture<DescribeClusterParametersResponse> describeClusterParameters(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) 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.
This is a convenience which creates an instance of the
DescribeClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeClusterParametersRequest.builder()
- Parameters:
describeClusterParametersRequest
- AConsumer
that will call methods onDescribeClusterParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusterParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterParametersPaginator
default DescribeClusterParametersPublisher describeClusterParametersPaginator(DescribeClusterParametersRequest describeClusterParametersRequest) This is a variant of
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersPublisher publisher = client.describeClusterParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersPublisher publisher = client.describeClusterParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation.- Parameters:
describeClusterParametersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterParametersPaginator
default DescribeClusterParametersPublisher describeClusterParametersPaginator(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) This is a variant of
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersPublisher publisher = client.describeClusterParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersPublisher publisher = client.describeClusterParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeClusterParametersRequest.builder()
- Parameters:
describeClusterParametersRequest
- AConsumer
that will call methods onDescribeClusterParametersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSecurityGroups
default CompletableFuture<DescribeClusterSecurityGroupsResponse> describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
- Parameters:
describeClusterSecurityGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeClusterSecurityGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSecurityGroups
default CompletableFuture<DescribeClusterSecurityGroupsResponse> describeClusterSecurityGroups(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
This is a convenience which creates an instance of the
DescribeClusterSecurityGroupsRequest.Builder
avoiding the need to create one manually viaDescribeClusterSecurityGroupsRequest.builder()
- Parameters:
describeClusterSecurityGroupsRequest
- AConsumer
that will call methods onDescribeClusterSecurityGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusterSecurityGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSecurityGroupsPaginator
default DescribeClusterSecurityGroupsPublisher describeClusterSecurityGroupsPaginator(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) This is a variant of
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsPublisher publisher = client.describeClusterSecurityGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsPublisher publisher = client.describeClusterSecurityGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation.- Parameters:
describeClusterSecurityGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSecurityGroupsPaginator
default DescribeClusterSecurityGroupsPublisher describeClusterSecurityGroupsPaginator(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) This is a variant of
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsPublisher publisher = client.describeClusterSecurityGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsPublisher publisher = client.describeClusterSecurityGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeClusterSecurityGroupsRequest.Builder
avoiding the need to create one manually viaDescribeClusterSecurityGroupsRequest.builder()
- Parameters:
describeClusterSecurityGroupsRequest
- AConsumer
that will call methods onDescribeClusterSecurityGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSnapshots
default CompletableFuture<DescribeClusterSnapshotsResponse> describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
- Parameters:
describeClusterSnapshotsRequest
-- Returns:
- A Java Future containing the result of the DescribeClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidTagException The tag is invalid.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterSnapshots
default CompletableFuture<DescribeClusterSnapshotsResponse> describeClusterSnapshots(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
This is a convenience which creates an instance of the
DescribeClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeClusterSnapshotsRequest.builder()
- Parameters:
describeClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidTagException The tag is invalid.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterSnapshots
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
andenvironment
for tag keys, andadmin
andtest
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.
- Returns:
- A Java Future containing the result of the DescribeClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidTagException The tag is invalid.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterSnapshotsPaginator
This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidTagException The tag is invalid.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterSnapshotsPaginator
default DescribeClusterSnapshotsPublisher describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.- Parameters:
describeClusterSnapshotsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidTagException The tag is invalid.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterSnapshotsPaginator
default DescribeClusterSnapshotsPublisher describeClusterSnapshotsPaginator(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
DescribeClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeClusterSnapshotsRequest.builder()
- Parameters:
describeClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidTagException The tag is invalid.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusterSubnetGroups
default CompletableFuture<DescribeClusterSubnetGroupsResponse> describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
- Parameters:
describeClusterSubnetGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeClusterSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSubnetGroups
default CompletableFuture<DescribeClusterSubnetGroupsResponse> describeClusterSubnetGroups(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
This is a convenience which creates an instance of the
DescribeClusterSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeClusterSubnetGroupsRequest.builder()
- Parameters:
describeClusterSubnetGroupsRequest
- AConsumer
that will call methods onDescribeClusterSubnetGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusterSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSubnetGroups
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
andenvironment
for tag keys, andadmin
andtest
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.
- Returns:
- A Java Future containing the result of the DescribeClusterSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSubnetGroupsPaginator
This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSubnetGroupsPaginator
default DescribeClusterSubnetGroupsPublisher describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.- Parameters:
describeClusterSubnetGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterSubnetGroupsPaginator
default DescribeClusterSubnetGroupsPublisher describeClusterSubnetGroupsPaginator(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeClusterSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeClusterSubnetGroupsRequest.builder()
- Parameters:
describeClusterSubnetGroupsRequest
- AConsumer
that will call methods onDescribeClusterSubnetGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterTracks
default CompletableFuture<DescribeClusterTracksResponse> describeClusterTracks(DescribeClusterTracksRequest describeClusterTracksRequest) Returns a list of all the available maintenance tracks.
- Parameters:
describeClusterTracksRequest
-- Returns:
- A Java Future containing the result of the DescribeClusterTracks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterTrackException The provided cluster track name is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterTracks
default CompletableFuture<DescribeClusterTracksResponse> describeClusterTracks(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest) Returns a list of all the available maintenance tracks.
This is a convenience which creates an instance of the
DescribeClusterTracksRequest.Builder
avoiding the need to create one manually viaDescribeClusterTracksRequest.builder()
- Parameters:
describeClusterTracksRequest
- AConsumer
that will call methods onDescribeClusterTracksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusterTracks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterTrackException The provided cluster track name is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterTracks
Returns a list of all the available maintenance tracks.
- Returns:
- A Java Future containing the result of the DescribeClusterTracks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterTrackException The provided cluster track name is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterTracksPaginator
This is a variant of
describeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksPublisher publisher = client.describeClusterTracksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksPublisher publisher = client.describeClusterTracksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterTracksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterTrackException The provided cluster track name is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterTracksPaginator
default DescribeClusterTracksPublisher describeClusterTracksPaginator(DescribeClusterTracksRequest describeClusterTracksRequest) This is a variant of
describeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksPublisher publisher = client.describeClusterTracksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksPublisher publisher = client.describeClusterTracksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterTracksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation.- Parameters:
describeClusterTracksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterTrackException The provided cluster track name is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterTracksPaginator
default DescribeClusterTracksPublisher describeClusterTracksPaginator(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest) This is a variant of
describeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksPublisher publisher = client.describeClusterTracksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksPublisher publisher = client.describeClusterTracksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterTracksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation.
This is a convenience which creates an instance of the
DescribeClusterTracksRequest.Builder
avoiding the need to create one manually viaDescribeClusterTracksRequest.builder()
- Parameters:
describeClusterTracksRequest
- AConsumer
that will call methods onDescribeClusterTracksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterTrackException The provided cluster track name is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterVersions
default CompletableFuture<DescribeClusterVersionsResponse> describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest) 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.
- Parameters:
describeClusterVersionsRequest
-- Returns:
- A Java Future containing the result of the DescribeClusterVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterVersions
default CompletableFuture<DescribeClusterVersionsResponse> describeClusterVersions(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) 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.
This is a convenience which creates an instance of the
DescribeClusterVersionsRequest.Builder
avoiding the need to create one manually viaDescribeClusterVersionsRequest.builder()
- Parameters:
describeClusterVersionsRequest
- AConsumer
that will call methods onDescribeClusterVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusterVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterVersions
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.
- Returns:
- A Java Future containing the result of the DescribeClusterVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterVersionsPaginator
This is a variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterVersionsPaginator
default DescribeClusterVersionsPublisher describeClusterVersionsPaginator(DescribeClusterVersionsRequest describeClusterVersionsRequest) This is a variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.- Parameters:
describeClusterVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusterVersionsPaginator
default DescribeClusterVersionsPublisher describeClusterVersionsPaginator(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) This is a variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeClusterVersionsRequest.Builder
avoiding the need to create one manually viaDescribeClusterVersionsRequest.builder()
- Parameters:
describeClusterVersionsRequest
- AConsumer
that will call methods onDescribeClusterVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusters
default CompletableFuture<DescribeClustersResponse> describeClusters(DescribeClustersRequest describeClustersRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
- Parameters:
describeClustersRequest
-- Returns:
- A Java Future containing the result of the DescribeClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusters
default CompletableFuture<DescribeClustersResponse> describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClusters
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
andenvironment
for tag keys, andadmin
andtest
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.
- Returns:
- A Java Future containing the result of the DescribeClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClustersPaginator
This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClustersPaginator
default DescribeClustersPublisher describeClustersPaginator(DescribeClustersRequest describeClustersRequest) This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.- Parameters:
describeClustersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeClustersPaginator
default DescribeClustersPublisher describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeCustomDomainAssociations
default CompletableFuture<DescribeCustomDomainAssociationsResponse> describeCustomDomainAssociations(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) Contains information about custom domain associations for a cluster.
- Parameters:
describeCustomDomainAssociationsRequest
-- Returns:
- A Java Future containing the result of the DescribeCustomDomainAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDomainAssociationNotFoundException An error occurred. The custom domain name couldn't be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomDomainAssociations
default CompletableFuture<DescribeCustomDomainAssociationsResponse> describeCustomDomainAssociations(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest) Contains information about custom domain associations for a cluster.
This is a convenience which creates an instance of the
DescribeCustomDomainAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeCustomDomainAssociationsRequest.builder()
- Parameters:
describeCustomDomainAssociationsRequest
- AConsumer
that will call methods onDescribeCustomDomainAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCustomDomainAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDomainAssociationNotFoundException An error occurred. The custom domain name couldn't be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomDomainAssociationsPaginator
default DescribeCustomDomainAssociationsPublisher describeCustomDomainAssociationsPaginator(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) This is a variant of
describeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsPublisher publisher = client.describeCustomDomainAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsPublisher publisher = client.describeCustomDomainAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation.- Parameters:
describeCustomDomainAssociationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDomainAssociationNotFoundException An error occurred. The custom domain name couldn't be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomDomainAssociationsPaginator
default DescribeCustomDomainAssociationsPublisher describeCustomDomainAssociationsPaginator(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest) This is a variant of
describeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsPublisher publisher = client.describeCustomDomainAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsPublisher publisher = client.describeCustomDomainAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeCustomDomainAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeCustomDomainAssociationsRequest.builder()
- Parameters:
describeCustomDomainAssociationsRequest
- AConsumer
that will call methods onDescribeCustomDomainAssociationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDomainAssociationNotFoundException An error occurred. The custom domain name couldn't be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDefaultClusterParameters
default CompletableFuture<DescribeDefaultClusterParametersResponse> describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) 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.
- Parameters:
describeDefaultClusterParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeDefaultClusterParameters operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDefaultClusterParameters
default CompletableFuture<DescribeDefaultClusterParametersResponse> describeDefaultClusterParameters(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) 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.
This is a convenience which creates an instance of the
DescribeDefaultClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeDefaultClusterParametersRequest.builder()
- Parameters:
describeDefaultClusterParametersRequest
- AConsumer
that will call methods onDescribeDefaultClusterParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDefaultClusterParameters operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDefaultClusterParametersPaginator
default DescribeDefaultClusterParametersPublisher describeDefaultClusterParametersPaginator(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) This is a variant of
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersPublisher publisher = client.describeDefaultClusterParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersPublisher publisher = client.describeDefaultClusterParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation.- Parameters:
describeDefaultClusterParametersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDefaultClusterParametersPaginator
default DescribeDefaultClusterParametersPublisher describeDefaultClusterParametersPaginator(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) This is a variant of
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersPublisher publisher = client.describeDefaultClusterParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersPublisher publisher = client.describeDefaultClusterParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDefaultClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeDefaultClusterParametersRequest.builder()
- Parameters:
describeDefaultClusterParametersRequest
- AConsumer
that will call methods onDescribeDefaultClusterParametersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEndpointAccess
default CompletableFuture<DescribeEndpointAccessResponse> describeEndpointAccess(DescribeEndpointAccessRequest describeEndpointAccessRequest) Describes a Redshift-managed VPC endpoint.
- Parameters:
describeEndpointAccessRequest
-- Returns:
- A Java Future containing the result of the DescribeEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeEndpointAccess
default CompletableFuture<DescribeEndpointAccessResponse> describeEndpointAccess(Consumer<DescribeEndpointAccessRequest.Builder> describeEndpointAccessRequest) Describes a Redshift-managed VPC endpoint.
This is a convenience which creates an instance of the
DescribeEndpointAccessRequest.Builder
avoiding the need to create one manually viaDescribeEndpointAccessRequest.builder()
- Parameters:
describeEndpointAccessRequest
- AConsumer
that will call methods onDescribeEndpointAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeEndpointAccessPaginator
default DescribeEndpointAccessPublisher describeEndpointAccessPaginator(DescribeEndpointAccessRequest describeEndpointAccessRequest) This is a variant of
describeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessPublisher publisher = client.describeEndpointAccessPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessPublisher publisher = client.describeEndpointAccessPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation.- Parameters:
describeEndpointAccessRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeEndpointAccessPaginator
default DescribeEndpointAccessPublisher describeEndpointAccessPaginator(Consumer<DescribeEndpointAccessRequest.Builder> describeEndpointAccessRequest) This is a variant of
describeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessPublisher publisher = client.describeEndpointAccessPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessPublisher publisher = client.describeEndpointAccessPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation.
This is a convenience which creates an instance of the
DescribeEndpointAccessRequest.Builder
avoiding the need to create one manually viaDescribeEndpointAccessRequest.builder()
- Parameters:
describeEndpointAccessRequest
- AConsumer
that will call methods onDescribeEndpointAccessRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeEndpointAuthorization
default CompletableFuture<DescribeEndpointAuthorizationResponse> describeEndpointAuthorization(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) Describes an endpoint authorization.
- Parameters:
describeEndpointAuthorizationRequest
-- Returns:
- A Java Future containing the result of the DescribeEndpointAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeEndpointAuthorization
default CompletableFuture<DescribeEndpointAuthorizationResponse> describeEndpointAuthorization(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest) Describes an endpoint authorization.
This is a convenience which creates an instance of the
DescribeEndpointAuthorizationRequest.Builder
avoiding the need to create one manually viaDescribeEndpointAuthorizationRequest.builder()
- Parameters:
describeEndpointAuthorizationRequest
- AConsumer
that will call methods onDescribeEndpointAuthorizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEndpointAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeEndpointAuthorizationPaginator
default DescribeEndpointAuthorizationPublisher describeEndpointAuthorizationPaginator(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) This is a variant of
describeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationPublisher publisher = client.describeEndpointAuthorizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationPublisher publisher = client.describeEndpointAuthorizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation.- Parameters:
describeEndpointAuthorizationRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeEndpointAuthorizationPaginator
default DescribeEndpointAuthorizationPublisher describeEndpointAuthorizationPaginator(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest) This is a variant of
describeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationPublisher publisher = client.describeEndpointAuthorizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationPublisher publisher = client.describeEndpointAuthorizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation.
This is a convenience which creates an instance of the
DescribeEndpointAuthorizationRequest.Builder
avoiding the need to create one manually viaDescribeEndpointAuthorizationRequest.builder()
- Parameters:
describeEndpointAuthorizationRequest
- AConsumer
that will call methods onDescribeEndpointAuthorizationRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeEventCategories
default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) 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.
- Parameters:
describeEventCategoriesRequest
-- Returns:
- A Java Future containing the result of the DescribeEventCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventCategories
default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) 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.
This is a convenience which creates an instance of the
DescribeEventCategoriesRequest.Builder
avoiding the need to create one manually viaDescribeEventCategoriesRequest.builder()
- Parameters:
describeEventCategoriesRequest
- AConsumer
that will call methods onDescribeEventCategoriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEventCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventCategories
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.
- Returns:
- A Java Future containing the result of the DescribeEventCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptions
default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptions
default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptions
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
andenvironment
for tag keys, andadmin
andtest
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.
- Returns:
- A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptionsPaginator
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEvents
default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest) 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.
- Parameters:
describeEventsRequest
-- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEvents
default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) 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.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEvents
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.
- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventsPaginator
This is a variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventsPaginator
default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest) This is a variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.- Parameters:
describeEventsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventsPaginator
default DescribeEventsPublisher describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmClientCertificates
default CompletableFuture<DescribeHsmClientCertificatesResponse> describeHsmClientCertificates(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
- Parameters:
describeHsmClientCertificatesRequest
-- Returns:
- A Java Future containing the result of the DescribeHsmClientCertificates operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmClientCertificates
default CompletableFuture<DescribeHsmClientCertificatesResponse> describeHsmClientCertificates(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
This is a convenience which creates an instance of the
DescribeHsmClientCertificatesRequest.Builder
avoiding the need to create one manually viaDescribeHsmClientCertificatesRequest.builder()
- Parameters:
describeHsmClientCertificatesRequest
- AConsumer
that will call methods onDescribeHsmClientCertificatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeHsmClientCertificates operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmClientCertificates
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
andenvironment
for tag keys, andadmin
andtest
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.
- Returns:
- A Java Future containing the result of the DescribeHsmClientCertificates operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmClientCertificatesPaginator
This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmClientCertificatesPaginator
default DescribeHsmClientCertificatesPublisher describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.- Parameters:
describeHsmClientCertificatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmClientCertificatesPaginator
default DescribeHsmClientCertificatesPublisher describeHsmClientCertificatesPaginator(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.
This is a convenience which creates an instance of the
DescribeHsmClientCertificatesRequest.Builder
avoiding the need to create one manually viaDescribeHsmClientCertificatesRequest.builder()
- Parameters:
describeHsmClientCertificatesRequest
- AConsumer
that will call methods onDescribeHsmClientCertificatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmConfigurations
default CompletableFuture<DescribeHsmConfigurationsResponse> describeHsmConfigurations(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
- Parameters:
describeHsmConfigurationsRequest
-- Returns:
- A Java Future containing the result of the DescribeHsmConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmConfigurations
default CompletableFuture<DescribeHsmConfigurationsResponse> describeHsmConfigurations(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
This is a convenience which creates an instance of the
DescribeHsmConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeHsmConfigurationsRequest.builder()
- Parameters:
describeHsmConfigurationsRequest
- AConsumer
that will call methods onDescribeHsmConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeHsmConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmConfigurations
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
andenvironment
for tag keys, andadmin
andtest
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.
- Returns:
- A Java Future containing the result of the DescribeHsmConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmConfigurationsPaginator
This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmConfigurationsPaginator
default DescribeHsmConfigurationsPublisher describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.- Parameters:
describeHsmConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHsmConfigurationsPaginator
default DescribeHsmConfigurationsPublisher describeHsmConfigurationsPaginator(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeHsmConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeHsmConfigurationsRequest.builder()
- Parameters:
describeHsmConfigurationsRequest
- AConsumer
that will call methods onDescribeHsmConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInboundIntegrations
default CompletableFuture<DescribeInboundIntegrationsResponse> describeInboundIntegrations(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) Returns a list of inbound integrations.
- Parameters:
describeInboundIntegrationsRequest
-- Returns:
- A Java Future containing the result of the DescribeInboundIntegrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The integration can't be found.
- InvalidNamespaceException The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInboundIntegrations
default CompletableFuture<DescribeInboundIntegrationsResponse> describeInboundIntegrations(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest) Returns a list of inbound integrations.
This is a convenience which creates an instance of the
DescribeInboundIntegrationsRequest.Builder
avoiding the need to create one manually viaDescribeInboundIntegrationsRequest.builder()
- Parameters:
describeInboundIntegrationsRequest
- AConsumer
that will call methods onDescribeInboundIntegrationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeInboundIntegrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The integration can't be found.
- InvalidNamespaceException The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInboundIntegrationsPaginator
default DescribeInboundIntegrationsPublisher describeInboundIntegrationsPaginator(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) This is a variant of
describeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsPublisher publisher = client.describeInboundIntegrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsPublisher publisher = client.describeInboundIntegrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation.- Parameters:
describeInboundIntegrationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The integration can't be found.
- InvalidNamespaceException The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInboundIntegrationsPaginator
default DescribeInboundIntegrationsPublisher describeInboundIntegrationsPaginator(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest) This is a variant of
describeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsPublisher publisher = client.describeInboundIntegrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsPublisher publisher = client.describeInboundIntegrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeInboundIntegrationsRequest.Builder
avoiding the need to create one manually viaDescribeInboundIntegrationsRequest.builder()
- Parameters:
describeInboundIntegrationsRequest
- AConsumer
that will call methods onDescribeInboundIntegrationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The integration can't be found.
- InvalidNamespaceException The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoggingStatus
default CompletableFuture<DescribeLoggingStatusResponse> describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest) Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
- Parameters:
describeLoggingStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeLoggingStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeLoggingStatus
default CompletableFuture<DescribeLoggingStatusResponse> describeLoggingStatus(Consumer<DescribeLoggingStatusRequest.Builder> describeLoggingStatusRequest) Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
This is a convenience which creates an instance of the
DescribeLoggingStatusRequest.Builder
avoiding the need to create one manually viaDescribeLoggingStatusRequest.builder()
- Parameters:
describeLoggingStatusRequest
- AConsumer
that will call methods onDescribeLoggingStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeLoggingStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeNodeConfigurationOptions
default CompletableFuture<DescribeNodeConfigurationOptionsResponse> describeNodeConfigurationOptions(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest) Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
- Parameters:
describeNodeConfigurationOptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeNodeConfigurationOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - AccessToSnapshotDeniedException The owner of the specified snapshot has not authorized your account to access the snapshot.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeNodeConfigurationOptions
default CompletableFuture<DescribeNodeConfigurationOptionsResponse> describeNodeConfigurationOptions(Consumer<DescribeNodeConfigurationOptionsRequest.Builder> describeNodeConfigurationOptionsRequest) Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
This is a convenience which creates an instance of the
DescribeNodeConfigurationOptionsRequest.Builder
avoiding the need to create one manually viaDescribeNodeConfigurationOptionsRequest.builder()
- Parameters:
describeNodeConfigurationOptionsRequest
- AConsumer
that will call methods onDescribeNodeConfigurationOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeNodeConfigurationOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - AccessToSnapshotDeniedException The owner of the specified snapshot has not authorized your account to access the snapshot.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeNodeConfigurationOptionsPaginator
default DescribeNodeConfigurationOptionsPublisher describeNodeConfigurationOptionsPaginator(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest) This is a variant of
describeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsPublisher publisher = client.describeNodeConfigurationOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsPublisher publisher = client.describeNodeConfigurationOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation.- Parameters:
describeNodeConfigurationOptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - AccessToSnapshotDeniedException The owner of the specified snapshot has not authorized your account to access the snapshot.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeNodeConfigurationOptionsPaginator
default DescribeNodeConfigurationOptionsPublisher describeNodeConfigurationOptionsPaginator(Consumer<DescribeNodeConfigurationOptionsRequest.Builder> describeNodeConfigurationOptionsRequest) This is a variant of
describeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsPublisher publisher = client.describeNodeConfigurationOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsPublisher publisher = client.describeNodeConfigurationOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeNodeConfigurationOptionsRequest.Builder
avoiding the need to create one manually viaDescribeNodeConfigurationOptionsRequest.builder()
- Parameters:
describeNodeConfigurationOptionsRequest
- AConsumer
that will call methods onDescribeNodeConfigurationOptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - AccessToSnapshotDeniedException The owner of the specified snapshot has not authorized your account to access the snapshot.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableClusterOptions
default CompletableFuture<DescribeOrderableClusterOptionsResponse> describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) 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.
- Parameters:
describeOrderableClusterOptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeOrderableClusterOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableClusterOptions
default CompletableFuture<DescribeOrderableClusterOptionsResponse> describeOrderableClusterOptions(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) 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.
This is a convenience which creates an instance of the
DescribeOrderableClusterOptionsRequest.Builder
avoiding the need to create one manually viaDescribeOrderableClusterOptionsRequest.builder()
- Parameters:
describeOrderableClusterOptionsRequest
- AConsumer
that will call methods onDescribeOrderableClusterOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOrderableClusterOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableClusterOptions
default CompletableFuture<DescribeOrderableClusterOptionsResponse> describeOrderableClusterOptions()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.
- Returns:
- A Java Future containing the result of the DescribeOrderableClusterOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableClusterOptionsPaginator
This is a variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableClusterOptionsPaginator
default DescribeOrderableClusterOptionsPublisher describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) This is a variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.- Parameters:
describeOrderableClusterOptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableClusterOptionsPaginator
default DescribeOrderableClusterOptionsPublisher describeOrderableClusterOptionsPaginator(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) This is a variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeOrderableClusterOptionsRequest.Builder
avoiding the need to create one manually viaDescribeOrderableClusterOptionsRequest.builder()
- Parameters:
describeOrderableClusterOptionsRequest
- AConsumer
that will call methods onDescribeOrderableClusterOptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePartners
default CompletableFuture<DescribePartnersResponse> describePartners(DescribePartnersRequest describePartnersRequest) Returns information about the partner integrations defined for a cluster.
- Parameters:
describePartnersRequest
-- Returns:
- A Java Future containing the result of the DescribePartners operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnauthorizedPartnerIntegrationException The partner integration is not authorized.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describePartners
default CompletableFuture<DescribePartnersResponse> describePartners(Consumer<DescribePartnersRequest.Builder> describePartnersRequest) Returns information about the partner integrations defined for a cluster.
This is a convenience which creates an instance of the
DescribePartnersRequest.Builder
avoiding the need to create one manually viaDescribePartnersRequest.builder()
- Parameters:
describePartnersRequest
- AConsumer
that will call methods onDescribePartnersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePartners operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnauthorizedPartnerIntegrationException The partner integration is not authorized.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeRedshiftIdcApplications
default CompletableFuture<DescribeRedshiftIdcApplicationsResponse> describeRedshiftIdcApplications(DescribeRedshiftIdcApplicationsRequest describeRedshiftIdcApplicationsRequest) Lists the Amazon Redshift IAM Identity Center applications.
- Parameters:
describeRedshiftIdcApplicationsRequest
-- Returns:
- A Java Future containing the result of the DescribeRedshiftIdcApplications operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRedshiftIdcApplications
default CompletableFuture<DescribeRedshiftIdcApplicationsResponse> describeRedshiftIdcApplications(Consumer<DescribeRedshiftIdcApplicationsRequest.Builder> describeRedshiftIdcApplicationsRequest) Lists the Amazon Redshift IAM Identity Center applications.
This is a convenience which creates an instance of the
DescribeRedshiftIdcApplicationsRequest.Builder
avoiding the need to create one manually viaDescribeRedshiftIdcApplicationsRequest.builder()
- Parameters:
describeRedshiftIdcApplicationsRequest
- AConsumer
that will call methods onDescribeRedshiftIdcApplicationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRedshiftIdcApplications operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRedshiftIdcApplicationsPaginator
default DescribeRedshiftIdcApplicationsPublisher describeRedshiftIdcApplicationsPaginator(DescribeRedshiftIdcApplicationsRequest describeRedshiftIdcApplicationsRequest) This is a variant of
describeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsPublisher publisher = client.describeRedshiftIdcApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsPublisher publisher = client.describeRedshiftIdcApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation.- Parameters:
describeRedshiftIdcApplicationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRedshiftIdcApplicationsPaginator
default DescribeRedshiftIdcApplicationsPublisher describeRedshiftIdcApplicationsPaginator(Consumer<DescribeRedshiftIdcApplicationsRequest.Builder> describeRedshiftIdcApplicationsRequest) This is a variant of
describeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsPublisher publisher = client.describeRedshiftIdcApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsPublisher publisher = client.describeRedshiftIdcApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRedshiftIdcApplicationsRequest.Builder
avoiding the need to create one manually viaDescribeRedshiftIdcApplicationsRequest.builder()
- Parameters:
describeRedshiftIdcApplicationsRequest
- AConsumer
that will call methods onDescribeRedshiftIdcApplicationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeExchangeStatus
default CompletableFuture<DescribeReservedNodeExchangeStatusResponse> describeReservedNodeExchangeStatus(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest) Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.
- Parameters:
describeReservedNodeExchangeStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeReservedNodeExchangeStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- ReservedNodeExchangeNotFoundException The reserved-node exchange status wasn't found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeExchangeStatus
default CompletableFuture<DescribeReservedNodeExchangeStatusResponse> describeReservedNodeExchangeStatus(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest) Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.
This is a convenience which creates an instance of the
DescribeReservedNodeExchangeStatusRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodeExchangeStatusRequest.builder()
- Parameters:
describeReservedNodeExchangeStatusRequest
- AConsumer
that will call methods onDescribeReservedNodeExchangeStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeReservedNodeExchangeStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- ReservedNodeExchangeNotFoundException The reserved-node exchange status wasn't found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeExchangeStatusPaginator
default DescribeReservedNodeExchangeStatusPublisher describeReservedNodeExchangeStatusPaginator(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest) This is a variant of
describeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusPublisher publisher = client.describeReservedNodeExchangeStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusPublisher publisher = client.describeReservedNodeExchangeStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation.- Parameters:
describeReservedNodeExchangeStatusRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- ReservedNodeExchangeNotFoundException The reserved-node exchange status wasn't found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeExchangeStatusPaginator
default DescribeReservedNodeExchangeStatusPublisher describeReservedNodeExchangeStatusPaginator(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest) This is a variant of
describeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusPublisher publisher = client.describeReservedNodeExchangeStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusPublisher publisher = client.describeReservedNodeExchangeStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation.
This is a convenience which creates an instance of the
DescribeReservedNodeExchangeStatusRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodeExchangeStatusRequest.builder()
- Parameters:
describeReservedNodeExchangeStatusRequest
- AConsumer
that will call methods onDescribeReservedNodeExchangeStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- ReservedNodeExchangeNotFoundException The reserved-node exchange status wasn't found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeOfferings
default CompletableFuture<DescribeReservedNodeOfferingsResponse> describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) 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.
- Parameters:
describeReservedNodeOfferingsRequest
-- Returns:
- A Java Future containing the result of the DescribeReservedNodeOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeOfferings
default CompletableFuture<DescribeReservedNodeOfferingsResponse> describeReservedNodeOfferings(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) 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.
This is a convenience which creates an instance of the
DescribeReservedNodeOfferingsRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodeOfferingsRequest.builder()
- Parameters:
describeReservedNodeOfferingsRequest
- AConsumer
that will call methods onDescribeReservedNodeOfferingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeReservedNodeOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeOfferings
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.
- Returns:
- A Java Future containing the result of the DescribeReservedNodeOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeOfferingsPaginator
This is a variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeOfferingsPaginator
default DescribeReservedNodeOfferingsPublisher describeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) This is a variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.- Parameters:
describeReservedNodeOfferingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodeOfferingsPaginator
default DescribeReservedNodeOfferingsPublisher describeReservedNodeOfferingsPaginator(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) This is a variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.
This is a convenience which creates an instance of the
DescribeReservedNodeOfferingsRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodeOfferingsRequest.builder()
- Parameters:
describeReservedNodeOfferingsRequest
- AConsumer
that will call methods onDescribeReservedNodeOfferingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodes
default CompletableFuture<DescribeReservedNodesResponse> describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest) Returns the descriptions of the reserved nodes.
- Parameters:
describeReservedNodesRequest
-- Returns:
- A Java Future containing the result of the DescribeReservedNodes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodes
default CompletableFuture<DescribeReservedNodesResponse> describeReservedNodes(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) Returns the descriptions of the reserved nodes.
This is a convenience which creates an instance of the
DescribeReservedNodesRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodesRequest.builder()
- Parameters:
describeReservedNodesRequest
- AConsumer
that will call methods onDescribeReservedNodesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeReservedNodes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodes
Returns the descriptions of the reserved nodes.
- Returns:
- A Java Future containing the result of the DescribeReservedNodes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodesPaginator
This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodesPaginator
default DescribeReservedNodesPublisher describeReservedNodesPaginator(DescribeReservedNodesRequest describeReservedNodesRequest) This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.- Parameters:
describeReservedNodesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodesPaginator
default DescribeReservedNodesPublisher describeReservedNodesPaginator(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.
This is a convenience which creates an instance of the
DescribeReservedNodesRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodesRequest.builder()
- Parameters:
describeReservedNodesRequest
- AConsumer
that will call methods onDescribeReservedNodesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeResize
default CompletableFuture<DescribeResizeResponse> describeResize(DescribeResizeRequest describeResizeRequest) 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 asSUCCEEDED
until the next resize.A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
- Parameters:
describeResizeRequest
-- Returns:
- A Java Future containing the result of the DescribeResize operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ResizeNotFoundException A resize operation for the specified cluster is not found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeResize
default CompletableFuture<DescribeResizeResponse> describeResize(Consumer<DescribeResizeRequest.Builder> describeResizeRequest) 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 asSUCCEEDED
until the next resize.A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
This is a convenience which creates an instance of the
DescribeResizeRequest.Builder
avoiding the need to create one manually viaDescribeResizeRequest.builder()
- Parameters:
describeResizeRequest
- AConsumer
that will call methods onDescribeResizeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeResize operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ResizeNotFoundException A resize operation for the specified cluster is not found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeScheduledActions
default CompletableFuture<DescribeScheduledActionsResponse> describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest) Describes properties of scheduled actions.
- Parameters:
describeScheduledActionsRequest
-- Returns:
- A Java Future containing the result of the DescribeScheduledActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ScheduledActionNotFoundException The scheduled action cannot be found.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScheduledActions
default CompletableFuture<DescribeScheduledActionsResponse> describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) Describes properties of scheduled actions.
This is a convenience which creates an instance of the
DescribeScheduledActionsRequest.Builder
avoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()
- Parameters:
describeScheduledActionsRequest
- AConsumer
that will call methods onDescribeScheduledActionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeScheduledActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ScheduledActionNotFoundException The scheduled action cannot be found.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScheduledActionsPaginator
default DescribeScheduledActionsPublisher describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest) This is a variant of
describeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsPublisher publisher = client.describeScheduledActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsPublisher publisher = client.describeScheduledActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation.- Parameters:
describeScheduledActionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ScheduledActionNotFoundException The scheduled action cannot be found.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScheduledActionsPaginator
default DescribeScheduledActionsPublisher describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) This is a variant of
describeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsPublisher publisher = client.describeScheduledActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsPublisher publisher = client.describeScheduledActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeScheduledActionsRequest.Builder
avoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()
- Parameters:
describeScheduledActionsRequest
- AConsumer
that will call methods onDescribeScheduledActionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ScheduledActionNotFoundException The scheduled action cannot be found.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotCopyGrants
default CompletableFuture<DescribeSnapshotCopyGrantsResponse> describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) 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.
- Parameters:
describeSnapshotCopyGrantsRequest
- The result of theDescribeSnapshotCopyGrants
action.- Returns:
- A Java Future containing the result of the DescribeSnapshotCopyGrants operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotCopyGrants
default CompletableFuture<DescribeSnapshotCopyGrantsResponse> describeSnapshotCopyGrants(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) 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.
This is a convenience which creates an instance of the
DescribeSnapshotCopyGrantsRequest.Builder
avoiding the need to create one manually viaDescribeSnapshotCopyGrantsRequest.builder()
- Parameters:
describeSnapshotCopyGrantsRequest
- AConsumer
that will call methods onDescribeSnapshotCopyGrantsRequest.Builder
to create a request. The result of theDescribeSnapshotCopyGrants
action.- Returns:
- A Java Future containing the result of the DescribeSnapshotCopyGrants operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotCopyGrants
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.
- Returns:
- A Java Future containing the result of the DescribeSnapshotCopyGrants operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotCopyGrantsPaginator
This is a variant of
describeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsPublisher publisher = client.describeSnapshotCopyGrantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsPublisher publisher = client.describeSnapshotCopyGrantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotCopyGrantsPaginator
default DescribeSnapshotCopyGrantsPublisher describeSnapshotCopyGrantsPaginator(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) This is a variant of
describeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsPublisher publisher = client.describeSnapshotCopyGrantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsPublisher publisher = client.describeSnapshotCopyGrantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation.- Parameters:
describeSnapshotCopyGrantsRequest
- The result of theDescribeSnapshotCopyGrants
action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotCopyGrantsPaginator
default DescribeSnapshotCopyGrantsPublisher describeSnapshotCopyGrantsPaginator(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) This is a variant of
describeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsPublisher publisher = client.describeSnapshotCopyGrantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsPublisher publisher = client.describeSnapshotCopyGrantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation.
This is a convenience which creates an instance of the
DescribeSnapshotCopyGrantsRequest.Builder
avoiding the need to create one manually viaDescribeSnapshotCopyGrantsRequest.builder()
- Parameters:
describeSnapshotCopyGrantsRequest
- AConsumer
that will call methods onDescribeSnapshotCopyGrantsRequest.Builder
to create a request. The result of theDescribeSnapshotCopyGrants
action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotSchedules
default CompletableFuture<DescribeSnapshotSchedulesResponse> describeSnapshotSchedules(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) Returns a list of snapshot schedules.
- Parameters:
describeSnapshotSchedulesRequest
-- Returns:
- A Java Future containing the result of the DescribeSnapshotSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotSchedules
default CompletableFuture<DescribeSnapshotSchedulesResponse> describeSnapshotSchedules(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest) Returns a list of snapshot schedules.
This is a convenience which creates an instance of the
DescribeSnapshotSchedulesRequest.Builder
avoiding the need to create one manually viaDescribeSnapshotSchedulesRequest.builder()
- Parameters:
describeSnapshotSchedulesRequest
- AConsumer
that will call methods onDescribeSnapshotSchedulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSnapshotSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotSchedules
Returns a list of snapshot schedules.
- Returns:
- A Java Future containing the result of the DescribeSnapshotSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotSchedulesPaginator
This is a variant of
describeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesPublisher publisher = client.describeSnapshotSchedulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesPublisher publisher = client.describeSnapshotSchedulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotSchedulesPaginator
default DescribeSnapshotSchedulesPublisher describeSnapshotSchedulesPaginator(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) This is a variant of
describeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesPublisher publisher = client.describeSnapshotSchedulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesPublisher publisher = client.describeSnapshotSchedulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation.- Parameters:
describeSnapshotSchedulesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotSchedulesPaginator
default DescribeSnapshotSchedulesPublisher describeSnapshotSchedulesPaginator(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest) This is a variant of
describeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesPublisher publisher = client.describeSnapshotSchedulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesPublisher publisher = client.describeSnapshotSchedulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation.
This is a convenience which creates an instance of the
DescribeSnapshotSchedulesRequest.Builder
avoiding the need to create one manually viaDescribeSnapshotSchedulesRequest.builder()
- Parameters:
describeSnapshotSchedulesRequest
- AConsumer
that will call methods onDescribeSnapshotSchedulesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStorage
default CompletableFuture<DescribeStorageResponse> describeStorage(DescribeStorageRequest describeStorageRequest) Returns account level backups storage size and provisional storage.
- Parameters:
describeStorageRequest
-- Returns:
- A Java Future containing the result of the DescribeStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStorage
default CompletableFuture<DescribeStorageResponse> describeStorage(Consumer<DescribeStorageRequest.Builder> describeStorageRequest) Returns account level backups storage size and provisional storage.
This is a convenience which creates an instance of the
DescribeStorageRequest.Builder
avoiding the need to create one manually viaDescribeStorageRequest.builder()
- Parameters:
describeStorageRequest
- AConsumer
that will call methods onDescribeStorageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStorage
Returns account level backups storage size and provisional storage.
- Returns:
- A Java Future containing the result of the DescribeStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTableRestoreStatus
default CompletableFuture<DescribeTableRestoreStatusResponse> describeTableRestoreStatus(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) 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, thenDescribeTableRestoreStatus
returns the status of all table restore requests ordered by the date and time of the request in ascending order. OtherwiseDescribeTableRestoreStatus
returns the status of the table specified byTableRestoreRequestId
.- Parameters:
describeTableRestoreStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeTableRestoreStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TableRestoreNotFoundException The specified
TableRestoreRequestId
value was not found. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableRestoreNotFoundException The specified
- See Also:
-
describeTableRestoreStatus
default CompletableFuture<DescribeTableRestoreStatusResponse> describeTableRestoreStatus(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) 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, thenDescribeTableRestoreStatus
returns the status of all table restore requests ordered by the date and time of the request in ascending order. OtherwiseDescribeTableRestoreStatus
returns the status of the table specified byTableRestoreRequestId
.
This is a convenience which creates an instance of the
DescribeTableRestoreStatusRequest.Builder
avoiding the need to create one manually viaDescribeTableRestoreStatusRequest.builder()
- Parameters:
describeTableRestoreStatusRequest
- AConsumer
that will call methods onDescribeTableRestoreStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTableRestoreStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TableRestoreNotFoundException The specified
TableRestoreRequestId
value was not found. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableRestoreNotFoundException The specified
- See Also:
-
describeTableRestoreStatusPaginator
default DescribeTableRestoreStatusPublisher describeTableRestoreStatusPaginator(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) This is a variant of
describeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusPublisher publisher = client.describeTableRestoreStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusPublisher publisher = client.describeTableRestoreStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation.- Parameters:
describeTableRestoreStatusRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TableRestoreNotFoundException The specified
TableRestoreRequestId
value was not found. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableRestoreNotFoundException The specified
- See Also:
-
describeTableRestoreStatusPaginator
default DescribeTableRestoreStatusPublisher describeTableRestoreStatusPaginator(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) This is a variant of
describeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusPublisher publisher = client.describeTableRestoreStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusPublisher publisher = client.describeTableRestoreStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation.
This is a convenience which creates an instance of the
DescribeTableRestoreStatusRequest.Builder
avoiding the need to create one manually viaDescribeTableRestoreStatusRequest.builder()
- Parameters:
describeTableRestoreStatusRequest
- AConsumer
that will call methods onDescribeTableRestoreStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TableRestoreNotFoundException The specified
TableRestoreRequestId
value was not found. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableRestoreNotFoundException The specified
- See Also:
-
describeTags
default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
- Parameters:
describeTagsRequest
-- Returns:
- A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeTags
default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) 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
andenvironment
for tag keys, andadmin
andtest
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.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builder
avoiding the need to create one manually viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeTags
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
andenvironment
for tag keys, andadmin
andtest
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.
- Returns:
- A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeTagsPaginator
This is a variant of
describeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeTagsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTagsPaginator
This is a variant of
describeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeTagsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation.- Parameters:
describeTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTagsPaginator
default DescribeTagsPublisher describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) This is a variant of
describeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeTagsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builder
avoiding the need to create one manually viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidTagException The tag is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUsageLimits
default CompletableFuture<DescribeUsageLimitsResponse> describeUsageLimits(DescribeUsageLimitsRequest describeUsageLimitsRequest) 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.
- Parameters:
describeUsageLimitsRequest
-- Returns:
- A Java Future containing the result of the DescribeUsageLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
-
describeUsageLimits
default CompletableFuture<DescribeUsageLimitsResponse> describeUsageLimits(Consumer<DescribeUsageLimitsRequest.Builder> describeUsageLimitsRequest) 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.
This is a convenience which creates an instance of the
DescribeUsageLimitsRequest.Builder
avoiding the need to create one manually viaDescribeUsageLimitsRequest.builder()
- Parameters:
describeUsageLimitsRequest
- AConsumer
that will call methods onDescribeUsageLimitsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUsageLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
-
describeUsageLimitsPaginator
default DescribeUsageLimitsPublisher describeUsageLimitsPaginator(DescribeUsageLimitsRequest describeUsageLimitsRequest) This is a variant of
describeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsPublisher publisher = client.describeUsageLimitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsPublisher publisher = client.describeUsageLimitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation.- Parameters:
describeUsageLimitsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
describeUsageLimitsPaginator
default DescribeUsageLimitsPublisher describeUsageLimitsPaginator(Consumer<DescribeUsageLimitsRequest.Builder> describeUsageLimitsRequest) This is a variant of
describeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsPublisher publisher = client.describeUsageLimitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsPublisher publisher = client.describeUsageLimitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation.
This is a convenience which creates an instance of the
DescribeUsageLimitsRequest.Builder
avoiding the need to create one manually viaDescribeUsageLimitsRequest.builder()
- Parameters:
describeUsageLimitsRequest
- AConsumer
that will call methods onDescribeUsageLimitsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
disableLogging
default CompletableFuture<DisableLoggingResponse> disableLogging(DisableLoggingRequest disableLoggingRequest) Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
- Parameters:
disableLoggingRequest
-- Returns:
- A Java Future containing the result of the DisableLogging operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
disableLogging
default CompletableFuture<DisableLoggingResponse> disableLogging(Consumer<DisableLoggingRequest.Builder> disableLoggingRequest) Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
This is a convenience which creates an instance of the
DisableLoggingRequest.Builder
avoiding the need to create one manually viaDisableLoggingRequest.builder()
- Parameters:
disableLoggingRequest
- AConsumer
that will call methods onDisableLoggingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableLogging operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
disableSnapshotCopy
default CompletableFuture<DisableSnapshotCopyResponse> disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest) 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.
- Parameters:
disableSnapshotCopyRequest
-- Returns:
- A Java Future containing the result of the DisableSnapshotCopy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SnapshotCopyAlreadyDisabledException The cluster already has cross-region snapshot copy disabled.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
disableSnapshotCopy
default CompletableFuture<DisableSnapshotCopyResponse> disableSnapshotCopy(Consumer<DisableSnapshotCopyRequest.Builder> disableSnapshotCopyRequest) 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.
This is a convenience which creates an instance of the
DisableSnapshotCopyRequest.Builder
avoiding the need to create one manually viaDisableSnapshotCopyRequest.builder()
- Parameters:
disableSnapshotCopyRequest
- AConsumer
that will call methods onDisableSnapshotCopyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableSnapshotCopy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SnapshotCopyAlreadyDisabledException The cluster already has cross-region snapshot copy disabled.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
enableLogging
default CompletableFuture<EnableLoggingResponse> enableLogging(EnableLoggingRequest enableLoggingRequest) Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
- Parameters:
enableLoggingRequest
-- Returns:
- A Java Future containing the result of the EnableLogging operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - BucketNotFoundException Could not find the specified S3 bucket.
- InsufficientS3BucketPolicyException The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.
- InvalidS3KeyPrefixException The string specified for the logging S3 key prefix does not comply with the documented constraints.
- InvalidS3BucketNameException The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
enableLogging
default CompletableFuture<EnableLoggingResponse> enableLogging(Consumer<EnableLoggingRequest.Builder> enableLoggingRequest) Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
This is a convenience which creates an instance of the
EnableLoggingRequest.Builder
avoiding the need to create one manually viaEnableLoggingRequest.builder()
- Parameters:
enableLoggingRequest
- AConsumer
that will call methods onEnableLoggingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableLogging operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - BucketNotFoundException Could not find the specified S3 bucket.
- InsufficientS3BucketPolicyException The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.
- InvalidS3KeyPrefixException The string specified for the logging S3 key prefix does not comply with the documented constraints.
- InvalidS3BucketNameException The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
enableSnapshotCopy
default CompletableFuture<EnableSnapshotCopyResponse> enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest) Enables the automatic copy of snapshots from one region to another region for a specified cluster.
- Parameters:
enableSnapshotCopyRequest
-- Returns:
- A Java Future containing the result of the EnableSnapshotCopy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IncompatibleOrderableOptionsException The specified options are incompatible.
- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - CopyToRegionDisabledException Cross-region snapshot copy was temporarily disabled. Try your request again.
- SnapshotCopyAlreadyEnabledException The cluster already has cross-region snapshot copy enabled.
- UnknownSnapshotCopyRegionException The specified region is incorrect or does not exist.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableSnapshotCopy
default CompletableFuture<EnableSnapshotCopyResponse> enableSnapshotCopy(Consumer<EnableSnapshotCopyRequest.Builder> enableSnapshotCopyRequest) Enables the automatic copy of snapshots from one region to another region for a specified cluster.
This is a convenience which creates an instance of the
EnableSnapshotCopyRequest.Builder
avoiding the need to create one manually viaEnableSnapshotCopyRequest.builder()
- Parameters:
enableSnapshotCopyRequest
- AConsumer
that will call methods onEnableSnapshotCopyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableSnapshotCopy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IncompatibleOrderableOptionsException The specified options are incompatible.
- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - CopyToRegionDisabledException Cross-region snapshot copy was temporarily disabled. Try your request again.
- SnapshotCopyAlreadyEnabledException The cluster already has cross-region snapshot copy enabled.
- UnknownSnapshotCopyRegionException The specified region is incorrect or does not exist.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
failoverPrimaryCompute
default CompletableFuture<FailoverPrimaryComputeResponse> failoverPrimaryCompute(FailoverPrimaryComputeRequest failoverPrimaryComputeRequest) Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
- Parameters:
failoverPrimaryComputeRequest
-- Returns:
- A Java Future containing the result of the FailoverPrimaryCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
failoverPrimaryCompute
default CompletableFuture<FailoverPrimaryComputeResponse> failoverPrimaryCompute(Consumer<FailoverPrimaryComputeRequest.Builder> failoverPrimaryComputeRequest) Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
This is a convenience which creates an instance of the
FailoverPrimaryComputeRequest.Builder
avoiding the need to create one manually viaFailoverPrimaryComputeRequest.builder()
- Parameters:
failoverPrimaryComputeRequest
- AConsumer
that will call methods onFailoverPrimaryComputeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the FailoverPrimaryCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
getClusterCredentials
default CompletableFuture<GetClusterCredentialsResponse> getClusterCredentials(GetClusterCredentialsRequest getClusterCredentialsRequest) 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:
ifAutoCreate
isFalse
orIAMA:
ifAutoCreate
isTrue
. 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 theredshift:JoinGroup
action with access to the listeddbgroups
.In addition, if the
AutoCreate
parameter is set toTrue
, then the policy must include theredshift:CreateClusterUser
permission.If the
DbName
parameter is specified, the IAM policy must allow access to the resourcedbname
for the specified database name.- Parameters:
getClusterCredentialsRequest
- The request parameters to get cluster credentials.- Returns:
- A Java Future containing the result of the GetClusterCredentials operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
getClusterCredentials
default CompletableFuture<GetClusterCredentialsResponse> getClusterCredentials(Consumer<GetClusterCredentialsRequest.Builder> getClusterCredentialsRequest) 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:
ifAutoCreate
isFalse
orIAMA:
ifAutoCreate
isTrue
. 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 theredshift:JoinGroup
action with access to the listeddbgroups
.In addition, if the
AutoCreate
parameter is set toTrue
, then the policy must include theredshift:CreateClusterUser
permission.If the
DbName
parameter is specified, the IAM policy must allow access to the resourcedbname
for the specified database name.
This is a convenience which creates an instance of the
GetClusterCredentialsRequest.Builder
avoiding the need to create one manually viaGetClusterCredentialsRequest.builder()
- Parameters:
getClusterCredentialsRequest
- AConsumer
that will call methods onGetClusterCredentialsRequest.Builder
to create a request. The request parameters to get cluster credentials.- Returns:
- A Java Future containing the result of the GetClusterCredentials operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
getClusterCredentialsWithIAM
default CompletableFuture<GetClusterCredentialsWithIamResponse> getClusterCredentialsWithIAM(GetClusterCredentialsWithIamRequest getClusterCredentialsWithIamRequest) 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.
- Parameters:
getClusterCredentialsWithIamRequest
-- Returns:
- A Java Future containing the result of the GetClusterCredentialsWithIAM operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
getClusterCredentialsWithIAM
default CompletableFuture<GetClusterCredentialsWithIamResponse> getClusterCredentialsWithIAM(Consumer<GetClusterCredentialsWithIamRequest.Builder> getClusterCredentialsWithIamRequest) 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.
This is a convenience which creates an instance of the
GetClusterCredentialsWithIamRequest.Builder
avoiding the need to create one manually viaGetClusterCredentialsWithIamRequest.builder()
- Parameters:
getClusterCredentialsWithIamRequest
- AConsumer
that will call methods onGetClusterCredentialsWithIamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetClusterCredentialsWithIAM operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
getReservedNodeExchangeConfigurationOptions
default CompletableFuture<GetReservedNodeExchangeConfigurationOptionsResponse> getReservedNodeExchangeConfigurationOptions(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest) 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.
- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest
-- Returns:
- A Java Future containing the result of the GetReservedNodeExchangeConfigurationOptions operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReservedNodeExchangeConfigurationOptions
default CompletableFuture<GetReservedNodeExchangeConfigurationOptionsResponse> getReservedNodeExchangeConfigurationOptions(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest) 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.
This is a convenience which creates an instance of the
GetReservedNodeExchangeConfigurationOptionsRequest.Builder
avoiding the need to create one manually viaGetReservedNodeExchangeConfigurationOptionsRequest.builder()
- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest
- AConsumer
that will call methods onGetReservedNodeExchangeConfigurationOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetReservedNodeExchangeConfigurationOptions operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReservedNodeExchangeConfigurationOptionsPaginator
default GetReservedNodeExchangeConfigurationOptionsPublisher getReservedNodeExchangeConfigurationOptionsPaginator(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest) This is a variant of
getReservedNodeExchangeConfigurationOptions(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsPublisher publisher = client.getReservedNodeExchangeConfigurationOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsPublisher publisher = client.getReservedNodeExchangeConfigurationOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getReservedNodeExchangeConfigurationOptions(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsRequest)
operation.- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReservedNodeExchangeConfigurationOptionsPaginator
default GetReservedNodeExchangeConfigurationOptionsPublisher getReservedNodeExchangeConfigurationOptionsPaginator(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest) This is a variant of
getReservedNodeExchangeConfigurationOptions(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsPublisher publisher = client.getReservedNodeExchangeConfigurationOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsPublisher publisher = client.getReservedNodeExchangeConfigurationOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getReservedNodeExchangeConfigurationOptions(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsRequest)
operation.
This is a convenience which creates an instance of the
GetReservedNodeExchangeConfigurationOptionsRequest.Builder
avoiding the need to create one manually viaGetReservedNodeExchangeConfigurationOptionsRequest.builder()
- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest
- AConsumer
that will call methods onGetReservedNodeExchangeConfigurationOptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReservedNodeExchangeOfferings
default CompletableFuture<GetReservedNodeExchangeOfferingsResponse> getReservedNodeExchangeOfferings(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest) Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
- Parameters:
getReservedNodeExchangeOfferingsRequest
-- Returns:
- A Java Future containing the result of the GetReservedNodeExchangeOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReservedNodeExchangeOfferings
default CompletableFuture<GetReservedNodeExchangeOfferingsResponse> getReservedNodeExchangeOfferings(Consumer<GetReservedNodeExchangeOfferingsRequest.Builder> getReservedNodeExchangeOfferingsRequest) Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
This is a convenience which creates an instance of the
GetReservedNodeExchangeOfferingsRequest.Builder
avoiding the need to create one manually viaGetReservedNodeExchangeOfferingsRequest.builder()
- Parameters:
getReservedNodeExchangeOfferingsRequest
- AConsumer
that will call methods onGetReservedNodeExchangeOfferingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetReservedNodeExchangeOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReservedNodeExchangeOfferingsPaginator
default GetReservedNodeExchangeOfferingsPublisher getReservedNodeExchangeOfferingsPaginator(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest) This is a variant of
getReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsPublisher publisher = client.getReservedNodeExchangeOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsPublisher publisher = client.getReservedNodeExchangeOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation.- Parameters:
getReservedNodeExchangeOfferingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReservedNodeExchangeOfferingsPaginator
default GetReservedNodeExchangeOfferingsPublisher getReservedNodeExchangeOfferingsPaginator(Consumer<GetReservedNodeExchangeOfferingsRequest.Builder> getReservedNodeExchangeOfferingsRequest) This is a variant of
getReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsPublisher publisher = client.getReservedNodeExchangeOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsPublisher publisher = client.getReservedNodeExchangeOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation.
This is a convenience which creates an instance of the
GetReservedNodeExchangeOfferingsRequest.Builder
avoiding the need to create one manually viaGetReservedNodeExchangeOfferingsRequest.builder()
- Parameters:
getReservedNodeExchangeOfferingsRequest
- AConsumer
that will call methods onGetReservedNodeExchangeOfferingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) Get the resource policy for a specified resource.
- Parameters:
getResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidPolicyException The resource policy isn't valid.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Get the resource policy for a specified resource.
This is a convenience which creates an instance of the
GetResourcePolicyRequest.Builder
avoiding the need to create one manually viaGetResourcePolicyRequest.builder()
- Parameters:
getResourcePolicyRequest
- AConsumer
that will call methods onGetResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidPolicyException The resource policy isn't valid.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRecommendations
default CompletableFuture<ListRecommendationsResponse> listRecommendations(ListRecommendationsRequest listRecommendationsRequest) List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.
- Parameters:
listRecommendationsRequest
-- Returns:
- A Java Future containing the result of the ListRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
listRecommendations
default CompletableFuture<ListRecommendationsResponse> listRecommendations(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest) List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.
This is a convenience which creates an instance of the
ListRecommendationsRequest.Builder
avoiding the need to create one manually viaListRecommendationsRequest.builder()
- Parameters:
listRecommendationsRequest
- AConsumer
that will call methods onListRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
listRecommendationsPaginator
default ListRecommendationsPublisher listRecommendationsPaginator(ListRecommendationsRequest listRecommendationsRequest) This is a variant of
listRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.ListRecommendationsPublisher publisher = client.listRecommendationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.ListRecommendationsPublisher publisher = client.listRecommendationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.ListRecommendationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.ListRecommendationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation.- Parameters:
listRecommendationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
listRecommendationsPaginator
default ListRecommendationsPublisher listRecommendationsPaginator(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest) This is a variant of
listRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.redshift.paginators.ListRecommendationsPublisher publisher = client.listRecommendationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.redshift.paginators.ListRecommendationsPublisher publisher = client.listRecommendationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.ListRecommendationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.redshift.model.ListRecommendationsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation.
This is a convenience which creates an instance of the
ListRecommendationsRequest.Builder
avoiding the need to create one manually viaListRecommendationsRequest.builder()
- Parameters:
listRecommendationsRequest
- AConsumer
that will call methods onListRecommendationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyAquaConfiguration
default CompletableFuture<ModifyAquaConfigurationResponse> modifyAquaConfiguration(ModifyAquaConfigurationRequest modifyAquaConfigurationRequest) This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
- Parameters:
modifyAquaConfigurationRequest
-- Returns:
- A Java Future containing the result of the ModifyAquaConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyAquaConfiguration
default CompletableFuture<ModifyAquaConfigurationResponse> modifyAquaConfiguration(Consumer<ModifyAquaConfigurationRequest.Builder> modifyAquaConfigurationRequest) This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
This is a convenience which creates an instance of the
ModifyAquaConfigurationRequest.Builder
avoiding the need to create one manually viaModifyAquaConfigurationRequest.builder()
- Parameters:
modifyAquaConfigurationRequest
- AConsumer
that will call methods onModifyAquaConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyAquaConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyAuthenticationProfile
default CompletableFuture<ModifyAuthenticationProfileResponse> modifyAuthenticationProfile(ModifyAuthenticationProfileRequest modifyAuthenticationProfileRequest) Modifies an authentication profile.
- Parameters:
modifyAuthenticationProfileRequest
-- Returns:
- A Java Future containing the result of the ModifyAuthenticationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AuthenticationProfileNotFoundException The authentication profile can't be found.
- AuthenticationProfileQuotaExceededException The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.
- InvalidAuthenticationProfileRequestException The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyAuthenticationProfile
default CompletableFuture<ModifyAuthenticationProfileResponse> modifyAuthenticationProfile(Consumer<ModifyAuthenticationProfileRequest.Builder> modifyAuthenticationProfileRequest) Modifies an authentication profile.
This is a convenience which creates an instance of the
ModifyAuthenticationProfileRequest.Builder
avoiding the need to create one manually viaModifyAuthenticationProfileRequest.builder()
- Parameters:
modifyAuthenticationProfileRequest
- AConsumer
that will call methods onModifyAuthenticationProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyAuthenticationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AuthenticationProfileNotFoundException The authentication profile can't be found.
- AuthenticationProfileQuotaExceededException The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.
- InvalidAuthenticationProfileRequestException The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyCluster
default CompletableFuture<ModifyClusterResponse> modifyCluster(ModifyClusterRequest modifyClusterRequest) 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.
- Parameters:
modifyClusterRequest
-- Returns:
- A Java Future containing the result of the ModifyCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterStateException The specified cluster is not in the
available
state. - InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- UnsupportedOptionException A request option was specified that is not supported.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- ClusterAlreadyExistsException The account already has a cluster with the given identifier.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidElasticIpException The Elastic IP (EIP) is invalid or cannot be found.
- TableLimitExceededException The number of tables in the cluster exceeds the limit for the requested new cluster node type.
- InvalidClusterTrackException The provided cluster track name is not valid.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- UnsupportedOperationException The requested operation isn't supported.
- CustomCnameAssociationException An error occurred when an attempt was made to change the custom domain association.
- Ipv6CidrBlockNotFoundException There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterStateException The specified cluster is not in the
- See Also:
-
modifyCluster
default CompletableFuture<ModifyClusterResponse> modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest) 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.
This is a convenience which creates an instance of the
ModifyClusterRequest.Builder
avoiding the need to create one manually viaModifyClusterRequest.builder()
- Parameters:
modifyClusterRequest
- AConsumer
that will call methods onModifyClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterStateException The specified cluster is not in the
available
state. - InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- UnsupportedOptionException A request option was specified that is not supported.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- ClusterAlreadyExistsException The account already has a cluster with the given identifier.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidElasticIpException The Elastic IP (EIP) is invalid or cannot be found.
- TableLimitExceededException The number of tables in the cluster exceeds the limit for the requested new cluster node type.
- InvalidClusterTrackException The provided cluster track name is not valid.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- UnsupportedOperationException The requested operation isn't supported.
- CustomCnameAssociationException An error occurred when an attempt was made to change the custom domain association.
- Ipv6CidrBlockNotFoundException There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterStateException The specified cluster is not in the
- See Also:
-
modifyClusterDbRevision
default CompletableFuture<ModifyClusterDbRevisionResponse> modifyClusterDbRevision(ModifyClusterDbRevisionRequest modifyClusterDbRevisionRequest) Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
- Parameters:
modifyClusterDbRevisionRequest
-- Returns:
- A Java Future containing the result of the ModifyClusterDbRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterOnLatestRevisionException Cluster is already on the latest database revision.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyClusterDbRevision
default CompletableFuture<ModifyClusterDbRevisionResponse> modifyClusterDbRevision(Consumer<ModifyClusterDbRevisionRequest.Builder> modifyClusterDbRevisionRequest) Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
This is a convenience which creates an instance of the
ModifyClusterDbRevisionRequest.Builder
avoiding the need to create one manually viaModifyClusterDbRevisionRequest.builder()
- Parameters:
modifyClusterDbRevisionRequest
- AConsumer
that will call methods onModifyClusterDbRevisionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyClusterDbRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ClusterOnLatestRevisionException Cluster is already on the latest database revision.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyClusterIamRoles
default CompletableFuture<ModifyClusterIamRolesResponse> modifyClusterIamRoles(ModifyClusterIamRolesRequest modifyClusterIamRolesRequest) 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.
- Parameters:
modifyClusterIamRolesRequest
-- Returns:
- A Java Future containing the result of the ModifyClusterIamRoles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterStateException The specified cluster is not in the
- See Also:
-
modifyClusterIamRoles
default CompletableFuture<ModifyClusterIamRolesResponse> modifyClusterIamRoles(Consumer<ModifyClusterIamRolesRequest.Builder> modifyClusterIamRolesRequest) 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.
This is a convenience which creates an instance of the
ModifyClusterIamRolesRequest.Builder
avoiding the need to create one manually viaModifyClusterIamRolesRequest.builder()
- Parameters:
modifyClusterIamRolesRequest
- AConsumer
that will call methods onModifyClusterIamRolesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyClusterIamRoles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterStateException The specified cluster is not in the
- See Also:
-
modifyClusterMaintenance
default CompletableFuture<ModifyClusterMaintenanceResponse> modifyClusterMaintenance(ModifyClusterMaintenanceRequest modifyClusterMaintenanceRequest) Modifies the maintenance settings of a cluster.
- Parameters:
modifyClusterMaintenanceRequest
-- Returns:
- A Java Future containing the result of the ModifyClusterMaintenance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyClusterMaintenance
default CompletableFuture<ModifyClusterMaintenanceResponse> modifyClusterMaintenance(Consumer<ModifyClusterMaintenanceRequest.Builder> modifyClusterMaintenanceRequest) Modifies the maintenance settings of a cluster.
This is a convenience which creates an instance of the
ModifyClusterMaintenanceRequest.Builder
avoiding the need to create one manually viaModifyClusterMaintenanceRequest.builder()
- Parameters:
modifyClusterMaintenanceRequest
- AConsumer
that will call methods onModifyClusterMaintenanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyClusterMaintenance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyClusterParameterGroup
default CompletableFuture<ModifyClusterParameterGroupResponse> modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest) 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.
- Parameters:
modifyClusterParameterGroupRequest
- Describes a modify cluster parameter group operation.- Returns:
- A Java Future containing the result of the ModifyClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InvalidClusterParameterGroupStateException The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyClusterParameterGroup
default CompletableFuture<ModifyClusterParameterGroupResponse> modifyClusterParameterGroup(Consumer<ModifyClusterParameterGroupRequest.Builder> modifyClusterParameterGroupRequest) 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.
This is a convenience which creates an instance of the
ModifyClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaModifyClusterParameterGroupRequest.builder()
- Parameters:
modifyClusterParameterGroupRequest
- AConsumer
that will call methods onModifyClusterParameterGroupRequest.Builder
to create a request. Describes a modify cluster parameter group operation.- Returns:
- A Java Future containing the result of the ModifyClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- InvalidClusterParameterGroupStateException The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyClusterSnapshot
default CompletableFuture<ModifyClusterSnapshotResponse> modifyClusterSnapshot(ModifyClusterSnapshotRequest modifyClusterSnapshotRequest) Modifies the settings for a snapshot.
This exanmple modifies the manual retention period setting for a cluster snapshot.
- Parameters:
modifyClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the ModifyClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
- See Also:
-
modifyClusterSnapshot
default CompletableFuture<ModifyClusterSnapshotResponse> modifyClusterSnapshot(Consumer<ModifyClusterSnapshotRequest.Builder> modifyClusterSnapshotRequest) Modifies the settings for a snapshot.
This exanmple modifies the manual retention period setting for a cluster snapshot.
This is a convenience which creates an instance of the
ModifyClusterSnapshotRequest.Builder
avoiding the need to create one manually viaModifyClusterSnapshotRequest.builder()
- Parameters:
modifyClusterSnapshotRequest
- AConsumer
that will call methods onModifyClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
- See Also:
-
modifyClusterSnapshotSchedule
default CompletableFuture<ModifyClusterSnapshotScheduleResponse> modifyClusterSnapshotSchedule(ModifyClusterSnapshotScheduleRequest modifyClusterSnapshotScheduleRequest) Modifies a snapshot schedule for a cluster.
- Parameters:
modifyClusterSnapshotScheduleRequest
-- Returns:
- A Java Future containing the result of the ModifyClusterSnapshotSchedule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- InvalidClusterSnapshotScheduleStateException The cluster snapshot schedule state is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyClusterSnapshotSchedule
default CompletableFuture<ModifyClusterSnapshotScheduleResponse> modifyClusterSnapshotSchedule(Consumer<ModifyClusterSnapshotScheduleRequest.Builder> modifyClusterSnapshotScheduleRequest) Modifies a snapshot schedule for a cluster.
This is a convenience which creates an instance of the
ModifyClusterSnapshotScheduleRequest.Builder
avoiding the need to create one manually viaModifyClusterSnapshotScheduleRequest.builder()
- Parameters:
modifyClusterSnapshotScheduleRequest
- AConsumer
that will call methods onModifyClusterSnapshotScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyClusterSnapshotSchedule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- InvalidClusterSnapshotScheduleStateException The cluster snapshot schedule state is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyClusterSubnetGroup
default CompletableFuture<ModifyClusterSubnetGroupResponse> modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest) 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.
- Parameters:
modifyClusterSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyClusterSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- ClusterSubnetQuotaExceededException The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- SubnetAlreadyInUseException A specified subnet is already in use by another cluster.
- InvalidSubnetException The requested subnet is not valid, or not all of the subnets are in the same VPC.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyClusterSubnetGroup
default CompletableFuture<ModifyClusterSubnetGroupResponse> modifyClusterSubnetGroup(Consumer<ModifyClusterSubnetGroupRequest.Builder> modifyClusterSubnetGroupRequest) 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.
This is a convenience which creates an instance of the
ModifyClusterSubnetGroupRequest.Builder
avoiding the need to create one manually viaModifyClusterSubnetGroupRequest.builder()
- Parameters:
modifyClusterSubnetGroupRequest
- AConsumer
that will call methods onModifyClusterSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyClusterSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- ClusterSubnetQuotaExceededException The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- SubnetAlreadyInUseException A specified subnet is already in use by another cluster.
- InvalidSubnetException The requested subnet is not valid, or not all of the subnets are in the same VPC.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyCustomDomainAssociation
default CompletableFuture<ModifyCustomDomainAssociationResponse> modifyCustomDomainAssociation(ModifyCustomDomainAssociationRequest modifyCustomDomainAssociationRequest) Contains information for changing a custom domain association.
- Parameters:
modifyCustomDomainAssociationRequest
-- Returns:
- A Java Future containing the result of the ModifyCustomDomainAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedOperationException The requested operation isn't supported.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - CustomCnameAssociationException An error occurred when an attempt was made to change the custom domain association.
- CustomDomainAssociationNotFoundException An error occurred. The custom domain name couldn't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyCustomDomainAssociation
default CompletableFuture<ModifyCustomDomainAssociationResponse> modifyCustomDomainAssociation(Consumer<ModifyCustomDomainAssociationRequest.Builder> modifyCustomDomainAssociationRequest) Contains information for changing a custom domain association.
This is a convenience which creates an instance of the
ModifyCustomDomainAssociationRequest.Builder
avoiding the need to create one manually viaModifyCustomDomainAssociationRequest.builder()
- Parameters:
modifyCustomDomainAssociationRequest
- AConsumer
that will call methods onModifyCustomDomainAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyCustomDomainAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedOperationException The requested operation isn't supported.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - CustomCnameAssociationException An error occurred when an attempt was made to change the custom domain association.
- CustomDomainAssociationNotFoundException An error occurred. The custom domain name couldn't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyEndpointAccess
default CompletableFuture<ModifyEndpointAccessResponse> modifyEndpointAccess(ModifyEndpointAccessRequest modifyEndpointAccessRequest) Modifies a Redshift-managed VPC endpoint.
- Parameters:
modifyEndpointAccessRequest
-- Returns:
- A Java Future containing the result of the ModifyEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidEndpointStateException The status of the endpoint is not valid.
- EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
- See Also:
-
modifyEndpointAccess
default CompletableFuture<ModifyEndpointAccessResponse> modifyEndpointAccess(Consumer<ModifyEndpointAccessRequest.Builder> modifyEndpointAccessRequest) Modifies a Redshift-managed VPC endpoint.
This is a convenience which creates an instance of the
ModifyEndpointAccessRequest.Builder
avoiding the need to create one manually viaModifyEndpointAccessRequest.builder()
- Parameters:
modifyEndpointAccessRequest
- AConsumer
that will call methods onModifyEndpointAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidEndpointStateException The status of the endpoint is not valid.
- EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- InvalidClusterStateException The specified cluster is not in the
available
state. - UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
- See Also:
-
modifyEventSubscription
default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing Amazon Redshift event notification subscription.
- Parameters:
modifyEventSubscriptionRequest
-- Returns:
- A Java Future containing the result of the ModifyEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- SnsInvalidTopicException Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
- SnsNoAuthorizationException You do not have permission to publish to the specified Amazon SNS topic.
- SnsTopicArnNotFoundException An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
- SubscriptionEventIdNotFoundException An Amazon Redshift event with the specified event ID does not exist.
- SubscriptionCategoryNotFoundException The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
- SubscriptionSeverityNotFoundException The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
- SourceNotFoundException The specified Amazon Redshift event source could not be found.
- InvalidSubscriptionStateException The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyEventSubscription
default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) Modifies an existing Amazon Redshift event notification subscription.
This is a convenience which creates an instance of the
ModifyEventSubscriptionRequest.Builder
avoiding the need to create one manually viaModifyEventSubscriptionRequest.builder()
- Parameters:
modifyEventSubscriptionRequest
- AConsumer
that will call methods onModifyEventSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException An Amazon Redshift event notification subscription with the specified name does not exist.
- SnsInvalidTopicException Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
- SnsNoAuthorizationException You do not have permission to publish to the specified Amazon SNS topic.
- SnsTopicArnNotFoundException An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
- SubscriptionEventIdNotFoundException An Amazon Redshift event with the specified event ID does not exist.
- SubscriptionCategoryNotFoundException The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
- SubscriptionSeverityNotFoundException The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
- SourceNotFoundException The specified Amazon Redshift event source could not be found.
- InvalidSubscriptionStateException The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyRedshiftIdcApplication
default CompletableFuture<ModifyRedshiftIdcApplicationResponse> modifyRedshiftIdcApplication(ModifyRedshiftIdcApplicationRequest modifyRedshiftIdcApplicationRequest) Changes an existing Amazon Redshift IAM Identity Center application.
- Parameters:
modifyRedshiftIdcApplicationRequest
-- Returns:
- A Java Future containing the result of the ModifyRedshiftIdcApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyRedshiftIdcApplication
default CompletableFuture<ModifyRedshiftIdcApplicationResponse> modifyRedshiftIdcApplication(Consumer<ModifyRedshiftIdcApplicationRequest.Builder> modifyRedshiftIdcApplicationRequest) Changes an existing Amazon Redshift IAM Identity Center application.
This is a convenience which creates an instance of the
ModifyRedshiftIdcApplicationRequest.Builder
avoiding the need to create one manually viaModifyRedshiftIdcApplicationRequest.builder()
- Parameters:
modifyRedshiftIdcApplicationRequest
- AConsumer
that will call methods onModifyRedshiftIdcApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyRedshiftIdcApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RedshiftIdcApplicationNotExistsException The application you attempted to find doesn't exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- UnsupportedOperationException The requested operation isn't supported.
- DependentServiceAccessDeniedException A dependent service denied access for the integration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyScheduledAction
default CompletableFuture<ModifyScheduledActionResponse> modifyScheduledAction(ModifyScheduledActionRequest modifyScheduledActionRequest) Modifies a scheduled action.
- Parameters:
modifyScheduledActionRequest
-- Returns:
- A Java Future containing the result of the ModifyScheduledAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ScheduledActionNotFoundException The scheduled action cannot be found.
- ScheduledActionTypeUnsupportedException The action type specified for a scheduled action is not supported.
- InvalidScheduleException The schedule you submitted isn't valid.
- InvalidScheduledActionException The scheduled action is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifyScheduledAction
default CompletableFuture<ModifyScheduledActionResponse> modifyScheduledAction(Consumer<ModifyScheduledActionRequest.Builder> modifyScheduledActionRequest) Modifies a scheduled action.
This is a convenience which creates an instance of the
ModifyScheduledActionRequest.Builder
avoiding the need to create one manually viaModifyScheduledActionRequest.builder()
- Parameters:
modifyScheduledActionRequest
- AConsumer
that will call methods onModifyScheduledActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyScheduledAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - ScheduledActionNotFoundException The scheduled action cannot be found.
- ScheduledActionTypeUnsupportedException The action type specified for a scheduled action is not supported.
- InvalidScheduleException The schedule you submitted isn't valid.
- InvalidScheduledActionException The scheduled action is not valid.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifySnapshotCopyRetentionPeriod
default CompletableFuture<ModifySnapshotCopyRetentionPeriodResponse> modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest) 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.
- Parameters:
modifySnapshotCopyRetentionPeriodRequest
-- Returns:
- A Java Future containing the result of the ModifySnapshotCopyRetentionPeriod operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SnapshotCopyDisabledException Cross-region snapshot copy was temporarily disabled. Try your request again.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- InvalidClusterStateException The specified cluster is not in the
available
state. - InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifySnapshotCopyRetentionPeriod
default CompletableFuture<ModifySnapshotCopyRetentionPeriodResponse> modifySnapshotCopyRetentionPeriod(Consumer<ModifySnapshotCopyRetentionPeriodRequest.Builder> modifySnapshotCopyRetentionPeriodRequest) 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.
This is a convenience which creates an instance of the
ModifySnapshotCopyRetentionPeriodRequest.Builder
avoiding the need to create one manually viaModifySnapshotCopyRetentionPeriodRequest.builder()
- Parameters:
modifySnapshotCopyRetentionPeriodRequest
- AConsumer
that will call methods onModifySnapshotCopyRetentionPeriodRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifySnapshotCopyRetentionPeriod operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SnapshotCopyDisabledException Cross-region snapshot copy was temporarily disabled. Try your request again.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- InvalidClusterStateException The specified cluster is not in the
available
state. - InvalidRetentionPeriodException The retention period specified is either in the past or is not a
valid value.
The value must be either -1 or an integer between 1 and 3,653.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
modifySnapshotSchedule
default CompletableFuture<ModifySnapshotScheduleResponse> modifySnapshotSchedule(ModifySnapshotScheduleRequest modifySnapshotScheduleRequest) Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
- Parameters:
modifySnapshotScheduleRequest
-- Returns:
- A Java Future containing the result of the ModifySnapshotSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidScheduleException The schedule you submitted isn't valid.
- SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- SnapshotScheduleUpdateInProgressException The specified snapshot schedule is already being updated.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifySnapshotSchedule
default CompletableFuture<ModifySnapshotScheduleResponse> modifySnapshotSchedule(Consumer<ModifySnapshotScheduleRequest.Builder> modifySnapshotScheduleRequest) Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
This is a convenience which creates an instance of the
ModifySnapshotScheduleRequest.Builder
avoiding the need to create one manually viaModifySnapshotScheduleRequest.builder()
- Parameters:
modifySnapshotScheduleRequest
- AConsumer
that will call methods onModifySnapshotScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifySnapshotSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidScheduleException The schedule you submitted isn't valid.
- SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- SnapshotScheduleUpdateInProgressException The specified snapshot schedule is already being updated.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyUsageLimit
default CompletableFuture<ModifyUsageLimitResponse> modifyUsageLimit(ModifyUsageLimitRequest modifyUsageLimitRequest) Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.
- Parameters:
modifyUsageLimitRequest
-- Returns:
- A Java Future containing the result of the ModifyUsageLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidUsageLimitException The usage limit is not valid.
- UsageLimitNotFoundException The usage limit identifier can't be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyUsageLimit
default CompletableFuture<ModifyUsageLimitResponse> modifyUsageLimit(Consumer<ModifyUsageLimitRequest.Builder> modifyUsageLimitRequest) Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.
This is a convenience which creates an instance of the
ModifyUsageLimitRequest.Builder
avoiding the need to create one manually viaModifyUsageLimitRequest.builder()
- Parameters:
modifyUsageLimitRequest
- AConsumer
that will call methods onModifyUsageLimitRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyUsageLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidUsageLimitException The usage limit is not valid.
- UsageLimitNotFoundException The usage limit identifier can't be found.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
pauseCluster
default CompletableFuture<PauseClusterResponse> pauseCluster(PauseClusterRequest pauseClusterRequest) Pauses a cluster.
- Parameters:
pauseClusterRequest
- Describes a pause cluster operation. For example, a scheduled action to run thePauseCluster
API operation.- Returns:
- A Java Future containing the result of the PauseCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
pauseCluster
default CompletableFuture<PauseClusterResponse> pauseCluster(Consumer<PauseClusterRequest.Builder> pauseClusterRequest) Pauses a cluster.
This is a convenience which creates an instance of the
PauseClusterRequest.Builder
avoiding the need to create one manually viaPauseClusterRequest.builder()
- Parameters:
pauseClusterRequest
- AConsumer
that will call methods onPauseClusterRequest.Builder
to create a request. Describes a pause cluster operation. For example, a scheduled action to run thePauseCluster
API operation.- Returns:
- A Java Future containing the result of the PauseCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
purchaseReservedNodeOffering
default CompletableFuture<PurchaseReservedNodeOfferingResponse> purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest) 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.
- Parameters:
purchaseReservedNodeOfferingRequest
-- Returns:
- A Java Future containing the result of the PurchaseReservedNodeOffering operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- ReservedNodeAlreadyExistsException User already has a reservation with the given identifier.
- ReservedNodeQuotaExceededException Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
purchaseReservedNodeOffering
default CompletableFuture<PurchaseReservedNodeOfferingResponse> purchaseReservedNodeOffering(Consumer<PurchaseReservedNodeOfferingRequest.Builder> purchaseReservedNodeOfferingRequest) 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.
This is a convenience which creates an instance of the
PurchaseReservedNodeOfferingRequest.Builder
avoiding the need to create one manually viaPurchaseReservedNodeOfferingRequest.builder()
- Parameters:
purchaseReservedNodeOfferingRequest
- AConsumer
that will call methods onPurchaseReservedNodeOfferingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PurchaseReservedNodeOffering operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- ReservedNodeAlreadyExistsException User already has a reservation with the given identifier.
- ReservedNodeQuotaExceededException Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) Updates the resource policy for a specified resource.
- Parameters:
putResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidPolicyException The resource policy isn't valid.
- ConflictPolicyUpdateException There is a conflict while updating the resource policy.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Updates the resource policy for a specified resource.
This is a convenience which creates an instance of the
PutResourcePolicyRequest.Builder
avoiding the need to create one manually viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- InvalidPolicyException The resource policy isn't valid.
- ConflictPolicyUpdateException There is a conflict while updating the resource policy.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rebootCluster
default CompletableFuture<RebootClusterResponse> rebootCluster(RebootClusterRequest rebootClusterRequest) 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.- Parameters:
rebootClusterRequest
-- Returns:
- A Java Future containing the result of the RebootCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterStateException The specified cluster is not in the
- See Also:
-
rebootCluster
default CompletableFuture<RebootClusterResponse> rebootCluster(Consumer<RebootClusterRequest.Builder> rebootClusterRequest) 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.
This is a convenience which creates an instance of the
RebootClusterRequest.Builder
avoiding the need to create one manually viaRebootClusterRequest.builder()
- Parameters:
rebootClusterRequest
- AConsumer
that will call methods onRebootClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RebootCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterStateException The specified cluster is not in the
- See Also:
-
resetClusterParameterGroup
default CompletableFuture<ResetClusterParameterGroupResponse> resetClusterParameterGroup(ResetClusterParameterGroupRequest resetClusterParameterGroupRequest) 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.
- Parameters:
resetClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ResetClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterParameterGroupStateException The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetClusterParameterGroup
default CompletableFuture<ResetClusterParameterGroupResponse> resetClusterParameterGroup(Consumer<ResetClusterParameterGroupRequest.Builder> resetClusterParameterGroupRequest) 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.
This is a convenience which creates an instance of the
ResetClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaResetClusterParameterGroupRequest.builder()
- Parameters:
resetClusterParameterGroupRequest
- AConsumer
that will call methods onResetClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterParameterGroupStateException The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resizeCluster
default CompletableFuture<ResizeClusterResponse> resizeCluster(ResizeClusterRequest resizeClusterRequest) Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.
Elastic resize operations have the following restrictions:
-
You can only resize clusters of the following types:
-
dc1.large (if your cluster is in a VPC)
-
dc1.8xlarge (if your cluster is in a VPC)
-
dc2.large
-
dc2.8xlarge
-
ds2.xlarge
-
ds2.8xlarge
-
ra3.xlplus
-
ra3.4xlarge
-
ra3.16xlarge
-
-
The type of nodes that you add must match the node type for the cluster.
- Parameters:
resizeClusterRequest
- Describes a resize cluster operation. For example, a scheduled action to run theResizeCluster
API operation.- Returns:
- A Java Future containing the result of the ResizeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
- InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- UnsupportedOptionException A request option was specified that is not supported.
- UnsupportedOperationException The requested operation isn't supported.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ReservedNodeAlreadyExistsException User already has a reservation with the given identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterStateException The specified cluster is not in the
- See Also:
-
-
resizeCluster
default CompletableFuture<ResizeClusterResponse> resizeCluster(Consumer<ResizeClusterRequest.Builder> resizeClusterRequest) Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.
Elastic resize operations have the following restrictions:
-
You can only resize clusters of the following types:
-
dc1.large (if your cluster is in a VPC)
-
dc1.8xlarge (if your cluster is in a VPC)
-
dc2.large
-
dc2.8xlarge
-
ds2.xlarge
-
ds2.8xlarge
-
ra3.xlplus
-
ra3.4xlarge
-
ra3.16xlarge
-
-
The type of nodes that you add must match the node type for the cluster.
This is a convenience which creates an instance of the
ResizeClusterRequest.Builder
avoiding the need to create one manually viaResizeClusterRequest.builder()
- Parameters:
resizeClusterRequest
- AConsumer
that will call methods onResizeClusterRequest.Builder
to create a request. Describes a resize cluster operation. For example, a scheduled action to run theResizeCluster
API operation.- Returns:
- A Java Future containing the result of the ResizeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidClusterStateException The specified cluster is not in the
available
state. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
- InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- UnsupportedOptionException A request option was specified that is not supported.
- UnsupportedOperationException The requested operation isn't supported.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ReservedNodeAlreadyExistsException User already has a reservation with the given identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidClusterStateException The specified cluster is not in the
- See Also:
-
-
restoreFromClusterSnapshot
default CompletableFuture<RestoreFromClusterSnapshotResponse> restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest) 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.
- Parameters:
restoreFromClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the RestoreFromClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessToSnapshotDeniedException The owner of the specified snapshot has not authorized your account to access the snapshot.
- ClusterAlreadyExistsException The account already has a cluster with the given identifier.
- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- ClusterQuotaExceededException The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - InvalidRestoreException The restore is invalid.
- NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
- InvalidVpcNetworkStateException The cluster subnet group does not cover all Availability Zones.
- InvalidClusterSubnetGroupStateException The cluster subnet group cannot be deleted because it is in use.
- InvalidSubnetException The requested subnet is not valid, or not all of the subnets are in the same VPC.
- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidElasticIpException The Elastic IP (EIP) is invalid or cannot be found.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidClusterTrackException The provided cluster track name is not valid.
- SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ReservedNodeAlreadyExistsException User already has a reservation with the given identifier.
- UnsupportedOperationException The requested operation isn't supported.
- Ipv6CidrBlockNotFoundException There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreFromClusterSnapshot
default CompletableFuture<RestoreFromClusterSnapshotResponse> restoreFromClusterSnapshot(Consumer<RestoreFromClusterSnapshotRequest.Builder> restoreFromClusterSnapshotRequest) 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.
This is a convenience which creates an instance of the
RestoreFromClusterSnapshotRequest.Builder
avoiding the need to create one manually viaRestoreFromClusterSnapshotRequest.builder()
- Parameters:
restoreFromClusterSnapshotRequest
- AConsumer
that will call methods onRestoreFromClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreFromClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessToSnapshotDeniedException The owner of the specified snapshot has not authorized your account to access the snapshot.
- ClusterAlreadyExistsException The account already has a cluster with the given identifier.
- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- ClusterQuotaExceededException The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - InvalidRestoreException The restore is invalid.
- NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
- NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
- InvalidVpcNetworkStateException The cluster subnet group does not cover all Availability Zones.
- InvalidClusterSubnetGroupStateException The cluster subnet group cannot be deleted because it is in use.
- InvalidSubnetException The requested subnet is not valid, or not all of the subnets are in the same VPC.
- ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
- UnauthorizedOperationException Your account is not authorized to perform the requested operation.
- HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
- HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
- InvalidElasticIpException The Elastic IP (EIP) is invalid or cannot be found.
- ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
- DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- InvalidClusterTrackException The provided cluster track name is not valid.
- SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
- TagLimitExceededException You have exceeded the number of tags allowed.
- InvalidTagException The tag is invalid.
- ReservedNodeNotFoundException The specified reserved compute node not found.
- InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
- ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
- ReservedNodeOfferingNotFoundException Specified offering does not exist.
- DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
- ReservedNodeAlreadyExistsException User already has a reservation with the given identifier.
- UnsupportedOperationException The requested operation isn't supported.
- Ipv6CidrBlockNotFoundException There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreTableFromClusterSnapshot
default CompletableFuture<RestoreTableFromClusterSnapshotResponse> restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest) 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 callRestoreTableFromClusterSnapshot
. When you have renamed your original table, then you can pass the original name of the table as theNewTableName
parameter value in the call toRestoreTableFromClusterSnapshot
. 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.
- Parameters:
restoreTableFromClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the RestoreTableFromClusterSnapshot operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InProgressTableRestoreQuotaExceededException You have exceeded the allowed number of table restore requests. Wait for your current table restore requests to complete before making a new request.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - InvalidTableRestoreArgumentException The value specified for the
sourceDatabaseName
,sourceSchemaName
, orsourceTableName
parameter, or a combination of these, doesn't exist in the snapshot. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreTableFromClusterSnapshot
default CompletableFuture<RestoreTableFromClusterSnapshotResponse> restoreTableFromClusterSnapshot(Consumer<RestoreTableFromClusterSnapshotRequest.Builder> restoreTableFromClusterSnapshotRequest) 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 callRestoreTableFromClusterSnapshot
. When you have renamed your original table, then you can pass the original name of the table as theNewTableName
parameter value in the call toRestoreTableFromClusterSnapshot
. 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.
This is a convenience which creates an instance of the
RestoreTableFromClusterSnapshotRequest.Builder
avoiding the need to create one manually viaRestoreTableFromClusterSnapshotRequest.builder()
- Parameters:
restoreTableFromClusterSnapshotRequest
- AConsumer
that will call methods onRestoreTableFromClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreTableFromClusterSnapshot operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- InProgressTableRestoreQuotaExceededException You have exceeded the allowed number of table restore requests. Wait for your current table restore requests to complete before making a new request.
- InvalidClusterSnapshotStateException The specified cluster snapshot is not in the
available
state, or other accounts are authorized to access the snapshot. - InvalidTableRestoreArgumentException The value specified for the
sourceDatabaseName
,sourceSchemaName
, orsourceTableName
parameter, or a combination of these, doesn't exist in the snapshot. - ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resumeCluster
default CompletableFuture<ResumeClusterResponse> resumeCluster(ResumeClusterRequest resumeClusterRequest) Resumes a paused cluster.
- Parameters:
resumeClusterRequest
- Describes a resume cluster operation. For example, a scheduled action to run theResumeCluster
API operation.- Returns:
- A Java Future containing the result of the ResumeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
resumeCluster
default CompletableFuture<ResumeClusterResponse> resumeCluster(Consumer<ResumeClusterRequest.Builder> resumeClusterRequest) Resumes a paused cluster.
This is a convenience which creates an instance of the
ResumeClusterRequest.Builder
avoiding the need to create one manually viaResumeClusterRequest.builder()
- Parameters:
resumeClusterRequest
- AConsumer
that will call methods onResumeClusterRequest.Builder
to create a request. Describes a resume cluster operation. For example, a scheduled action to run theResumeCluster
API operation.- Returns:
- A Java Future containing the result of the ResumeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
revokeClusterSecurityGroupIngress
default CompletableFuture<RevokeClusterSecurityGroupIngressResponse> revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest) 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.
- Parameters:
revokeClusterSecurityGroupIngressRequest
-- Returns:
- A Java Future containing the result of the RevokeClusterSecurityGroupIngress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- AuthorizationNotFoundException The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
revokeClusterSecurityGroupIngress
default CompletableFuture<RevokeClusterSecurityGroupIngressResponse> revokeClusterSecurityGroupIngress(Consumer<RevokeClusterSecurityGroupIngressRequest.Builder> revokeClusterSecurityGroupIngressRequest) 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.
This is a convenience which creates an instance of the
RevokeClusterSecurityGroupIngressRequest.Builder
avoiding the need to create one manually viaRevokeClusterSecurityGroupIngressRequest.builder()
- Parameters:
revokeClusterSecurityGroupIngressRequest
- AConsumer
that will call methods onRevokeClusterSecurityGroupIngressRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RevokeClusterSecurityGroupIngress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
- AuthorizationNotFoundException The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
revokeEndpointAccess
default CompletableFuture<RevokeEndpointAccessResponse> revokeEndpointAccess(RevokeEndpointAccessRequest revokeEndpointAccessRequest) Revokes access to a cluster.
- Parameters:
revokeEndpointAccessRequest
-- Returns:
- A Java Future containing the result of the RevokeEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidEndpointStateException The status of the endpoint is not valid.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- EndpointAuthorizationNotFoundException The authorization for this endpoint can't be found.
- InvalidAuthorizationStateException The status of the authorization is not valid.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
revokeEndpointAccess
default CompletableFuture<RevokeEndpointAccessResponse> revokeEndpointAccess(Consumer<RevokeEndpointAccessRequest.Builder> revokeEndpointAccessRequest) Revokes access to a cluster.
This is a convenience which creates an instance of the
RevokeEndpointAccessRequest.Builder
avoiding the need to create one manually viaRevokeEndpointAccessRequest.builder()
- Parameters:
revokeEndpointAccessRequest
- AConsumer
that will call methods onRevokeEndpointAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RevokeEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidEndpointStateException The status of the endpoint is not valid.
- InvalidClusterSecurityGroupStateException The state of the cluster security group is not
available
. - EndpointNotFoundException The endpoint name doesn't refer to an existing endpoint.
- EndpointAuthorizationNotFoundException The authorization for this endpoint can't be found.
- InvalidAuthorizationStateException The status of the authorization is not valid.
- InvalidClusterStateException The specified cluster is not in the
available
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
revokeSnapshotAccess
default CompletableFuture<RevokeSnapshotAccessResponse> revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest) 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.
- Parameters:
revokeSnapshotAccessRequest
-- Returns:
- A Java Future containing the result of the RevokeSnapshotAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessToSnapshotDeniedException The owner of the specified snapshot has not authorized your account to access the snapshot.
- AuthorizationNotFoundException The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
revokeSnapshotAccess
default CompletableFuture<RevokeSnapshotAccessResponse> revokeSnapshotAccess(Consumer<RevokeSnapshotAccessRequest.Builder> revokeSnapshotAccessRequest) 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.
This is a convenience which creates an instance of the
RevokeSnapshotAccessRequest.Builder
avoiding the need to create one manually viaRevokeSnapshotAccessRequest.builder()
- Parameters:
revokeSnapshotAccessRequest
- AConsumer
that will call methods onRevokeSnapshotAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RevokeSnapshotAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessToSnapshotDeniedException The owner of the specified snapshot has not authorized your account to access the snapshot.
- AuthorizationNotFoundException The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
- ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rotateEncryptionKey
default CompletableFuture<RotateEncryptionKeyResponse> rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest) Rotates the encryption keys for a cluster.
- Parameters:
rotateEncryptionKeyRequest
-- Returns:
- A Java Future containing the result of the RotateEncryptionKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
rotateEncryptionKey
default CompletableFuture<RotateEncryptionKeyResponse> rotateEncryptionKey(Consumer<RotateEncryptionKeyRequest.Builder> rotateEncryptionKeyRequest) Rotates the encryption keys for a cluster.
This is a convenience which creates an instance of the
RotateEncryptionKeyRequest.Builder
avoiding the need to create one manually viaRotateEncryptionKeyRequest.builder()
- Parameters:
rotateEncryptionKeyRequest
- AConsumer
that will call methods onRotateEncryptionKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RotateEncryptionKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - InvalidClusterStateException The specified cluster is not in the
available
state. - DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ClusterNotFoundException The
- See Also:
-
updatePartnerStatus
default CompletableFuture<UpdatePartnerStatusResponse> updatePartnerStatus(UpdatePartnerStatusRequest updatePartnerStatusRequest) Updates the status of a partner integration.
- Parameters:
updatePartnerStatusRequest
-- Returns:
- A Java Future containing the result of the UpdatePartnerStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PartnerNotFoundException The name of the partner was not found.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnauthorizedPartnerIntegrationException The partner integration is not authorized.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePartnerStatus
default CompletableFuture<UpdatePartnerStatusResponse> updatePartnerStatus(Consumer<UpdatePartnerStatusRequest.Builder> updatePartnerStatusRequest) Updates the status of a partner integration.
This is a convenience which creates an instance of the
UpdatePartnerStatusRequest.Builder
avoiding the need to create one manually viaUpdatePartnerStatusRequest.builder()
- Parameters:
updatePartnerStatusRequest
- AConsumer
that will call methods onUpdatePartnerStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePartnerStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PartnerNotFoundException The name of the partner was not found.
- ClusterNotFoundException The
ClusterIdentifier
parameter does not refer to an existing cluster. - UnauthorizedPartnerIntegrationException The partner integration is not authorized.
- UnsupportedOperationException The requested operation isn't supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RedshiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofRedshiftAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
RedshiftAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aRedshiftAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRedshiftAsyncClient
.
-