@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface RedshiftClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default 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.
|
default 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.
|
default AddPartnerResponse |
addPartner(AddPartnerRequest addPartnerRequest)
Adds a partner integration to a cluster.
|
default AddPartnerResponse |
addPartner(Consumer<AddPartnerRequest.Builder> addPartnerRequest)
Adds a partner integration to a cluster.
|
default AssociateDataShareConsumerResponse |
associateDataShareConsumer(AssociateDataShareConsumerRequest associateDataShareConsumerRequest)
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the
specified namespace (ConsumerArn).
|
default AssociateDataShareConsumerResponse |
associateDataShareConsumer(Consumer<AssociateDataShareConsumerRequest.Builder> associateDataShareConsumerRequest)
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the
specified namespace (ConsumerArn).
|
default AuthorizeClusterSecurityGroupIngressResponse |
authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group.
|
default AuthorizeClusterSecurityGroupIngressResponse |
authorizeClusterSecurityGroupIngress(Consumer<AuthorizeClusterSecurityGroupIngressRequest.Builder> authorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group.
|
default AuthorizeDataShareResponse |
authorizeDataShare(AuthorizeDataShareRequest authorizeDataShareRequest)
From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or
managing entities.
|
default AuthorizeDataShareResponse |
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.
|
default AuthorizeEndpointAccessResponse |
authorizeEndpointAccess(AuthorizeEndpointAccessRequest authorizeEndpointAccessRequest)
Grants access to a cluster.
|
default AuthorizeEndpointAccessResponse |
authorizeEndpointAccess(Consumer<AuthorizeEndpointAccessRequest.Builder> authorizeEndpointAccessRequest)
Grants access to a cluster.
|
default AuthorizeSnapshotAccessResponse |
authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest)
Authorizes the specified Amazon Web Services account to restore the specified snapshot.
|
default AuthorizeSnapshotAccessResponse |
authorizeSnapshotAccess(Consumer<AuthorizeSnapshotAccessRequest.Builder> authorizeSnapshotAccessRequest)
Authorizes the specified Amazon Web Services account to restore the specified snapshot.
|
default BatchDeleteClusterSnapshotsResponse |
batchDeleteClusterSnapshots(BatchDeleteClusterSnapshotsRequest batchDeleteClusterSnapshotsRequest)
Deletes a set of cluster snapshots.
|
default BatchDeleteClusterSnapshotsResponse |
batchDeleteClusterSnapshots(Consumer<BatchDeleteClusterSnapshotsRequest.Builder> batchDeleteClusterSnapshotsRequest)
Deletes a set of cluster snapshots.
|
default BatchModifyClusterSnapshotsResponse |
batchModifyClusterSnapshots(BatchModifyClusterSnapshotsRequest batchModifyClusterSnapshotsRequest)
Modifies the settings for a set of cluster snapshots.
|
default BatchModifyClusterSnapshotsResponse |
batchModifyClusterSnapshots(Consumer<BatchModifyClusterSnapshotsRequest.Builder> batchModifyClusterSnapshotsRequest)
Modifies the settings for a set of cluster snapshots.
|
static RedshiftClientBuilder |
builder()
Create a builder that can be used to configure and create a
RedshiftClient. |
default CancelResizeResponse |
cancelResize(CancelResizeRequest cancelResizeRequest)
Cancels a resize operation for a cluster.
|
default CancelResizeResponse |
cancelResize(Consumer<CancelResizeRequest.Builder> cancelResizeRequest)
Cancels a resize operation for a cluster.
|
default CopyClusterSnapshotResponse |
copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
|
default CopyClusterSnapshotResponse |
copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
|
static RedshiftClient |
create()
Create a
RedshiftClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAuthenticationProfileResponse |
createAuthenticationProfile(Consumer<CreateAuthenticationProfileRequest.Builder> createAuthenticationProfileRequest)
Creates an authentication profile with the specified parameters.
|
default CreateAuthenticationProfileResponse |
createAuthenticationProfile(CreateAuthenticationProfileRequest createAuthenticationProfileRequest)
Creates an authentication profile with the specified parameters.
|
default CreateClusterResponse |
createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates a new cluster with the specified parameters.
|
default CreateClusterResponse |
createCluster(CreateClusterRequest createClusterRequest)
Creates a new cluster with the specified parameters.
|
default CreateClusterParameterGroupResponse |
createClusterParameterGroup(Consumer<CreateClusterParameterGroupRequest.Builder> createClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.
|
default CreateClusterParameterGroupResponse |
createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.
|
default CreateClusterSecurityGroupResponse |
createClusterSecurityGroup(Consumer<CreateClusterSecurityGroupRequest.Builder> createClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group.
|
default CreateClusterSecurityGroupResponse |
createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group.
|
default CreateClusterSnapshotResponse |
createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster.
|
default CreateClusterSnapshotResponse |
createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster.
|
default CreateClusterSubnetGroupResponse |
createClusterSubnetGroup(Consumer<CreateClusterSubnetGroupRequest.Builder> createClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group.
|
default CreateClusterSubnetGroupResponse |
createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group.
|
default CreateCustomDomainAssociationResponse |
createCustomDomainAssociation(Consumer<CreateCustomDomainAssociationRequest.Builder> createCustomDomainAssociationRequest)
Used to create a custom domain name for a cluster.
|
default CreateCustomDomainAssociationResponse |
createCustomDomainAssociation(CreateCustomDomainAssociationRequest createCustomDomainAssociationRequest)
Used to create a custom domain name for a cluster.
|
default CreateEndpointAccessResponse |
createEndpointAccess(Consumer<CreateEndpointAccessRequest.Builder> createEndpointAccessRequest)
Creates a Redshift-managed VPC endpoint.
|
default CreateEndpointAccessResponse |
createEndpointAccess(CreateEndpointAccessRequest createEndpointAccessRequest)
Creates a Redshift-managed VPC endpoint.
|
default CreateEventSubscriptionResponse |
createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription.
|
default CreateEventSubscriptionResponse |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription.
|
default 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.
|
default 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.
|
default 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).
|
default 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).
|
default CreateScheduledActionResponse |
createScheduledAction(Consumer<CreateScheduledActionRequest.Builder> createScheduledActionRequest)
Creates a scheduled action.
|
default CreateScheduledActionResponse |
createScheduledAction(CreateScheduledActionRequest createScheduledActionRequest)
Creates a scheduled action.
|
default 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.
|
default 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.
|
default 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.
|
default CreateSnapshotScheduleResponse |
createSnapshotSchedule(CreateSnapshotScheduleRequest createSnapshotScheduleRequest)
Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup
schedule.
|
default CreateTagsResponse |
createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Adds tags to a cluster.
|
default CreateTagsResponse |
createTags(CreateTagsRequest createTagsRequest)
Adds tags to a cluster.
|
default CreateUsageLimitResponse |
createUsageLimit(Consumer<CreateUsageLimitRequest.Builder> createUsageLimitRequest)
Creates a usage limit for a specified Amazon Redshift feature on a cluster.
|
default CreateUsageLimitResponse |
createUsageLimit(CreateUsageLimitRequest createUsageLimitRequest)
Creates a usage limit for a specified Amazon Redshift feature on a cluster.
|
default DeauthorizeDataShareResponse |
deauthorizeDataShare(Consumer<DeauthorizeDataShareRequest.Builder> deauthorizeDataShareRequest)
From a datashare producer account, removes authorization from the specified datashare.
|
default DeauthorizeDataShareResponse |
deauthorizeDataShare(DeauthorizeDataShareRequest deauthorizeDataShareRequest)
From a datashare producer account, removes authorization from the specified datashare.
|
default DeleteAuthenticationProfileResponse |
deleteAuthenticationProfile(Consumer<DeleteAuthenticationProfileRequest.Builder> deleteAuthenticationProfileRequest)
Deletes an authentication profile.
|
default DeleteAuthenticationProfileResponse |
deleteAuthenticationProfile(DeleteAuthenticationProfileRequest deleteAuthenticationProfileRequest)
Deletes an authentication profile.
|
default DeleteClusterResponse |
deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Deletes a previously provisioned cluster without its final snapshot being created.
|
default DeleteClusterResponse |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes a previously provisioned cluster without its final snapshot being created.
|
default DeleteClusterParameterGroupResponse |
deleteClusterParameterGroup(Consumer<DeleteClusterParameterGroupRequest.Builder> deleteClusterParameterGroupRequest)
Deletes a specified Amazon Redshift parameter group.
|
default DeleteClusterParameterGroupResponse |
deleteClusterParameterGroup(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest)
Deletes a specified Amazon Redshift parameter group.
|
default DeleteClusterSecurityGroupResponse |
deleteClusterSecurityGroup(Consumer<DeleteClusterSecurityGroupRequest.Builder> deleteClusterSecurityGroupRequest)
Deletes an Amazon Redshift security group.
|
default DeleteClusterSecurityGroupResponse |
deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest)
Deletes an Amazon Redshift security group.
|
default DeleteClusterSnapshotResponse |
deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest)
Deletes the specified manual snapshot.
|
default DeleteClusterSnapshotResponse |
deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)
Deletes the specified manual snapshot.
|
default DeleteClusterSubnetGroupResponse |
deleteClusterSubnetGroup(Consumer<DeleteClusterSubnetGroupRequest.Builder> deleteClusterSubnetGroupRequest)
Deletes the specified cluster subnet group.
|
default DeleteClusterSubnetGroupResponse |
deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest)
Deletes the specified cluster subnet group.
|
default DeleteCustomDomainAssociationResponse |
deleteCustomDomainAssociation(Consumer<DeleteCustomDomainAssociationRequest.Builder> deleteCustomDomainAssociationRequest)
Contains information about deleting a custom domain association for a cluster.
|
default DeleteCustomDomainAssociationResponse |
deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest deleteCustomDomainAssociationRequest)
Contains information about deleting a custom domain association for a cluster.
|
default DeleteEndpointAccessResponse |
deleteEndpointAccess(Consumer<DeleteEndpointAccessRequest.Builder> deleteEndpointAccessRequest)
Deletes a Redshift-managed VPC endpoint.
|
default DeleteEndpointAccessResponse |
deleteEndpointAccess(DeleteEndpointAccessRequest deleteEndpointAccessRequest)
Deletes a Redshift-managed VPC endpoint.
|
default DeleteEventSubscriptionResponse |
deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest)
Deletes an Amazon Redshift event notification subscription.
|
default DeleteEventSubscriptionResponse |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an Amazon Redshift event notification subscription.
|
default DeleteHsmClientCertificateResponse |
deleteHsmClientCertificate(Consumer<DeleteHsmClientCertificateRequest.Builder> deleteHsmClientCertificateRequest)
Deletes the specified HSM client certificate.
|
default DeleteHsmClientCertificateResponse |
deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest)
Deletes the specified HSM client certificate.
|
default DeleteHsmConfigurationResponse |
deleteHsmConfiguration(Consumer<DeleteHsmConfigurationRequest.Builder> deleteHsmConfigurationRequest)
Deletes the specified Amazon Redshift HSM configuration.
|
default DeleteHsmConfigurationResponse |
deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest)
Deletes the specified Amazon Redshift HSM configuration.
|
default DeletePartnerResponse |
deletePartner(Consumer<DeletePartnerRequest.Builder> deletePartnerRequest)
Deletes a partner integration from a cluster.
|
default DeletePartnerResponse |
deletePartner(DeletePartnerRequest deletePartnerRequest)
Deletes a partner integration from a cluster.
|
default DeleteResourcePolicyResponse |
deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Deletes the resource policy for a specified resource.
|
default DeleteResourcePolicyResponse |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the resource policy for a specified resource.
|
default DeleteScheduledActionResponse |
deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest)
Deletes a scheduled action.
|
default DeleteScheduledActionResponse |
deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
Deletes a scheduled action.
|
default DeleteSnapshotCopyGrantResponse |
deleteSnapshotCopyGrant(Consumer<DeleteSnapshotCopyGrantRequest.Builder> deleteSnapshotCopyGrantRequest)
Deletes the specified snapshot copy grant.
|
default DeleteSnapshotCopyGrantResponse |
deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest)
Deletes the specified snapshot copy grant.
|
default DeleteSnapshotScheduleResponse |
deleteSnapshotSchedule(Consumer<DeleteSnapshotScheduleRequest.Builder> deleteSnapshotScheduleRequest)
Deletes a snapshot schedule.
|
default DeleteSnapshotScheduleResponse |
deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest)
Deletes a snapshot schedule.
|
default DeleteTagsResponse |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes tags from a resource.
|
default DeleteTagsResponse |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes tags from a resource.
|
default DeleteUsageLimitResponse |
deleteUsageLimit(Consumer<DeleteUsageLimitRequest.Builder> deleteUsageLimitRequest)
Deletes a usage limit from a cluster.
|
default DeleteUsageLimitResponse |
deleteUsageLimit(DeleteUsageLimitRequest deleteUsageLimitRequest)
Deletes a usage limit from a cluster.
|
default DescribeAccountAttributesResponse |
describeAccountAttributes()
Returns a list of attributes attached to an account
|
default DescribeAccountAttributesResponse |
describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest)
Returns a list of attributes attached to an account
|
default DescribeAccountAttributesResponse |
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Returns a list of attributes attached to an account
|
default DescribeAuthenticationProfilesResponse |
describeAuthenticationProfiles(Consumer<DescribeAuthenticationProfilesRequest.Builder> describeAuthenticationProfilesRequest)
Describes an authentication profile.
|
default DescribeAuthenticationProfilesResponse |
describeAuthenticationProfiles(DescribeAuthenticationProfilesRequest describeAuthenticationProfilesRequest)
Describes an authentication profile.
|
default DescribeClusterDbRevisionsResponse |
describeClusterDbRevisions()
Returns an array of
ClusterDbRevision objects. |
default DescribeClusterDbRevisionsResponse |
describeClusterDbRevisions(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest)
Returns an array of
ClusterDbRevision objects. |
default DescribeClusterDbRevisionsResponse |
describeClusterDbRevisions(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest)
Returns an array of
ClusterDbRevision objects. |
default DescribeClusterDbRevisionsIterable |
describeClusterDbRevisionsPaginator()
Returns an array of
ClusterDbRevision objects. |
default DescribeClusterDbRevisionsIterable |
describeClusterDbRevisionsPaginator(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest)
Returns an array of
ClusterDbRevision objects. |
default DescribeClusterDbRevisionsIterable |
describeClusterDbRevisionsPaginator(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest)
Returns an array of
ClusterDbRevision objects. |
default DescribeClusterParameterGroupsResponse |
describeClusterParameterGroups()
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsResponse |
describeClusterParameterGroups(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsResponse |
describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsIterable |
describeClusterParameterGroupsPaginator()
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsIterable |
describeClusterParameterGroupsPaginator(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsIterable |
describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParametersResponse |
describeClusterParameters(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default DescribeClusterParametersResponse |
describeClusterParameters(DescribeClusterParametersRequest describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default DescribeClusterParametersIterable |
describeClusterParametersPaginator(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default DescribeClusterParametersIterable |
describeClusterParametersPaginator(DescribeClusterParametersRequest describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default DescribeClustersResponse |
describeClusters()
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default 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.
|
default 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.
|
default DescribeClusterSecurityGroupsResponse |
describeClusterSecurityGroups(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default DescribeClusterSecurityGroupsResponse |
describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default DescribeClusterSecurityGroupsIterable |
describeClusterSecurityGroupsPaginator(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default DescribeClusterSecurityGroupsIterable |
describeClusterSecurityGroupsPaginator(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default DescribeClusterSnapshotsResponse |
describeClusterSnapshots()
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsResponse |
describeClusterSnapshots(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsResponse |
describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsIterable |
describeClusterSnapshotsPaginator()
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsIterable |
describeClusterSnapshotsPaginator(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsIterable |
describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClustersIterable |
describeClustersPaginator()
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default DescribeClustersIterable |
describeClustersPaginator(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.
|
default DescribeClustersIterable |
describeClustersPaginator(DescribeClustersRequest describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default DescribeClusterSubnetGroupsResponse |
describeClusterSubnetGroups()
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsResponse |
describeClusterSubnetGroups(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsResponse |
describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsIterable |
describeClusterSubnetGroupsPaginator()
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsIterable |
describeClusterSubnetGroupsPaginator(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsIterable |
describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterTracksResponse |
describeClusterTracks()
Returns a list of all the available maintenance tracks.
|
default DescribeClusterTracksResponse |
describeClusterTracks(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest)
Returns a list of all the available maintenance tracks.
|
default DescribeClusterTracksResponse |
describeClusterTracks(DescribeClusterTracksRequest describeClusterTracksRequest)
Returns a list of all the available maintenance tracks.
|
default DescribeClusterTracksIterable |
describeClusterTracksPaginator()
Returns a list of all the available maintenance tracks.
|
default DescribeClusterTracksIterable |
describeClusterTracksPaginator(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest)
Returns a list of all the available maintenance tracks.
|
default DescribeClusterTracksIterable |
describeClusterTracksPaginator(DescribeClusterTracksRequest describeClusterTracksRequest)
Returns a list of all the available maintenance tracks.
|
default DescribeClusterVersionsResponse |
describeClusterVersions()
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsResponse |
describeClusterVersions(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsResponse |
describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsIterable |
describeClusterVersionsPaginator()
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsIterable |
describeClusterVersionsPaginator(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsIterable |
describeClusterVersionsPaginator(DescribeClusterVersionsRequest describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeCustomDomainAssociationsResponse |
describeCustomDomainAssociations(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest)
Contains information about custom domain associations for a cluster.
|
default DescribeCustomDomainAssociationsResponse |
describeCustomDomainAssociations(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest)
Contains information about custom domain associations for a cluster.
|
default DescribeCustomDomainAssociationsIterable |
describeCustomDomainAssociationsPaginator(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest)
Contains information about custom domain associations for a cluster.
|
default DescribeCustomDomainAssociationsIterable |
describeCustomDomainAssociationsPaginator(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest)
Contains information about custom domain associations for a cluster.
|
default DescribeDataSharesResponse |
describeDataShares(Consumer<DescribeDataSharesRequest.Builder> describeDataSharesRequest)
Shows the status of any inbound or outbound datashares available in the specified account.
|
default DescribeDataSharesResponse |
describeDataShares(DescribeDataSharesRequest describeDataSharesRequest)
Shows the status of any inbound or outbound datashares available in the specified account.
|
default DescribeDataSharesForConsumerResponse |
describeDataSharesForConsumer(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest)
Returns a list of datashares where the account identifier being called is a consumer account identifier.
|
default DescribeDataSharesForConsumerResponse |
describeDataSharesForConsumer(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest)
Returns a list of datashares where the account identifier being called is a consumer account identifier.
|
default DescribeDataSharesForConsumerIterable |
describeDataSharesForConsumerPaginator(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest)
Returns a list of datashares where the account identifier being called is a consumer account identifier.
|
default DescribeDataSharesForConsumerIterable |
describeDataSharesForConsumerPaginator(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest)
Returns a list of datashares where the account identifier being called is a consumer account identifier.
|
default DescribeDataSharesForProducerResponse |
describeDataSharesForProducer(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest)
Returns a list of datashares when the account identifier being called is a producer account identifier.
|
default DescribeDataSharesForProducerResponse |
describeDataSharesForProducer(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest)
Returns a list of datashares when the account identifier being called is a producer account identifier.
|
default DescribeDataSharesForProducerIterable |
describeDataSharesForProducerPaginator(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest)
Returns a list of datashares when the account identifier being called is a producer account identifier.
|
default DescribeDataSharesForProducerIterable |
describeDataSharesForProducerPaginator(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest)
Returns a list of datashares when the account identifier being called is a producer account identifier.
|
default DescribeDataSharesIterable |
describeDataSharesPaginator(Consumer<DescribeDataSharesRequest.Builder> describeDataSharesRequest)
Shows the status of any inbound or outbound datashares available in the specified account.
|
default DescribeDataSharesIterable |
describeDataSharesPaginator(DescribeDataSharesRequest describeDataSharesRequest)
Shows the status of any inbound or outbound datashares available in the specified account.
|
default DescribeDefaultClusterParametersResponse |
describeDefaultClusterParameters(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default DescribeDefaultClusterParametersResponse |
describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default DescribeDefaultClusterParametersIterable |
describeDefaultClusterParametersPaginator(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default DescribeDefaultClusterParametersIterable |
describeDefaultClusterParametersPaginator(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default DescribeEndpointAccessResponse |
describeEndpointAccess(Consumer<DescribeEndpointAccessRequest.Builder> describeEndpointAccessRequest)
Describes a Redshift-managed VPC endpoint.
|
default DescribeEndpointAccessResponse |
describeEndpointAccess(DescribeEndpointAccessRequest describeEndpointAccessRequest)
Describes a Redshift-managed VPC endpoint.
|
default DescribeEndpointAccessIterable |
describeEndpointAccessPaginator(Consumer<DescribeEndpointAccessRequest.Builder> describeEndpointAccessRequest)
Describes a Redshift-managed VPC endpoint.
|
default DescribeEndpointAccessIterable |
describeEndpointAccessPaginator(DescribeEndpointAccessRequest describeEndpointAccessRequest)
Describes a Redshift-managed VPC endpoint.
|
default DescribeEndpointAuthorizationResponse |
describeEndpointAuthorization(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest)
Describes an endpoint authorization.
|
default DescribeEndpointAuthorizationResponse |
describeEndpointAuthorization(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest)
Describes an endpoint authorization.
|
default DescribeEndpointAuthorizationIterable |
describeEndpointAuthorizationPaginator(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest)
Describes an endpoint authorization.
|
default DescribeEndpointAuthorizationIterable |
describeEndpointAuthorizationPaginator(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest)
Describes an endpoint authorization.
|
default DescribeEventCategoriesResponse |
describeEventCategories()
Displays a list of event categories for all event source types, or for a specified source type.
|
default DescribeEventCategoriesResponse |
describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest)
Displays a list of event categories for all event source types, or for a specified source type.
|
default DescribeEventCategoriesResponse |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of event categories for all event source types, or for a specified source type.
|
default DescribeEventsResponse |
describeEvents()
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsResponse |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsIterable |
describeEventsPaginator()
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsIterable |
describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsIterable |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions()
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator()
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeHsmClientCertificatesResponse |
describeHsmClientCertificates()
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesResponse |
describeHsmClientCertificates(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesResponse |
describeHsmClientCertificates(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesIterable |
describeHsmClientCertificatesPaginator()
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesIterable |
describeHsmClientCertificatesPaginator(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesIterable |
describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default DescribeHsmConfigurationsResponse |
describeHsmConfigurations()
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsResponse |
describeHsmConfigurations(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsResponse |
describeHsmConfigurations(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsIterable |
describeHsmConfigurationsPaginator()
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsIterable |
describeHsmConfigurationsPaginator(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsIterable |
describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeInboundIntegrationsResponse |
describeInboundIntegrations(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest)
Returns a list of inbound integrations.
|
default DescribeInboundIntegrationsResponse |
describeInboundIntegrations(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest)
Returns a list of inbound integrations.
|
default DescribeInboundIntegrationsIterable |
describeInboundIntegrationsPaginator(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest)
Returns a list of inbound integrations.
|
default DescribeInboundIntegrationsIterable |
describeInboundIntegrationsPaginator(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest)
Returns a list of inbound integrations.
|
default DescribeLoggingStatusResponse |
describeLoggingStatus(Consumer<DescribeLoggingStatusRequest.Builder> describeLoggingStatusRequest)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon
Redshift cluster.
|
default DescribeLoggingStatusResponse |
describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon
Redshift cluster.
|
default 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.
|
default 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.
|
default DescribeNodeConfigurationOptionsIterable |
describeNodeConfigurationOptionsPaginator(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.
|
default DescribeNodeConfigurationOptionsIterable |
describeNodeConfigurationOptionsPaginator(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest)
Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the
specified action type.
|
default DescribeOrderableClusterOptionsResponse |
describeOrderableClusterOptions()
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsResponse |
describeOrderableClusterOptions(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsResponse |
describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsIterable |
describeOrderableClusterOptionsPaginator()
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsIterable |
describeOrderableClusterOptionsPaginator(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsIterable |
describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default DescribePartnersResponse |
describePartners(Consumer<DescribePartnersRequest.Builder> describePartnersRequest)
Returns information about the partner integrations defined for a cluster.
|
default DescribePartnersResponse |
describePartners(DescribePartnersRequest describePartnersRequest)
Returns information about the partner integrations defined for a cluster.
|
default DescribeReservedNodeExchangeStatusResponse |
describeReservedNodeExchangeStatus(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest)
Returns exchange status details and associated metadata for a reserved-node exchange.
|
default DescribeReservedNodeExchangeStatusResponse |
describeReservedNodeExchangeStatus(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest)
Returns exchange status details and associated metadata for a reserved-node exchange.
|
default DescribeReservedNodeExchangeStatusIterable |
describeReservedNodeExchangeStatusPaginator(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest)
Returns exchange status details and associated metadata for a reserved-node exchange.
|
default DescribeReservedNodeExchangeStatusIterable |
describeReservedNodeExchangeStatusPaginator(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest)
Returns exchange status details and associated metadata for a reserved-node exchange.
|
default DescribeReservedNodeOfferingsResponse |
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.
|
default 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.
|
default 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.
|
default DescribeReservedNodeOfferingsIterable |
describeReservedNodeOfferingsPaginator()
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.
|
default DescribeReservedNodeOfferingsIterable |
describeReservedNodeOfferingsPaginator(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.
|
default DescribeReservedNodeOfferingsIterable |
describeReservedNodeOfferingsPaginator(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.
|
default DescribeReservedNodesResponse |
describeReservedNodes()
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesResponse |
describeReservedNodes(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesResponse |
describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesIterable |
describeReservedNodesPaginator()
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesIterable |
describeReservedNodesPaginator(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesIterable |
describeReservedNodesPaginator(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default DescribeResizeResponse |
describeResize(Consumer<DescribeResizeRequest.Builder> describeResizeRequest)
Returns information about the last resize operation for the specified cluster.
|
default DescribeResizeResponse |
describeResize(DescribeResizeRequest describeResizeRequest)
Returns information about the last resize operation for the specified cluster.
|
default DescribeScheduledActionsResponse |
describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)
Describes properties of scheduled actions.
|
default DescribeScheduledActionsResponse |
describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Describes properties of scheduled actions.
|
default DescribeScheduledActionsIterable |
describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)
Describes properties of scheduled actions.
|
default DescribeScheduledActionsIterable |
describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Describes properties of scheduled actions.
|
default DescribeSnapshotCopyGrantsResponse |
describeSnapshotCopyGrants()
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
|
default DescribeSnapshotCopyGrantsResponse |
describeSnapshotCopyGrants(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
|
default DescribeSnapshotCopyGrantsResponse |
describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
|
default DescribeSnapshotCopyGrantsIterable |
describeSnapshotCopyGrantsPaginator()
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
|
default DescribeSnapshotCopyGrantsIterable |
describeSnapshotCopyGrantsPaginator(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
|
default DescribeSnapshotCopyGrantsIterable |
describeSnapshotCopyGrantsPaginator(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
|
default DescribeSnapshotSchedulesResponse |
describeSnapshotSchedules()
Returns a list of snapshot schedules.
|
default DescribeSnapshotSchedulesResponse |
describeSnapshotSchedules(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest)
Returns a list of snapshot schedules.
|
default DescribeSnapshotSchedulesResponse |
describeSnapshotSchedules(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest)
Returns a list of snapshot schedules.
|
default DescribeSnapshotSchedulesIterable |
describeSnapshotSchedulesPaginator()
Returns a list of snapshot schedules.
|
default DescribeSnapshotSchedulesIterable |
describeSnapshotSchedulesPaginator(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest)
Returns a list of snapshot schedules.
|
default DescribeSnapshotSchedulesIterable |
describeSnapshotSchedulesPaginator(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest)
Returns a list of snapshot schedules.
|
default DescribeStorageResponse |
describeStorage()
Returns account level backups storage size and provisional storage.
|
default DescribeStorageResponse |
describeStorage(Consumer<DescribeStorageRequest.Builder> describeStorageRequest)
Returns account level backups storage size and provisional storage.
|
default DescribeStorageResponse |
describeStorage(DescribeStorageRequest describeStorageRequest)
Returns account level backups storage size and provisional storage.
|
default DescribeTableRestoreStatusResponse |
describeTableRestoreStatus(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
default DescribeTableRestoreStatusResponse |
describeTableRestoreStatus(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
default DescribeTableRestoreStatusIterable |
describeTableRestoreStatusPaginator(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
default DescribeTableRestoreStatusIterable |
describeTableRestoreStatusPaginator(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
default DescribeTagsResponse |
describeTags()
Returns a list of tags.
|
default DescribeTagsResponse |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Returns a list of tags.
|
default DescribeTagsResponse |
describeTags(DescribeTagsRequest describeTagsRequest)
Returns a list of tags.
|
default DescribeTagsIterable |
describeTagsPaginator()
Returns a list of tags.
|
default DescribeTagsIterable |
describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Returns a list of tags.
|
default DescribeTagsIterable |
describeTagsPaginator(DescribeTagsRequest describeTagsRequest)
Returns a list of tags.
|
default DescribeUsageLimitsResponse |
describeUsageLimits(Consumer<DescribeUsageLimitsRequest.Builder> describeUsageLimitsRequest)
Shows usage limits on a cluster.
|
default DescribeUsageLimitsResponse |
describeUsageLimits(DescribeUsageLimitsRequest describeUsageLimitsRequest)
Shows usage limits on a cluster.
|
default DescribeUsageLimitsIterable |
describeUsageLimitsPaginator(Consumer<DescribeUsageLimitsRequest.Builder> describeUsageLimitsRequest)
Shows usage limits on a cluster.
|
default DescribeUsageLimitsIterable |
describeUsageLimitsPaginator(DescribeUsageLimitsRequest describeUsageLimitsRequest)
Shows usage limits on a cluster.
|
default DisableLoggingResponse |
disableLogging(Consumer<DisableLoggingRequest.Builder> disableLoggingRequest)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default DisableLoggingResponse |
disableLogging(DisableLoggingRequest disableLoggingRequest)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default DisableSnapshotCopyResponse |
disableSnapshotCopy(Consumer<DisableSnapshotCopyRequest.Builder> disableSnapshotCopyRequest)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
|
default DisableSnapshotCopyResponse |
disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
|
default DisassociateDataShareConsumerResponse |
disassociateDataShareConsumer(Consumer<DisassociateDataShareConsumerRequest.Builder> disassociateDataShareConsumerRequest)
From a datashare consumer account, remove association for the specified datashare.
|
default DisassociateDataShareConsumerResponse |
disassociateDataShareConsumer(DisassociateDataShareConsumerRequest disassociateDataShareConsumerRequest)
From a datashare consumer account, remove association for the specified datashare.
|
default EnableLoggingResponse |
enableLogging(Consumer<EnableLoggingRequest.Builder> enableLoggingRequest)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default EnableLoggingResponse |
enableLogging(EnableLoggingRequest enableLoggingRequest)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default EnableSnapshotCopyResponse |
enableSnapshotCopy(Consumer<EnableSnapshotCopyRequest.Builder> enableSnapshotCopyRequest)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
|
default EnableSnapshotCopyResponse |
enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
|
default 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.
|
default GetClusterCredentialsResponse |
getClusterCredentials(GetClusterCredentialsRequest getClusterCredentialsRequest)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database.
|
default 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.
|
default GetClusterCredentialsWithIamResponse |
getClusterCredentialsWithIAM(GetClusterCredentialsWithIamRequest getClusterCredentialsWithIamRequest)
Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift
database.
|
default GetReservedNodeExchangeConfigurationOptionsResponse |
getReservedNodeExchangeConfigurationOptions(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest)
Gets the configuration options for the reserved-node exchange.
|
default GetReservedNodeExchangeConfigurationOptionsResponse |
getReservedNodeExchangeConfigurationOptions(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest)
Gets the configuration options for the reserved-node exchange.
|
default GetReservedNodeExchangeConfigurationOptionsIterable |
getReservedNodeExchangeConfigurationOptionsPaginator(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest)
Gets the configuration options for the reserved-node exchange.
|
default GetReservedNodeExchangeConfigurationOptionsIterable |
getReservedNodeExchangeConfigurationOptionsPaginator(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest)
Gets the configuration options for the reserved-node exchange.
|
default 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.
|
default 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.
|
default GetReservedNodeExchangeOfferingsIterable |
getReservedNodeExchangeOfferingsPaginator(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.
|
default GetReservedNodeExchangeOfferingsIterable |
getReservedNodeExchangeOfferingsPaginator(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest)
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given
DC1 reserved node.
|
default GetResourcePolicyResponse |
getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
Get the resource policy for a specified resource.
|
default GetResourcePolicyResponse |
getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Get the resource policy for a specified resource.
|
default ModifyAquaConfigurationResponse |
modifyAquaConfiguration(Consumer<ModifyAquaConfigurationRequest.Builder> modifyAquaConfigurationRequest)
This operation is retired.
|
default ModifyAquaConfigurationResponse |
modifyAquaConfiguration(ModifyAquaConfigurationRequest modifyAquaConfigurationRequest)
This operation is retired.
|
default ModifyAuthenticationProfileResponse |
modifyAuthenticationProfile(Consumer<ModifyAuthenticationProfileRequest.Builder> modifyAuthenticationProfileRequest)
Modifies an authentication profile.
|
default ModifyAuthenticationProfileResponse |
modifyAuthenticationProfile(ModifyAuthenticationProfileRequest modifyAuthenticationProfileRequest)
Modifies an authentication profile.
|
default ModifyClusterResponse |
modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest)
Modifies the settings for a cluster.
|
default ModifyClusterResponse |
modifyCluster(ModifyClusterRequest modifyClusterRequest)
Modifies the settings for a cluster.
|
default ModifyClusterDbRevisionResponse |
modifyClusterDbRevision(Consumer<ModifyClusterDbRevisionRequest.Builder> modifyClusterDbRevisionRequest)
Modifies the database revision of a cluster.
|
default ModifyClusterDbRevisionResponse |
modifyClusterDbRevision(ModifyClusterDbRevisionRequest modifyClusterDbRevisionRequest)
Modifies the database revision of a cluster.
|
default 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.
|
default 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.
|
default ModifyClusterMaintenanceResponse |
modifyClusterMaintenance(Consumer<ModifyClusterMaintenanceRequest.Builder> modifyClusterMaintenanceRequest)
Modifies the maintenance settings of a cluster.
|
default ModifyClusterMaintenanceResponse |
modifyClusterMaintenance(ModifyClusterMaintenanceRequest modifyClusterMaintenanceRequest)
Modifies the maintenance settings of a cluster.
|
default ModifyClusterParameterGroupResponse |
modifyClusterParameterGroup(Consumer<ModifyClusterParameterGroupRequest.Builder> modifyClusterParameterGroupRequest)
Modifies the parameters of a parameter group.
|
default ModifyClusterParameterGroupResponse |
modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest)
Modifies the parameters of a parameter group.
|
default ModifyClusterSnapshotResponse |
modifyClusterSnapshot(Consumer<ModifyClusterSnapshotRequest.Builder> modifyClusterSnapshotRequest)
Modifies the settings for a snapshot.
|
default ModifyClusterSnapshotResponse |
modifyClusterSnapshot(ModifyClusterSnapshotRequest modifyClusterSnapshotRequest)
Modifies the settings for a snapshot.
|
default ModifyClusterSnapshotScheduleResponse |
modifyClusterSnapshotSchedule(Consumer<ModifyClusterSnapshotScheduleRequest.Builder> modifyClusterSnapshotScheduleRequest)
Modifies a snapshot schedule for a cluster.
|
default ModifyClusterSnapshotScheduleResponse |
modifyClusterSnapshotSchedule(ModifyClusterSnapshotScheduleRequest modifyClusterSnapshotScheduleRequest)
Modifies a snapshot schedule for a cluster.
|
default ModifyClusterSubnetGroupResponse |
modifyClusterSubnetGroup(Consumer<ModifyClusterSubnetGroupRequest.Builder> modifyClusterSubnetGroupRequest)
Modifies a cluster subnet group to include the specified list of VPC subnets.
|
default ModifyClusterSubnetGroupResponse |
modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest)
Modifies a cluster subnet group to include the specified list of VPC subnets.
|
default ModifyCustomDomainAssociationResponse |
modifyCustomDomainAssociation(Consumer<ModifyCustomDomainAssociationRequest.Builder> modifyCustomDomainAssociationRequest)
Contains information for changing a custom domain association.
|
default ModifyCustomDomainAssociationResponse |
modifyCustomDomainAssociation(ModifyCustomDomainAssociationRequest modifyCustomDomainAssociationRequest)
Contains information for changing a custom domain association.
|
default ModifyEndpointAccessResponse |
modifyEndpointAccess(Consumer<ModifyEndpointAccessRequest.Builder> modifyEndpointAccessRequest)
Modifies a Redshift-managed VPC endpoint.
|
default ModifyEndpointAccessResponse |
modifyEndpointAccess(ModifyEndpointAccessRequest modifyEndpointAccessRequest)
Modifies a Redshift-managed VPC endpoint.
|
default ModifyEventSubscriptionResponse |
modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest)
Modifies an existing Amazon Redshift event notification subscription.
|
default ModifyEventSubscriptionResponse |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing Amazon Redshift event notification subscription.
|
default ModifyScheduledActionResponse |
modifyScheduledAction(Consumer<ModifyScheduledActionRequest.Builder> modifyScheduledActionRequest)
Modifies a scheduled action.
|
default ModifyScheduledActionResponse |
modifyScheduledAction(ModifyScheduledActionRequest modifyScheduledActionRequest)
Modifies a scheduled action.
|
default 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.
|
default 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.
|
default ModifySnapshotScheduleResponse |
modifySnapshotSchedule(Consumer<ModifySnapshotScheduleRequest.Builder> modifySnapshotScheduleRequest)
Modifies a snapshot schedule.
|
default ModifySnapshotScheduleResponse |
modifySnapshotSchedule(ModifySnapshotScheduleRequest modifySnapshotScheduleRequest)
Modifies a snapshot schedule.
|
default ModifyUsageLimitResponse |
modifyUsageLimit(Consumer<ModifyUsageLimitRequest.Builder> modifyUsageLimitRequest)
Modifies a usage limit in a cluster.
|
default ModifyUsageLimitResponse |
modifyUsageLimit(ModifyUsageLimitRequest modifyUsageLimitRequest)
Modifies a usage limit in a cluster.
|
default PauseClusterResponse |
pauseCluster(Consumer<PauseClusterRequest.Builder> pauseClusterRequest)
Pauses a cluster.
|
default PauseClusterResponse |
pauseCluster(PauseClusterRequest pauseClusterRequest)
Pauses a cluster.
|
default PurchaseReservedNodeOfferingResponse |
purchaseReservedNodeOffering(Consumer<PurchaseReservedNodeOfferingRequest.Builder> purchaseReservedNodeOfferingRequest)
Allows you to purchase reserved nodes.
|
default PurchaseReservedNodeOfferingResponse |
purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest)
Allows you to purchase reserved nodes.
|
default PutResourcePolicyResponse |
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Updates the resource policy for a specified resource.
|
default PutResourcePolicyResponse |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Updates the resource policy for a specified resource.
|
default RebootClusterResponse |
rebootCluster(Consumer<RebootClusterRequest.Builder> rebootClusterRequest)
Reboots a cluster.
|
default RebootClusterResponse |
rebootCluster(RebootClusterRequest rebootClusterRequest)
Reboots a cluster.
|
default RejectDataShareResponse |
rejectDataShare(Consumer<RejectDataShareRequest.Builder> rejectDataShareRequest)
From a datashare consumer account, rejects the specified datashare.
|
default RejectDataShareResponse |
rejectDataShare(RejectDataShareRequest rejectDataShareRequest)
From a datashare consumer account, rejects the specified datashare.
|
default 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".
|
default 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".
|
default ResizeClusterResponse |
resizeCluster(Consumer<ResizeClusterRequest.Builder> resizeClusterRequest)
Changes the size of the cluster.
|
default ResizeClusterResponse |
resizeCluster(ResizeClusterRequest resizeClusterRequest)
Changes the size of the cluster.
|
default RestoreFromClusterSnapshotResponse |
restoreFromClusterSnapshot(Consumer<RestoreFromClusterSnapshotRequest.Builder> restoreFromClusterSnapshotRequest)
Creates a new cluster from a snapshot.
|
default RestoreFromClusterSnapshotResponse |
restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest)
Creates a new cluster from a snapshot.
|
default RestoreTableFromClusterSnapshotResponse |
restoreTableFromClusterSnapshot(Consumer<RestoreTableFromClusterSnapshotRequest.Builder> restoreTableFromClusterSnapshotRequest)
Creates a new table from a table in an Amazon Redshift cluster snapshot.
|
default RestoreTableFromClusterSnapshotResponse |
restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest)
Creates a new table from a table in an Amazon Redshift cluster snapshot.
|
default ResumeClusterResponse |
resumeCluster(Consumer<ResumeClusterRequest.Builder> resumeClusterRequest)
Resumes a paused cluster.
|
default ResumeClusterResponse |
resumeCluster(ResumeClusterRequest resumeClusterRequest)
Resumes a paused cluster.
|
default 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.
|
default 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.
|
default RevokeEndpointAccessResponse |
revokeEndpointAccess(Consumer<RevokeEndpointAccessRequest.Builder> revokeEndpointAccessRequest)
Revokes access to a cluster.
|
default RevokeEndpointAccessResponse |
revokeEndpointAccess(RevokeEndpointAccessRequest revokeEndpointAccessRequest)
Revokes access to a cluster.
|
default RevokeSnapshotAccessResponse |
revokeSnapshotAccess(Consumer<RevokeSnapshotAccessRequest.Builder> revokeSnapshotAccessRequest)
Removes the ability of the specified Amazon Web Services account to restore the specified snapshot.
|
default RevokeSnapshotAccessResponse |
revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest)
Removes the ability of the specified Amazon Web Services account to restore the specified snapshot.
|
default RotateEncryptionKeyResponse |
rotateEncryptionKey(Consumer<RotateEncryptionKeyRequest.Builder> rotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.
|
default RotateEncryptionKeyResponse |
rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.
|
default RedshiftServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default UpdatePartnerStatusResponse |
updatePartnerStatus(Consumer<UpdatePartnerStatusRequest.Builder> updatePartnerStatusRequest)
Updates the status of a partner integration.
|
default UpdatePartnerStatusResponse |
updatePartnerStatus(UpdatePartnerStatusRequest updatePartnerStatusRequest)
Updates the status of a partner integration.
|
default RedshiftWaiter |
waiter()
Create an instance of
RedshiftWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AcceptReservedNodeExchangeResponse acceptReservedNodeExchange(AcceptReservedNodeExchangeRequest acceptReservedNodeExchangeRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, ReservedNodeAlreadyExistsException, AwsServiceException, SdkClientException, RedshiftException
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.
acceptReservedNodeExchangeRequest - 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.AwsServiceExceptiondefault AcceptReservedNodeExchangeResponse acceptReservedNodeExchange(Consumer<AcceptReservedNodeExchangeRequest.Builder> acceptReservedNodeExchangeRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, ReservedNodeAlreadyExistsException, AwsServiceException, SdkClientException, RedshiftException
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 via AcceptReservedNodeExchangeRequest.builder()
acceptReservedNodeExchangeRequest - A Consumer that will call methods on
AcceptReservedNodeExchangeRequest.Builder to create
a request.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.AwsServiceExceptiondefault AddPartnerResponse addPartner(AddPartnerRequest addPartnerRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, AwsServiceException, SdkClientException, RedshiftException
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.
addPartnerRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddPartnerResponse addPartner(Consumer<AddPartnerRequest.Builder> addPartnerRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, AwsServiceException, SdkClientException, RedshiftException
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 via AddPartnerRequest.builder()
addPartnerRequest - A Consumer that will call methods on
AddPartnerRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateDataShareConsumerResponse associateDataShareConsumer(AssociateDataShareConsumerRequest associateDataShareConsumerRequest) throws InvalidDataShareException, InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.
associateDataShareConsumerRequest - InvalidDataShareException - There is an error with the datashare.InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateDataShareConsumerResponse associateDataShareConsumer(Consumer<AssociateDataShareConsumerRequest.Builder> associateDataShareConsumerRequest) throws InvalidDataShareException, InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.
This is a convenience which creates an instance of the AssociateDataShareConsumerRequest.Builder avoiding
the need to create one manually via AssociateDataShareConsumerRequest.builder()
associateDataShareConsumerRequest - A Consumer that will call methods on
AssociateDataShareConsumerRequest.Builder to create
a request.InvalidDataShareException - There is an error with the datashare.InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AuthorizeClusterSecurityGroupIngressResponse authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest) throws ClusterSecurityGroupNotFoundException, InvalidClusterSecurityGroupStateException, AuthorizationAlreadyExistsException, AuthorizationQuotaExceededException, AwsServiceException, SdkClientException, RedshiftException
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.
authorizeClusterSecurityGroupIngressRequest - 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.AwsServiceExceptiondefault AuthorizeClusterSecurityGroupIngressResponse authorizeClusterSecurityGroupIngress(Consumer<AuthorizeClusterSecurityGroupIngressRequest.Builder> authorizeClusterSecurityGroupIngressRequest) throws ClusterSecurityGroupNotFoundException, InvalidClusterSecurityGroupStateException, AuthorizationAlreadyExistsException, AuthorizationQuotaExceededException, AwsServiceException, SdkClientException, RedshiftException
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 via
AuthorizeClusterSecurityGroupIngressRequest.builder()
authorizeClusterSecurityGroupIngressRequest - A Consumer that will call methods on
AuthorizeClusterSecurityGroupIngressRequest.Builder
to create a request.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.AwsServiceExceptiondefault AuthorizeDataShareResponse authorizeDataShare(AuthorizeDataShareRequest authorizeDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access permissions.
authorizeDataShareRequest - InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AuthorizeDataShareResponse authorizeDataShare(Consumer<AuthorizeDataShareRequest.Builder> authorizeDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access permissions.
This is a convenience which creates an instance of the AuthorizeDataShareRequest.Builder avoiding the
need to create one manually via AuthorizeDataShareRequest.builder()
authorizeDataShareRequest - A Consumer that will call methods on
AuthorizeDataShareRequest.Builder to create a
request.InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AuthorizeEndpointAccessResponse authorizeEndpointAccess(AuthorizeEndpointAccessRequest authorizeEndpointAccessRequest) throws ClusterNotFoundException, EndpointAuthorizationsPerClusterLimitExceededException, UnsupportedOperationException, EndpointAuthorizationAlreadyExistsException, InvalidAuthorizationStateException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Grants access to a cluster.
authorizeEndpointAccessRequest - 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.AwsServiceExceptiondefault AuthorizeEndpointAccessResponse authorizeEndpointAccess(Consumer<AuthorizeEndpointAccessRequest.Builder> authorizeEndpointAccessRequest) throws ClusterNotFoundException, EndpointAuthorizationsPerClusterLimitExceededException, UnsupportedOperationException, EndpointAuthorizationAlreadyExistsException, InvalidAuthorizationStateException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Grants access to a cluster.
This is a convenience which creates an instance of the AuthorizeEndpointAccessRequest.Builder avoiding
the need to create one manually via AuthorizeEndpointAccessRequest.builder()
authorizeEndpointAccessRequest - A Consumer that will call methods on
AuthorizeEndpointAccessRequest.Builder to create a
request.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.AwsServiceExceptiondefault AuthorizeSnapshotAccessResponse authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest) throws ClusterSnapshotNotFoundException, AuthorizationAlreadyExistsException, AuthorizationQuotaExceededException, DependentServiceRequestThrottlingException, InvalidClusterSnapshotStateException, LimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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.
authorizeSnapshotAccessRequest - 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.AwsServiceExceptiondefault AuthorizeSnapshotAccessResponse authorizeSnapshotAccess(Consumer<AuthorizeSnapshotAccessRequest.Builder> authorizeSnapshotAccessRequest) throws ClusterSnapshotNotFoundException, AuthorizationAlreadyExistsException, AuthorizationQuotaExceededException, DependentServiceRequestThrottlingException, InvalidClusterSnapshotStateException, LimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via AuthorizeSnapshotAccessRequest.builder()
authorizeSnapshotAccessRequest - A Consumer that will call methods on
AuthorizeSnapshotAccessRequest.Builder to create a
request.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.AwsServiceExceptiondefault BatchDeleteClusterSnapshotsResponse batchDeleteClusterSnapshots(BatchDeleteClusterSnapshotsRequest batchDeleteClusterSnapshotsRequest) throws BatchDeleteRequestSizeExceededException, AwsServiceException, SdkClientException, RedshiftException
Deletes a set of cluster snapshots.
batchDeleteClusterSnapshotsRequest - 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.AwsServiceExceptiondefault BatchDeleteClusterSnapshotsResponse batchDeleteClusterSnapshots(Consumer<BatchDeleteClusterSnapshotsRequest.Builder> batchDeleteClusterSnapshotsRequest) throws BatchDeleteRequestSizeExceededException, AwsServiceException, SdkClientException, RedshiftException
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 via BatchDeleteClusterSnapshotsRequest.builder()
batchDeleteClusterSnapshotsRequest - A Consumer that will call methods on
BatchDeleteClusterSnapshotsRequest.Builder to
create a request.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.AwsServiceExceptiondefault BatchModifyClusterSnapshotsResponse batchModifyClusterSnapshots(BatchModifyClusterSnapshotsRequest batchModifyClusterSnapshotsRequest) throws InvalidRetentionPeriodException, BatchModifyClusterSnapshotsLimitExceededException, AwsServiceException, SdkClientException, RedshiftException
Modifies the settings for a set of cluster snapshots.
batchModifyClusterSnapshotsRequest - 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.AwsServiceExceptiondefault BatchModifyClusterSnapshotsResponse batchModifyClusterSnapshots(Consumer<BatchModifyClusterSnapshotsRequest.Builder> batchModifyClusterSnapshotsRequest) throws InvalidRetentionPeriodException, BatchModifyClusterSnapshotsLimitExceededException, AwsServiceException, SdkClientException, RedshiftException
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 via BatchModifyClusterSnapshotsRequest.builder()
batchModifyClusterSnapshotsRequest - A Consumer that will call methods on
BatchModifyClusterSnapshotsRequest.Builder to
create a 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.
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.AwsServiceExceptiondefault CancelResizeResponse cancelResize(CancelResizeRequest cancelResizeRequest) throws ClusterNotFoundException, ResizeNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Cancels a resize operation for a cluster.
cancelResizeRequest - 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.AwsServiceExceptiondefault CancelResizeResponse cancelResize(Consumer<CancelResizeRequest.Builder> cancelResizeRequest) throws ClusterNotFoundException, ResizeNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via CancelResizeRequest.builder()
cancelResizeRequest - A Consumer that will call methods on
CancelResizeRequest.Builder to create a request.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.AwsServiceExceptiondefault CopyClusterSnapshotResponse copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest) throws ClusterSnapshotAlreadyExistsException, ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterSnapshotQuotaExceededException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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.
copyClusterSnapshotRequest - 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.AwsServiceExceptiondefault CopyClusterSnapshotResponse copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest) throws ClusterSnapshotAlreadyExistsException, ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterSnapshotQuotaExceededException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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 via CopyClusterSnapshotRequest.builder()
copyClusterSnapshotRequest - A Consumer that will call methods on
CopyClusterSnapshotRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateAuthenticationProfileResponse createAuthenticationProfile(CreateAuthenticationProfileRequest createAuthenticationProfileRequest) throws AuthenticationProfileAlreadyExistsException, AuthenticationProfileQuotaExceededException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException
Creates an authentication profile with the specified parameters.
createAuthenticationProfileRequest - 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.AwsServiceExceptiondefault CreateAuthenticationProfileResponse createAuthenticationProfile(Consumer<CreateAuthenticationProfileRequest.Builder> createAuthenticationProfileRequest) throws AuthenticationProfileAlreadyExistsException, AuthenticationProfileQuotaExceededException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateAuthenticationProfileRequest.builder()
createAuthenticationProfileRequest - A Consumer that will call methods on
CreateAuthenticationProfileRequest.Builder to
create a request.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.AwsServiceExceptiondefault CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws ClusterAlreadyExistsException, InsufficientClusterCapacityException, ClusterParameterGroupNotFoundException, ClusterSecurityGroupNotFoundException, ClusterQuotaExceededException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, ClusterSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidClusterSubnetGroupStateException, InvalidSubnetException, UnauthorizedOperationException, HsmClientCertificateNotFoundException, HsmConfigurationNotFoundException, InvalidElasticIpException, TagLimitExceededException, InvalidTagException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidClusterTrackException, SnapshotScheduleNotFoundException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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.
createClusterRequest - 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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws ClusterAlreadyExistsException, InsufficientClusterCapacityException, ClusterParameterGroupNotFoundException, ClusterSecurityGroupNotFoundException, ClusterQuotaExceededException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, ClusterSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidClusterSubnetGroupStateException, InvalidSubnetException, UnauthorizedOperationException, HsmClientCertificateNotFoundException, HsmConfigurationNotFoundException, InvalidElasticIpException, TagLimitExceededException, InvalidTagException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidClusterTrackException, SnapshotScheduleNotFoundException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateClusterRequest.builder()
createClusterRequest - A Consumer that will call methods on
CreateClusterRequest.Builder to create a request.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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateClusterParameterGroupResponse createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest) throws ClusterParameterGroupQuotaExceededException, ClusterParameterGroupAlreadyExistsException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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.
createClusterParameterGroupRequest - 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.AwsServiceExceptiondefault CreateClusterParameterGroupResponse createClusterParameterGroup(Consumer<CreateClusterParameterGroupRequest.Builder> createClusterParameterGroupRequest) throws ClusterParameterGroupQuotaExceededException, ClusterParameterGroupAlreadyExistsException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateClusterParameterGroupRequest.builder()
createClusterParameterGroupRequest - A Consumer that will call methods on
CreateClusterParameterGroupRequest.Builder to
create a request.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.AwsServiceExceptiondefault CreateClusterSecurityGroupResponse createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest) throws ClusterSecurityGroupAlreadyExistsException, ClusterSecurityGroupQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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.
createClusterSecurityGroupRequest - 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.AwsServiceExceptiondefault CreateClusterSecurityGroupResponse createClusterSecurityGroup(Consumer<CreateClusterSecurityGroupRequest.Builder> createClusterSecurityGroupRequest) throws ClusterSecurityGroupAlreadyExistsException, ClusterSecurityGroupQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateClusterSecurityGroupRequest.builder()
createClusterSecurityGroupRequest - A Consumer that will call methods on
CreateClusterSecurityGroupRequest.Builder to create
a request.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.AwsServiceExceptiondefault CreateClusterSnapshotResponse createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest) throws ClusterSnapshotAlreadyExistsException, InvalidClusterStateException, ClusterNotFoundException, ClusterSnapshotQuotaExceededException, TagLimitExceededException, InvalidTagException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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.
createClusterSnapshotRequest - 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.AwsServiceExceptiondefault CreateClusterSnapshotResponse createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest) throws ClusterSnapshotAlreadyExistsException, InvalidClusterStateException, ClusterNotFoundException, ClusterSnapshotQuotaExceededException, TagLimitExceededException, InvalidTagException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateClusterSnapshotRequest.builder()
createClusterSnapshotRequest - A Consumer that will call methods on
CreateClusterSnapshotRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateClusterSubnetGroupResponse createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest) throws ClusterSubnetGroupAlreadyExistsException, ClusterSubnetGroupQuotaExceededException, ClusterSubnetQuotaExceededException, InvalidSubnetException, UnauthorizedOperationException, TagLimitExceededException, InvalidTagException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
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.
createClusterSubnetGroupRequest - 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.AwsServiceExceptiondefault CreateClusterSubnetGroupResponse createClusterSubnetGroup(Consumer<CreateClusterSubnetGroupRequest.Builder> createClusterSubnetGroupRequest) throws ClusterSubnetGroupAlreadyExistsException, ClusterSubnetGroupQuotaExceededException, ClusterSubnetQuotaExceededException, InvalidSubnetException, UnauthorizedOperationException, TagLimitExceededException, InvalidTagException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateClusterSubnetGroupRequest.builder()
createClusterSubnetGroupRequest - A Consumer that will call methods on
CreateClusterSubnetGroupRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateCustomDomainAssociationResponse createCustomDomainAssociation(CreateCustomDomainAssociationRequest createCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, AwsServiceException, SdkClientException, RedshiftException
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).
createCustomDomainAssociationRequest - 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.AwsServiceExceptiondefault CreateCustomDomainAssociationResponse createCustomDomainAssociation(Consumer<CreateCustomDomainAssociationRequest.Builder> createCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateCustomDomainAssociationRequest.builder()
createCustomDomainAssociationRequest - A Consumer that will call methods on
CreateCustomDomainAssociationRequest.Builder to
create a request.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.AwsServiceExceptiondefault CreateEndpointAccessResponse createEndpointAccess(CreateEndpointAccessRequest createEndpointAccessRequest) throws ClusterNotFoundException, AccessToClusterDeniedException, EndpointsPerClusterLimitExceededException, EndpointsPerAuthorizationLimitExceededException, InvalidClusterSecurityGroupStateException, ClusterSubnetGroupNotFoundException, EndpointAlreadyExistsException, UnsupportedOperationException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Creates a Redshift-managed VPC endpoint.
createEndpointAccessRequest - 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.AwsServiceExceptiondefault CreateEndpointAccessResponse createEndpointAccess(Consumer<CreateEndpointAccessRequest.Builder> createEndpointAccessRequest) throws ClusterNotFoundException, AccessToClusterDeniedException, EndpointsPerClusterLimitExceededException, EndpointsPerAuthorizationLimitExceededException, InvalidClusterSecurityGroupStateException, ClusterSubnetGroupNotFoundException, EndpointAlreadyExistsException, UnsupportedOperationException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateEndpointAccessRequest.builder()
createEndpointAccessRequest - A Consumer that will call methods on
CreateEndpointAccessRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionEventIdNotFoundException, SubscriptionCategoryNotFoundException, SubscriptionSeverityNotFoundException, SourceNotFoundException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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.
createEventSubscriptionRequest - 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.AwsServiceExceptiondefault CreateEventSubscriptionResponse createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionEventIdNotFoundException, SubscriptionCategoryNotFoundException, SubscriptionSeverityNotFoundException, SourceNotFoundException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateEventSubscriptionRequest.builder()
createEventSubscriptionRequest - A Consumer that will call methods on
CreateEventSubscriptionRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateHsmClientCertificateResponse createHsmClientCertificate(CreateHsmClientCertificateRequest createHsmClientCertificateRequest) throws HsmClientCertificateAlreadyExistsException, HsmClientCertificateQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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.
createHsmClientCertificateRequest - 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.AwsServiceExceptiondefault CreateHsmClientCertificateResponse createHsmClientCertificate(Consumer<CreateHsmClientCertificateRequest.Builder> createHsmClientCertificateRequest) throws HsmClientCertificateAlreadyExistsException, HsmClientCertificateQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateHsmClientCertificateRequest.builder()
createHsmClientCertificateRequest - A Consumer that will call methods on
CreateHsmClientCertificateRequest.Builder to create
a request.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.AwsServiceExceptiondefault CreateHsmConfigurationResponse createHsmConfiguration(CreateHsmConfigurationRequest createHsmConfigurationRequest) throws HsmConfigurationAlreadyExistsException, HsmConfigurationQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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.
createHsmConfigurationRequest - 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.AwsServiceExceptiondefault CreateHsmConfigurationResponse createHsmConfiguration(Consumer<CreateHsmConfigurationRequest.Builder> createHsmConfigurationRequest) throws HsmConfigurationAlreadyExistsException, HsmConfigurationQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateHsmConfigurationRequest.builder()
createHsmConfigurationRequest - A Consumer that will call methods on
CreateHsmConfigurationRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateScheduledActionResponse createScheduledAction(CreateScheduledActionRequest createScheduledActionRequest) throws ScheduledActionAlreadyExistsException, ScheduledActionQuotaExceededException, ScheduledActionTypeUnsupportedException, InvalidScheduleException, InvalidScheduledActionException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
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.
createScheduledActionRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateScheduledActionResponse createScheduledAction(Consumer<CreateScheduledActionRequest.Builder> createScheduledActionRequest) throws ScheduledActionAlreadyExistsException, ScheduledActionQuotaExceededException, ScheduledActionTypeUnsupportedException, InvalidScheduleException, InvalidScheduledActionException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateScheduledActionRequest.builder()
createScheduledActionRequest - A Consumer that will call methods on
CreateScheduledActionRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSnapshotCopyGrantResponse createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest createSnapshotCopyGrantRequest) throws SnapshotCopyGrantAlreadyExistsException, SnapshotCopyGrantQuotaExceededException, LimitExceededException, TagLimitExceededException, InvalidTagException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
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.
createSnapshotCopyGrantRequest - The result of the CreateSnapshotCopyGrant action.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.AwsServiceExceptiondefault CreateSnapshotCopyGrantResponse createSnapshotCopyGrant(Consumer<CreateSnapshotCopyGrantRequest.Builder> createSnapshotCopyGrantRequest) throws SnapshotCopyGrantAlreadyExistsException, SnapshotCopyGrantQuotaExceededException, LimitExceededException, TagLimitExceededException, InvalidTagException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateSnapshotCopyGrantRequest.builder()
createSnapshotCopyGrantRequest - A Consumer that will call methods on
CreateSnapshotCopyGrantRequest.Builder to create a
request. The result of the CreateSnapshotCopyGrant action.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.AwsServiceExceptiondefault CreateSnapshotScheduleResponse createSnapshotSchedule(CreateSnapshotScheduleRequest createSnapshotScheduleRequest) throws SnapshotScheduleAlreadyExistsException, InvalidScheduleException, SnapshotScheduleQuotaExceededException, TagLimitExceededException, ScheduleDefinitionTypeUnsupportedException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
createSnapshotScheduleRequest - 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.AwsServiceExceptiondefault CreateSnapshotScheduleResponse createSnapshotSchedule(Consumer<CreateSnapshotScheduleRequest.Builder> createSnapshotScheduleRequest) throws SnapshotScheduleAlreadyExistsException, InvalidScheduleException, SnapshotScheduleQuotaExceededException, TagLimitExceededException, ScheduleDefinitionTypeUnsupportedException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateSnapshotScheduleRequest.builder()
createSnapshotScheduleRequest - A Consumer that will call methods on
CreateSnapshotScheduleRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws TagLimitExceededException, ResourceNotFoundException, InvalidTagException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
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.
createTagsRequest - Contains the output from the CreateTags action.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.AwsServiceExceptiondefault CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) throws TagLimitExceededException, ResourceNotFoundException, InvalidTagException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateTagsRequest.builder()
createTagsRequest - A Consumer that will call methods on
CreateTagsRequest.Builder to create a request.
Contains the output from the CreateTags action.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.AwsServiceExceptiondefault CreateUsageLimitResponse createUsageLimit(CreateUsageLimitRequest createUsageLimitRequest) throws ClusterNotFoundException, InvalidClusterStateException, LimitExceededException, UsageLimitAlreadyExistsException, InvalidUsageLimitException, TagLimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
createUsageLimitRequest - 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.AwsServiceExceptiondefault CreateUsageLimitResponse createUsageLimit(Consumer<CreateUsageLimitRequest.Builder> createUsageLimitRequest) throws ClusterNotFoundException, InvalidClusterStateException, LimitExceededException, UsageLimitAlreadyExistsException, InvalidUsageLimitException, TagLimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via CreateUsageLimitRequest.builder()
createUsageLimitRequest - A Consumer that will call methods on
CreateUsageLimitRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeauthorizeDataShareResponse deauthorizeDataShare(DeauthorizeDataShareRequest deauthorizeDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a datashare producer account, removes authorization from the specified datashare.
deauthorizeDataShareRequest - InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeauthorizeDataShareResponse deauthorizeDataShare(Consumer<DeauthorizeDataShareRequest.Builder> deauthorizeDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a datashare producer account, removes authorization from the specified datashare.
This is a convenience which creates an instance of the DeauthorizeDataShareRequest.Builder avoiding the
need to create one manually via DeauthorizeDataShareRequest.builder()
deauthorizeDataShareRequest - A Consumer that will call methods on
DeauthorizeDataShareRequest.Builder to create a
request.InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAuthenticationProfileResponse deleteAuthenticationProfile(DeleteAuthenticationProfileRequest deleteAuthenticationProfileRequest) throws AuthenticationProfileNotFoundException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException
Deletes an authentication profile.
deleteAuthenticationProfileRequest - 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.AwsServiceExceptiondefault DeleteAuthenticationProfileResponse deleteAuthenticationProfile(Consumer<DeleteAuthenticationProfileRequest.Builder> deleteAuthenticationProfileRequest) throws AuthenticationProfileNotFoundException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException
Deletes an authentication profile.
This is a convenience which creates an instance of the DeleteAuthenticationProfileRequest.Builder
avoiding the need to create one manually via DeleteAuthenticationProfileRequest.builder()
deleteAuthenticationProfileRequest - A Consumer that will call methods on
DeleteAuthenticationProfileRequest.Builder to
create a request.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.AwsServiceExceptiondefault DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, ClusterSnapshotAlreadyExistsException, ClusterSnapshotQuotaExceededException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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.
deleteClusterRequest - 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.AwsServiceExceptiondefault DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, ClusterSnapshotAlreadyExistsException, ClusterSnapshotQuotaExceededException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteClusterRequest.builder()
deleteClusterRequest - A Consumer that will call methods on
DeleteClusterRequest.Builder to create a request.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.AwsServiceExceptiondefault DeleteClusterParameterGroupResponse deleteClusterParameterGroup(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest) throws InvalidClusterParameterGroupStateException, ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
deleteClusterParameterGroupRequest - 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.AwsServiceExceptiondefault DeleteClusterParameterGroupResponse deleteClusterParameterGroup(Consumer<DeleteClusterParameterGroupRequest.Builder> deleteClusterParameterGroupRequest) throws InvalidClusterParameterGroupStateException, ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteClusterParameterGroupRequest.builder()
deleteClusterParameterGroupRequest - A Consumer that will call methods on
DeleteClusterParameterGroupRequest.Builder to
create a request.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.AwsServiceExceptiondefault DeleteClusterSecurityGroupResponse deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest) throws InvalidClusterSecurityGroupStateException, ClusterSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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.
deleteClusterSecurityGroupRequest - 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.AwsServiceExceptiondefault DeleteClusterSecurityGroupResponse deleteClusterSecurityGroup(Consumer<DeleteClusterSecurityGroupRequest.Builder> deleteClusterSecurityGroupRequest) throws InvalidClusterSecurityGroupStateException, ClusterSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteClusterSecurityGroupRequest.builder()
deleteClusterSecurityGroupRequest - A Consumer that will call methods on
DeleteClusterSecurityGroupRequest.Builder to create
a request.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.AwsServiceExceptiondefault DeleteClusterSnapshotResponse deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) throws InvalidClusterSnapshotStateException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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.
deleteClusterSnapshotRequest - 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.AwsServiceExceptiondefault DeleteClusterSnapshotResponse deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest) throws InvalidClusterSnapshotStateException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteClusterSnapshotRequest.builder()
deleteClusterSnapshotRequest - A Consumer that will call methods on
DeleteClusterSnapshotRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteClusterSubnetGroupResponse deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest) throws InvalidClusterSubnetGroupStateException, InvalidClusterSubnetStateException, ClusterSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified cluster subnet group.
deleteClusterSubnetGroupRequest - 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.AwsServiceExceptiondefault DeleteClusterSubnetGroupResponse deleteClusterSubnetGroup(Consumer<DeleteClusterSubnetGroupRequest.Builder> deleteClusterSubnetGroupRequest) throws InvalidClusterSubnetGroupStateException, InvalidClusterSubnetStateException, ClusterSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteClusterSubnetGroupRequest.builder()
deleteClusterSubnetGroupRequest - A Consumer that will call methods on
DeleteClusterSubnetGroupRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteCustomDomainAssociationResponse deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest deleteCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, AwsServiceException, SdkClientException, RedshiftException
Contains information about deleting a custom domain association for a cluster.
deleteCustomDomainAssociationRequest - 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.AwsServiceExceptiondefault DeleteCustomDomainAssociationResponse deleteCustomDomainAssociation(Consumer<DeleteCustomDomainAssociationRequest.Builder> deleteCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteCustomDomainAssociationRequest.builder()
deleteCustomDomainAssociationRequest - A Consumer that will call methods on
DeleteCustomDomainAssociationRequest.Builder to
create a request.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.AwsServiceExceptiondefault DeleteEndpointAccessResponse deleteEndpointAccess(DeleteEndpointAccessRequest deleteEndpointAccessRequest) throws ClusterNotFoundException, InvalidEndpointStateException, InvalidClusterSecurityGroupStateException, EndpointNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Deletes a Redshift-managed VPC endpoint.
deleteEndpointAccessRequest - 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.AwsServiceExceptiondefault DeleteEndpointAccessResponse deleteEndpointAccess(Consumer<DeleteEndpointAccessRequest.Builder> deleteEndpointAccessRequest) throws ClusterNotFoundException, InvalidEndpointStateException, InvalidClusterSecurityGroupStateException, EndpointNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteEndpointAccessRequest.builder()
deleteEndpointAccessRequest - A Consumer that will call methods on
DeleteEndpointAccessRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidSubscriptionStateException, AwsServiceException, SdkClientException, RedshiftException
Deletes an Amazon Redshift event notification subscription.
deleteEventSubscriptionRequest - 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.AwsServiceExceptiondefault DeleteEventSubscriptionResponse deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidSubscriptionStateException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteEventSubscriptionRequest.builder()
deleteEventSubscriptionRequest - A Consumer that will call methods on
DeleteEventSubscriptionRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteHsmClientCertificateResponse deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest) throws InvalidHsmClientCertificateStateException, HsmClientCertificateNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified HSM client certificate.
deleteHsmClientCertificateRequest - 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.AwsServiceExceptiondefault DeleteHsmClientCertificateResponse deleteHsmClientCertificate(Consumer<DeleteHsmClientCertificateRequest.Builder> deleteHsmClientCertificateRequest) throws InvalidHsmClientCertificateStateException, HsmClientCertificateNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteHsmClientCertificateRequest.builder()
deleteHsmClientCertificateRequest - A Consumer that will call methods on
DeleteHsmClientCertificateRequest.Builder to create
a request.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.AwsServiceExceptiondefault DeleteHsmConfigurationResponse deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest) throws InvalidHsmConfigurationStateException, HsmConfigurationNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified Amazon Redshift HSM configuration.
deleteHsmConfigurationRequest - 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.AwsServiceExceptiondefault DeleteHsmConfigurationResponse deleteHsmConfiguration(Consumer<DeleteHsmConfigurationRequest.Builder> deleteHsmConfigurationRequest) throws InvalidHsmConfigurationStateException, HsmConfigurationNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteHsmConfigurationRequest.builder()
deleteHsmConfigurationRequest - A Consumer that will call methods on
DeleteHsmConfigurationRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeletePartnerResponse deletePartner(DeletePartnerRequest deletePartnerRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, AwsServiceException, SdkClientException, RedshiftException
Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.
deletePartnerRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePartnerResponse deletePartner(Consumer<DeletePartnerRequest.Builder> deletePartnerRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, AwsServiceException, SdkClientException, RedshiftException
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 via DeletePartnerRequest.builder()
deletePartnerRequest - A Consumer that will call methods on
DeletePartnerRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws ResourceNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Deletes the resource policy for a specified resource.
deleteResourcePolicyRequest - 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.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws ResourceNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteResourcePolicyRequest.builder()
deleteResourcePolicyRequest - A Consumer that will call methods on
DeleteResourcePolicyRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteScheduledActionResponse deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Deletes a scheduled action.
deleteScheduledActionRequest - 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.AwsServiceExceptiondefault DeleteScheduledActionResponse deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Deletes a scheduled action.
This is a convenience which creates an instance of the DeleteScheduledActionRequest.Builder avoiding the
need to create one manually via DeleteScheduledActionRequest.builder()
deleteScheduledActionRequest - A Consumer that will call methods on
DeleteScheduledActionRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteSnapshotCopyGrantResponse deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest) throws InvalidSnapshotCopyGrantStateException, SnapshotCopyGrantNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified snapshot copy grant.
deleteSnapshotCopyGrantRequest - The result of the DeleteSnapshotCopyGrant action.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.AwsServiceExceptiondefault DeleteSnapshotCopyGrantResponse deleteSnapshotCopyGrant(Consumer<DeleteSnapshotCopyGrantRequest.Builder> deleteSnapshotCopyGrantRequest) throws InvalidSnapshotCopyGrantStateException, SnapshotCopyGrantNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteSnapshotCopyGrantRequest.builder()
deleteSnapshotCopyGrantRequest - A Consumer that will call methods on
DeleteSnapshotCopyGrantRequest.Builder to create a
request. The result of the DeleteSnapshotCopyGrant action.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.AwsServiceExceptiondefault DeleteSnapshotScheduleResponse deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest) throws InvalidClusterSnapshotScheduleStateException, SnapshotScheduleNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes a snapshot schedule.
deleteSnapshotScheduleRequest - 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.AwsServiceExceptiondefault DeleteSnapshotScheduleResponse deleteSnapshotSchedule(Consumer<DeleteSnapshotScheduleRequest.Builder> deleteSnapshotScheduleRequest) throws InvalidClusterSnapshotScheduleStateException, SnapshotScheduleNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes a snapshot schedule.
This is a convenience which creates an instance of the DeleteSnapshotScheduleRequest.Builder avoiding the
need to create one manually via DeleteSnapshotScheduleRequest.builder()
deleteSnapshotScheduleRequest - A Consumer that will call methods on
DeleteSnapshotScheduleRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
deleteTagsRequest - Contains the output from the DeleteTags action.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.AwsServiceExceptiondefault DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteTagsRequest.builder()
deleteTagsRequest - A Consumer that will call methods on
DeleteTagsRequest.Builder to create a request.
Contains the output from the DeleteTags action.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.AwsServiceExceptiondefault DeleteUsageLimitResponse deleteUsageLimit(DeleteUsageLimitRequest deleteUsageLimitRequest) throws UsageLimitNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Deletes a usage limit from a cluster.
deleteUsageLimitRequest - 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.AwsServiceExceptiondefault DeleteUsageLimitResponse deleteUsageLimit(Consumer<DeleteUsageLimitRequest.Builder> deleteUsageLimitRequest) throws UsageLimitNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via DeleteUsageLimitRequest.builder()
deleteUsageLimitRequest - A Consumer that will call methods on
DeleteUsageLimitRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeAccountAttributesResponse describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of attributes attached to an account
describeAccountAttributesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccountAttributesResponse describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 via DescribeAccountAttributesRequest.builder()
describeAccountAttributesRequest - A Consumer that will call methods on
DescribeAccountAttributesRequest.Builder to create
a 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.AwsServiceExceptiondefault DescribeAccountAttributesResponse describeAccountAttributes() throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of attributes attached to an account
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeAccountAttributes(DescribeAccountAttributesRequest),
AWS API Documentationdefault DescribeAuthenticationProfilesResponse describeAuthenticationProfiles(DescribeAuthenticationProfilesRequest describeAuthenticationProfilesRequest) throws AuthenticationProfileNotFoundException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException
Describes an authentication profile.
describeAuthenticationProfilesRequest - 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.AwsServiceExceptiondefault DescribeAuthenticationProfilesResponse describeAuthenticationProfiles(Consumer<DescribeAuthenticationProfilesRequest.Builder> describeAuthenticationProfilesRequest) throws AuthenticationProfileNotFoundException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException
Describes an authentication profile.
This is a convenience which creates an instance of the DescribeAuthenticationProfilesRequest.Builder
avoiding the need to create one manually via DescribeAuthenticationProfilesRequest.builder()
describeAuthenticationProfilesRequest - A Consumer that will call methods on
DescribeAuthenticationProfilesRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeClusterDbRevisionsResponse describeClusterDbRevisions(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of ClusterDbRevision objects.
describeClusterDbRevisionsRequest - 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.AwsServiceExceptiondefault DescribeClusterDbRevisionsResponse describeClusterDbRevisions(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeClusterDbRevisionsRequest.builder()
describeClusterDbRevisionsRequest - A Consumer that will call methods on
DescribeClusterDbRevisionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeClusterDbRevisionsResponse describeClusterDbRevisions() throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of ClusterDbRevision objects.
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.AwsServiceExceptiondescribeClusterDbRevisions(DescribeClusterDbRevisionsRequest),
AWS API Documentationdefault DescribeClusterDbRevisionsIterable describeClusterDbRevisionsPaginator() throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of ClusterDbRevision objects.
This is a variant of
describeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client.describeClusterDbRevisionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client
.describeClusterDbRevisionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client.describeClusterDbRevisionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeClusterDbRevisionsPaginator(DescribeClusterDbRevisionsRequest),
AWS API Documentationdefault DescribeClusterDbRevisionsIterable describeClusterDbRevisionsPaginator(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of ClusterDbRevision objects.
This is a variant of
describeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client.describeClusterDbRevisionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client
.describeClusterDbRevisionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client.describeClusterDbRevisionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClusterDbRevisionsRequest - 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.AwsServiceExceptiondefault DescribeClusterDbRevisionsIterable describeClusterDbRevisionsPaginator(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of ClusterDbRevision objects.
This is a variant of
describeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client.describeClusterDbRevisionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client
.describeClusterDbRevisionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client.describeClusterDbRevisionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeClusterDbRevisionsRequest.builder()
describeClusterDbRevisionsRequest - A Consumer that will call methods on
DescribeClusterDbRevisionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeClusterParameterGroupsResponse describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterParameterGroupsRequest - 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.AwsServiceExceptiondefault DescribeClusterParameterGroupsResponse describeClusterParameterGroups(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClusterParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterParameterGroupsRequest.builder()
describeClusterParameterGroupsRequest - A Consumer that will call methods on
DescribeClusterParameterGroupsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeClusterParameterGroupsResponse describeClusterParameterGroups() throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
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.AwsServiceExceptiondescribeClusterParameterGroups(DescribeClusterParameterGroupsRequest),
AWS API Documentationdefault DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator() throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client
.describeClusterParameterGroupsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest),
AWS API Documentationdefault DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client
.describeClusterParameterGroupsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClusterParameterGroupsRequest - 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.AwsServiceExceptiondefault DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client
.describeClusterParameterGroupsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeClusterParameterGroupsRequest.builder()
describeClusterParameterGroupsRequest - A Consumer that will call methods on
DescribeClusterParameterGroupsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeClusterParametersResponse describeClusterParameters(DescribeClusterParametersRequest describeClusterParametersRequest) throws ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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.
describeClusterParametersRequest - 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.AwsServiceExceptiondefault DescribeClusterParametersResponse describeClusterParameters(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) throws ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeClusterParametersRequest.builder()
describeClusterParametersRequest - A Consumer that will call methods on
DescribeClusterParametersRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeClusterParametersIterable describeClusterParametersPaginator(DescribeClusterParametersRequest describeClusterParametersRequest) throws ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client
.describeClusterParametersPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClusterParametersRequest - 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.AwsServiceExceptiondefault DescribeClusterParametersIterable describeClusterParametersPaginator(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) throws ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client
.describeClusterParametersPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeClusterParametersRequest.builder()
describeClusterParametersRequest - A Consumer that will call methods on
DescribeClusterParametersRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeClusterSecurityGroupsResponse describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterSecurityGroupsRequest - 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.AwsServiceExceptiondefault DescribeClusterSecurityGroupsResponse describeClusterSecurityGroups(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClusterSecurityGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterSecurityGroupsRequest.builder()
describeClusterSecurityGroupsRequest - A Consumer that will call methods on
DescribeClusterSecurityGroupsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeClusterSecurityGroupsIterable describeClusterSecurityGroupsPaginator(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client
.describeClusterSecurityGroupsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClusterSecurityGroupsRequest - 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.AwsServiceExceptiondefault DescribeClusterSecurityGroupsIterable describeClusterSecurityGroupsPaginator(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client
.describeClusterSecurityGroupsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeClusterSecurityGroupsRequest.builder()
describeClusterSecurityGroupsRequest - A Consumer that will call methods on
DescribeClusterSecurityGroupsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeClusterSnapshotsResponse describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
describeClusterSnapshotsRequest - 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.AwsServiceExceptiondefault DescribeClusterSnapshotsResponse describeClusterSnapshots(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClusterSnapshotsRequest.Builder avoiding
the need to create one manually via DescribeClusterSnapshotsRequest.builder()
describeClusterSnapshotsRequest - A Consumer that will call methods on
DescribeClusterSnapshotsRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeClusterSnapshotsResponse describeClusterSnapshots() throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
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.AwsServiceExceptiondescribeClusterSnapshots(DescribeClusterSnapshotsRequest),
AWS API Documentationdefault DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator() throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client
.describeClusterSnapshotsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest),
AWS API Documentationdefault DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client
.describeClusterSnapshotsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClusterSnapshotsRequest - 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.AwsServiceExceptiondefault DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client
.describeClusterSnapshotsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeClusterSnapshotsRequest.builder()
describeClusterSnapshotsRequest - A Consumer that will call methods on
DescribeClusterSnapshotsRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeClusterSubnetGroupsResponse describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterSubnetGroupsRequest - 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.AwsServiceExceptiondefault DescribeClusterSubnetGroupsResponse describeClusterSubnetGroups(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClusterSubnetGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterSubnetGroupsRequest.builder()
describeClusterSubnetGroupsRequest - A Consumer that will call methods on
DescribeClusterSubnetGroupsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeClusterSubnetGroupsResponse describeClusterSubnetGroups() throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
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.AwsServiceExceptiondescribeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest),
AWS API Documentationdefault DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator() throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client
.describeClusterSubnetGroupsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest),
AWS API Documentationdefault DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client
.describeClusterSubnetGroupsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClusterSubnetGroupsRequest - 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.AwsServiceExceptiondefault DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client
.describeClusterSubnetGroupsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeClusterSubnetGroupsRequest.builder()
describeClusterSubnetGroupsRequest - A Consumer that will call methods on
DescribeClusterSubnetGroupsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeClusterTracksResponse describeClusterTracks(DescribeClusterTracksRequest describeClusterTracksRequest) throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of all the available maintenance tracks.
describeClusterTracksRequest - 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.AwsServiceExceptiondefault DescribeClusterTracksResponse describeClusterTracks(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest) throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeClusterTracksRequest.builder()
describeClusterTracksRequest - A Consumer that will call methods on
DescribeClusterTracksRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeClusterTracksResponse describeClusterTracks() throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of all the available maintenance tracks.
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.AwsServiceExceptiondescribeClusterTracks(DescribeClusterTracksRequest),
AWS API Documentationdefault DescribeClusterTracksIterable describeClusterTracksPaginator() throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of all the available maintenance tracks.
This is a variant of
describeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client.describeClusterTracksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client
.describeClusterTracksPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterTracksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client.describeClusterTracksPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeClusterTracksPaginator(DescribeClusterTracksRequest),
AWS API Documentationdefault DescribeClusterTracksIterable describeClusterTracksPaginator(DescribeClusterTracksRequest describeClusterTracksRequest) throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of all the available maintenance tracks.
This is a variant of
describeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client.describeClusterTracksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client
.describeClusterTracksPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterTracksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client.describeClusterTracksPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClusterTracksRequest - 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.AwsServiceExceptiondefault DescribeClusterTracksIterable describeClusterTracksPaginator(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest) throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of all the available maintenance tracks.
This is a variant of
describeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client.describeClusterTracksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client
.describeClusterTracksPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterTracksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client.describeClusterTracksPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeClusterTracksRequest.builder()
describeClusterTracksRequest - A Consumer that will call methods on
DescribeClusterTracksRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeClusterVersionsResponse describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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.
describeClusterVersionsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeClusterVersionsResponse describeClusterVersions(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 via DescribeClusterVersionsRequest.builder()
describeClusterVersionsRequest - A Consumer that will call methods on
DescribeClusterVersionsRequest.Builder to create a
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.AwsServiceExceptiondefault DescribeClusterVersionsResponse describeClusterVersions() throws AwsServiceException, SdkClientException, RedshiftException
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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeClusterVersions(DescribeClusterVersionsRequest),
AWS API Documentationdefault DescribeClusterVersionsIterable describeClusterVersionsPaginator() throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client
.describeClusterVersionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeClusterVersionsPaginator(DescribeClusterVersionsRequest),
AWS API Documentationdefault DescribeClusterVersionsIterable describeClusterVersionsPaginator(DescribeClusterVersionsRequest describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client
.describeClusterVersionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClusterVersionsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeClusterVersionsIterable describeClusterVersionsPaginator(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client
.describeClusterVersionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeClusterVersionsRequest.builder()
describeClusterVersionsRequest - A Consumer that will call methods on
DescribeClusterVersionsRequest.Builder to create a
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.AwsServiceExceptiondefault DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
describeClustersRequest - 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.AwsServiceExceptiondefault DescribeClustersResponse describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClustersRequest.Builder avoiding the need
to create one manually via DescribeClustersRequest.builder()
describeClustersRequest - A Consumer that will call methods on
DescribeClustersRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeClustersResponse describeClusters() throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
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.AwsServiceExceptiondescribeClusters(DescribeClustersRequest),
AWS API
Documentationdefault DescribeClustersIterable describeClustersPaginator() throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client
.describeClustersPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeClustersPaginator(DescribeClustersRequest),
AWS API
Documentationdefault DescribeClustersIterable describeClustersPaginator(DescribeClustersRequest describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client
.describeClustersPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClustersRequest - 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.AwsServiceExceptiondefault DescribeClustersIterable describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client
.describeClustersPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeClustersRequest.builder()
describeClustersRequest - A Consumer that will call methods on
DescribeClustersRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeCustomDomainAssociationsResponse describeCustomDomainAssociations(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) throws CustomDomainAssociationNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Contains information about custom domain associations for a cluster.
describeCustomDomainAssociationsRequest - 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.AwsServiceExceptiondefault DescribeCustomDomainAssociationsResponse describeCustomDomainAssociations(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest) throws CustomDomainAssociationNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeCustomDomainAssociationsRequest.builder()
describeCustomDomainAssociationsRequest - A Consumer that will call methods on
DescribeCustomDomainAssociationsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeCustomDomainAssociationsIterable describeCustomDomainAssociationsPaginator(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) throws CustomDomainAssociationNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Contains information about custom domain associations for a cluster.
This is a variant of
describeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsIterable responses = client.describeCustomDomainAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsIterable responses = client
.describeCustomDomainAssociationsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsIterable responses = client.describeCustomDomainAssociationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeCustomDomainAssociationsRequest - 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.AwsServiceExceptiondefault DescribeCustomDomainAssociationsIterable describeCustomDomainAssociationsPaginator(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest) throws CustomDomainAssociationNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Contains information about custom domain associations for a cluster.
This is a variant of
describeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsIterable responses = client.describeCustomDomainAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsIterable responses = client
.describeCustomDomainAssociationsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsIterable responses = client.describeCustomDomainAssociationsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeCustomDomainAssociationsRequest.builder()
describeCustomDomainAssociationsRequest - A Consumer that will call methods on
DescribeCustomDomainAssociationsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeDataSharesResponse describeDataShares(DescribeDataSharesRequest describeDataSharesRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
Shows the status of any inbound or outbound datashares available in the specified account.
describeDataSharesRequest - InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesResponse describeDataShares(Consumer<DescribeDataSharesRequest.Builder> describeDataSharesRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
Shows the status of any inbound or outbound datashares available in the specified account.
This is a convenience which creates an instance of the DescribeDataSharesRequest.Builder avoiding the
need to create one manually via DescribeDataSharesRequest.builder()
describeDataSharesRequest - A Consumer that will call methods on
DescribeDataSharesRequest.Builder to create a
request.InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesIterable describeDataSharesPaginator(DescribeDataSharesRequest describeDataSharesRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
Shows the status of any inbound or outbound datashares available in the specified account.
This is a variant of
describeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client.describeDataSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client
.describeDataSharesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client.describeDataSharesPaginator(request);
responses.iterator().forEachRemaining(....);
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
describeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)
operation.
describeDataSharesRequest - InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesIterable describeDataSharesPaginator(Consumer<DescribeDataSharesRequest.Builder> describeDataSharesRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
Shows the status of any inbound or outbound datashares available in the specified account.
This is a variant of
describeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client.describeDataSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client
.describeDataSharesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client.describeDataSharesPaginator(request);
responses.iterator().forEachRemaining(....);
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
describeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)
operation.
This is a convenience which creates an instance of the DescribeDataSharesRequest.Builder avoiding the
need to create one manually via DescribeDataSharesRequest.builder()
describeDataSharesRequest - A Consumer that will call methods on
DescribeDataSharesRequest.Builder to create a
request.InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesForConsumerResponse describeDataSharesForConsumer(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares where the account identifier being called is a consumer account identifier.
describeDataSharesForConsumerRequest - InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesForConsumerResponse describeDataSharesForConsumer(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares where the account identifier being called is a consumer account identifier.
This is a convenience which creates an instance of the DescribeDataSharesForConsumerRequest.Builder
avoiding the need to create one manually via DescribeDataSharesForConsumerRequest.builder()
describeDataSharesForConsumerRequest - A Consumer that will call methods on
DescribeDataSharesForConsumerRequest.Builder to
create a request.InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesForConsumerIterable describeDataSharesForConsumerPaginator(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares where the account identifier being called is a consumer account identifier.
This is a variant of
describeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client.describeDataSharesForConsumerPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client
.describeDataSharesForConsumerPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client.describeDataSharesForConsumerPaginator(request);
responses.iterator().forEachRemaining(....);
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
describeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)
operation.
describeDataSharesForConsumerRequest - InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesForConsumerIterable describeDataSharesForConsumerPaginator(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares where the account identifier being called is a consumer account identifier.
This is a variant of
describeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client.describeDataSharesForConsumerPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client
.describeDataSharesForConsumerPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client.describeDataSharesForConsumerPaginator(request);
responses.iterator().forEachRemaining(....);
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
describeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)
operation.
This is a convenience which creates an instance of the DescribeDataSharesForConsumerRequest.Builder
avoiding the need to create one manually via DescribeDataSharesForConsumerRequest.builder()
describeDataSharesForConsumerRequest - A Consumer that will call methods on
DescribeDataSharesForConsumerRequest.Builder to
create a request.InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesForProducerResponse describeDataSharesForProducer(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares when the account identifier being called is a producer account identifier.
describeDataSharesForProducerRequest - InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesForProducerResponse describeDataSharesForProducer(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares when the account identifier being called is a producer account identifier.
This is a convenience which creates an instance of the DescribeDataSharesForProducerRequest.Builder
avoiding the need to create one manually via DescribeDataSharesForProducerRequest.builder()
describeDataSharesForProducerRequest - A Consumer that will call methods on
DescribeDataSharesForProducerRequest.Builder to
create a request.InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesForProducerIterable describeDataSharesForProducerPaginator(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares when the account identifier being called is a producer account identifier.
This is a variant of
describeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client.describeDataSharesForProducerPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client
.describeDataSharesForProducerPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client.describeDataSharesForProducerPaginator(request);
responses.iterator().forEachRemaining(....);
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
describeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)
operation.
describeDataSharesForProducerRequest - InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSharesForProducerIterable describeDataSharesForProducerPaginator(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares when the account identifier being called is a producer account identifier.
This is a variant of
describeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client.describeDataSharesForProducerPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client
.describeDataSharesForProducerPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client.describeDataSharesForProducerPaginator(request);
responses.iterator().forEachRemaining(....);
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
describeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)
operation.
This is a convenience which creates an instance of the DescribeDataSharesForProducerRequest.Builder
avoiding the need to create one manually via DescribeDataSharesForProducerRequest.builder()
describeDataSharesForProducerRequest - A Consumer that will call methods on
DescribeDataSharesForProducerRequest.Builder to
create a request.InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDefaultClusterParametersResponse describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RedshiftException
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.
describeDefaultClusterParametersRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDefaultClusterParametersResponse describeDefaultClusterParameters(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 via DescribeDefaultClusterParametersRequest.builder()
describeDefaultClusterParametersRequest - A Consumer that will call methods on
DescribeDefaultClusterParametersRequest.Builder to
create a 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.AwsServiceExceptiondefault DescribeDefaultClusterParametersIterable describeDefaultClusterParametersPaginator(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client
.describeDefaultClusterParametersPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeDefaultClusterParametersRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDefaultClusterParametersIterable describeDefaultClusterParametersPaginator(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client
.describeDefaultClusterParametersPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeDefaultClusterParametersRequest.builder()
describeDefaultClusterParametersRequest - A Consumer that will call methods on
DescribeDefaultClusterParametersRequest.Builder to
create a 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.AwsServiceExceptiondefault DescribeEndpointAccessResponse describeEndpointAccess(DescribeEndpointAccessRequest describeEndpointAccessRequest) throws ClusterNotFoundException, InvalidClusterStateException, EndpointNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Describes a Redshift-managed VPC endpoint.
describeEndpointAccessRequest - 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.AwsServiceExceptiondefault DescribeEndpointAccessResponse describeEndpointAccess(Consumer<DescribeEndpointAccessRequest.Builder> describeEndpointAccessRequest) throws ClusterNotFoundException, InvalidClusterStateException, EndpointNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeEndpointAccessRequest.builder()
describeEndpointAccessRequest - A Consumer that will call methods on
DescribeEndpointAccessRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeEndpointAccessIterable describeEndpointAccessPaginator(DescribeEndpointAccessRequest describeEndpointAccessRequest) throws ClusterNotFoundException, InvalidClusterStateException, EndpointNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Describes a Redshift-managed VPC endpoint.
This is a variant of
describeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessIterable responses = client.describeEndpointAccessPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessIterable responses = client
.describeEndpointAccessPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessIterable responses = client.describeEndpointAccessPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeEndpointAccessRequest - 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.AwsServiceExceptiondefault DescribeEndpointAccessIterable describeEndpointAccessPaginator(Consumer<DescribeEndpointAccessRequest.Builder> describeEndpointAccessRequest) throws ClusterNotFoundException, InvalidClusterStateException, EndpointNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Describes a Redshift-managed VPC endpoint.
This is a variant of
describeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessIterable responses = client.describeEndpointAccessPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessIterable responses = client
.describeEndpointAccessPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessIterable responses = client.describeEndpointAccessPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeEndpointAccessRequest.builder()
describeEndpointAccessRequest - A Consumer that will call methods on
DescribeEndpointAccessRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeEndpointAuthorizationResponse describeEndpointAuthorization(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Describes an endpoint authorization.
describeEndpointAuthorizationRequest - 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.AwsServiceExceptiondefault DescribeEndpointAuthorizationResponse describeEndpointAuthorization(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Describes an endpoint authorization.
This is a convenience which creates an instance of the DescribeEndpointAuthorizationRequest.Builder
avoiding the need to create one manually via DescribeEndpointAuthorizationRequest.builder()
describeEndpointAuthorizationRequest - A Consumer that will call methods on
DescribeEndpointAuthorizationRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeEndpointAuthorizationIterable describeEndpointAuthorizationPaginator(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Describes an endpoint authorization.
This is a variant of
describeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationIterable responses = client.describeEndpointAuthorizationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationIterable responses = client
.describeEndpointAuthorizationPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationIterable responses = client.describeEndpointAuthorizationPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeEndpointAuthorizationRequest - 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.AwsServiceExceptiondefault DescribeEndpointAuthorizationIterable describeEndpointAuthorizationPaginator(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Describes an endpoint authorization.
This is a variant of
describeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationIterable responses = client.describeEndpointAuthorizationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationIterable responses = client
.describeEndpointAuthorizationPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationIterable responses = client.describeEndpointAuthorizationPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeEndpointAuthorizationRequest.builder()
describeEndpointAuthorizationRequest - A Consumer that will call methods on
DescribeEndpointAuthorizationRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, RedshiftException
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.
describeEventCategoriesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventCategoriesResponse describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 via DescribeEventCategoriesRequest.builder()
describeEventCategoriesRequest - A Consumer that will call methods on
DescribeEventCategoriesRequest.Builder to create a
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.AwsServiceExceptiondefault DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, RedshiftException
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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEventCategories(DescribeEventCategoriesRequest),
AWS API Documentationdefault DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
describeEventSubscriptionsRequest - 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.AwsServiceExceptiondefault DescribeEventSubscriptionsResponse describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest - A Consumer that will call methods on
DescribeEventSubscriptionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeEventSubscriptionsResponse describeEventSubscriptions() throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
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.AwsServiceExceptiondescribeEventSubscriptions(DescribeEventSubscriptionsRequest),
AWS API Documentationdefault DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client
.describeEventSubscriptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest),
AWS API Documentationdefault DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client
.describeEventSubscriptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeEventSubscriptionsRequest - 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.AwsServiceExceptiondefault DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client
.describeEventSubscriptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest - A Consumer that will call methods on
DescribeEventSubscriptionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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.
describeEventsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on
DescribeEventsRequest.Builder to create a 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.AwsServiceExceptiondefault DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, RedshiftException
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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEvents(DescribeEventsRequest),
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client
.describeEventsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEventsPaginator(DescribeEventsRequest),
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client
.describeEventsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeEventsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client
.describeEventsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on
DescribeEventsRequest.Builder to create a 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.AwsServiceExceptiondefault DescribeHsmClientCertificatesResponse describeHsmClientCertificates(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
describeHsmClientCertificatesRequest - 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.AwsServiceExceptiondefault DescribeHsmClientCertificatesResponse describeHsmClientCertificates(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeHsmClientCertificatesRequest.Builder
avoiding the need to create one manually via DescribeHsmClientCertificatesRequest.builder()
describeHsmClientCertificatesRequest - A Consumer that will call methods on
DescribeHsmClientCertificatesRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeHsmClientCertificatesResponse describeHsmClientCertificates() throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
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.AwsServiceExceptiondescribeHsmClientCertificates(DescribeHsmClientCertificatesRequest),
AWS API Documentationdefault DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator() throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client
.describeHsmClientCertificatesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest),
AWS API Documentationdefault DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client
.describeHsmClientCertificatesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeHsmClientCertificatesRequest - 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.AwsServiceExceptiondefault DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner and environment for tag keys, and admin and test for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client
.describeHsmClientCertificatesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeHsmClientCertificatesRequest.builder()
describeHsmClientCertificatesRequest - A Consumer that will call methods on
DescribeHsmClientCertificatesRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeHsmConfigurationsResponse describeHsmConfigurations(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
describeHsmConfigurationsRequest - 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.AwsServiceExceptiondefault DescribeHsmConfigurationsResponse describeHsmConfigurations(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeHsmConfigurationsRequest.Builder avoiding
the need to create one manually via DescribeHsmConfigurationsRequest.builder()
describeHsmConfigurationsRequest - A Consumer that will call methods on
DescribeHsmConfigurationsRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeHsmConfigurationsResponse describeHsmConfigurations() throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
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.AwsServiceExceptiondescribeHsmConfigurations(DescribeHsmConfigurationsRequest),
AWS API Documentationdefault DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator() throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client
.describeHsmConfigurationsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest),
AWS API Documentationdefault DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client
.describeHsmConfigurationsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeHsmConfigurationsRequest - 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.AwsServiceExceptiondefault DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client
.describeHsmConfigurationsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeHsmConfigurationsRequest.builder()
describeHsmConfigurationsRequest - A Consumer that will call methods on
DescribeHsmConfigurationsRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeInboundIntegrationsResponse describeInboundIntegrations(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) throws IntegrationNotFoundException, InvalidNamespaceException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of inbound integrations.
describeInboundIntegrationsRequest - 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.AwsServiceExceptiondefault DescribeInboundIntegrationsResponse describeInboundIntegrations(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest) throws IntegrationNotFoundException, InvalidNamespaceException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeInboundIntegrationsRequest.builder()
describeInboundIntegrationsRequest - A Consumer that will call methods on
DescribeInboundIntegrationsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeInboundIntegrationsIterable describeInboundIntegrationsPaginator(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) throws IntegrationNotFoundException, InvalidNamespaceException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of inbound integrations.
This is a variant of
describeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsIterable responses = client.describeInboundIntegrationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsIterable responses = client
.describeInboundIntegrationsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsIterable responses = client.describeInboundIntegrationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeInboundIntegrationsRequest - 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.AwsServiceExceptiondefault DescribeInboundIntegrationsIterable describeInboundIntegrationsPaginator(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest) throws IntegrationNotFoundException, InvalidNamespaceException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of inbound integrations.
This is a variant of
describeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsIterable responses = client.describeInboundIntegrationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsIterable responses = client
.describeInboundIntegrationsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsIterable responses = client.describeInboundIntegrationsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeInboundIntegrationsRequest.builder()
describeInboundIntegrationsRequest - A Consumer that will call methods on
DescribeInboundIntegrationsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeLoggingStatusResponse describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest) throws ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
describeLoggingStatusRequest - 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.AwsServiceExceptiondefault DescribeLoggingStatusResponse describeLoggingStatus(Consumer<DescribeLoggingStatusRequest.Builder> describeLoggingStatusRequest) throws ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeLoggingStatusRequest.builder()
describeLoggingStatusRequest - A Consumer that will call methods on
DescribeLoggingStatusRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeNodeConfigurationOptionsResponse describeNodeConfigurationOptions(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest) throws ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterNotFoundException, AccessToSnapshotDeniedException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
describeNodeConfigurationOptionsRequest - 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.AwsServiceExceptiondefault DescribeNodeConfigurationOptionsResponse describeNodeConfigurationOptions(Consumer<DescribeNodeConfigurationOptionsRequest.Builder> describeNodeConfigurationOptionsRequest) throws ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterNotFoundException, AccessToSnapshotDeniedException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeNodeConfigurationOptionsRequest.builder()
describeNodeConfigurationOptionsRequest - A Consumer that will call methods on
DescribeNodeConfigurationOptionsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeNodeConfigurationOptionsIterable describeNodeConfigurationOptionsPaginator(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest) throws ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterNotFoundException, AccessToSnapshotDeniedException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
This is a variant of
describeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsIterable responses = client.describeNodeConfigurationOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsIterable responses = client
.describeNodeConfigurationOptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsIterable responses = client.describeNodeConfigurationOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeNodeConfigurationOptionsRequest - 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.AwsServiceExceptiondefault DescribeNodeConfigurationOptionsIterable describeNodeConfigurationOptionsPaginator(Consumer<DescribeNodeConfigurationOptionsRequest.Builder> describeNodeConfigurationOptionsRequest) throws ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterNotFoundException, AccessToSnapshotDeniedException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
This is a variant of
describeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsIterable responses = client.describeNodeConfigurationOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsIterable responses = client
.describeNodeConfigurationOptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsIterable responses = client.describeNodeConfigurationOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeNodeConfigurationOptionsRequest.builder()
describeNodeConfigurationOptionsRequest - A Consumer that will call methods on
DescribeNodeConfigurationOptionsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeOrderableClusterOptionsResponse describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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.
describeOrderableClusterOptionsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOrderableClusterOptionsResponse describeOrderableClusterOptions(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 via DescribeOrderableClusterOptionsRequest.builder()
describeOrderableClusterOptionsRequest - A Consumer that will call methods on
DescribeOrderableClusterOptionsRequest.Builder to
create a 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.AwsServiceExceptiondefault DescribeOrderableClusterOptionsResponse describeOrderableClusterOptions() throws AwsServiceException, SdkClientException, RedshiftException
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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest),
AWS API Documentationdefault DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator() throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client
.describeOrderableClusterOptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest),
AWS API Documentationdefault DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client
.describeOrderableClusterOptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeOrderableClusterOptionsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client
.describeOrderableClusterOptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeOrderableClusterOptionsRequest.builder()
describeOrderableClusterOptionsRequest - A Consumer that will call methods on
DescribeOrderableClusterOptionsRequest.Builder to
create a 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.AwsServiceExceptiondefault DescribePartnersResponse describePartners(DescribePartnersRequest describePartnersRequest) throws ClusterNotFoundException, UnauthorizedPartnerIntegrationException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the partner integrations defined for a cluster.
describePartnersRequest - ClusterNotFoundException - The ClusterIdentifier parameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException - The partner integration is not authorized.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePartnersResponse describePartners(Consumer<DescribePartnersRequest.Builder> describePartnersRequest) throws ClusterNotFoundException, UnauthorizedPartnerIntegrationException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribePartnersRequest.builder()
describePartnersRequest - A Consumer that will call methods on
DescribePartnersRequest.Builder to create a
request.ClusterNotFoundException - The ClusterIdentifier parameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException - The partner integration is not authorized.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedNodeExchangeStatusResponse describeReservedNodeExchangeStatus(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest) throws ReservedNodeNotFoundException, ReservedNodeExchangeNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.
describeReservedNodeExchangeStatusRequest - 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.AwsServiceExceptiondefault DescribeReservedNodeExchangeStatusResponse describeReservedNodeExchangeStatus(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest) throws ReservedNodeNotFoundException, ReservedNodeExchangeNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeReservedNodeExchangeStatusRequest.builder()
describeReservedNodeExchangeStatusRequest - A Consumer that will call methods on
DescribeReservedNodeExchangeStatusRequest.Builder
to create a request.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.AwsServiceExceptiondefault DescribeReservedNodeExchangeStatusIterable describeReservedNodeExchangeStatusPaginator(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest) throws ReservedNodeNotFoundException, ReservedNodeExchangeNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.
This is a variant of
describeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusIterable responses = client.describeReservedNodeExchangeStatusPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusIterable responses = client
.describeReservedNodeExchangeStatusPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusIterable responses = client.describeReservedNodeExchangeStatusPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeReservedNodeExchangeStatusRequest - 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.AwsServiceExceptiondefault DescribeReservedNodeExchangeStatusIterable describeReservedNodeExchangeStatusPaginator(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest) throws ReservedNodeNotFoundException, ReservedNodeExchangeNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.
This is a variant of
describeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusIterable responses = client.describeReservedNodeExchangeStatusPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusIterable responses = client
.describeReservedNodeExchangeStatusPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusIterable responses = client.describeReservedNodeExchangeStatusPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeReservedNodeExchangeStatusRequest.builder()
describeReservedNodeExchangeStatusRequest - A Consumer that will call methods on
DescribeReservedNodeExchangeStatusRequest.Builder
to create a request.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.AwsServiceExceptiondefault DescribeReservedNodeOfferingsResponse describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
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.
describeReservedNodeOfferingsRequest - 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.AwsServiceExceptiondefault DescribeReservedNodeOfferingsResponse describeReservedNodeOfferings(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeReservedNodeOfferingsRequest.builder()
describeReservedNodeOfferingsRequest - A Consumer that will call methods on
DescribeReservedNodeOfferingsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeReservedNodeOfferingsResponse describeReservedNodeOfferings() throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
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.
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.AwsServiceExceptiondescribeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest),
AWS API Documentationdefault DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator() throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client
.describeReservedNodeOfferingsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest),
AWS API Documentationdefault DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client
.describeReservedNodeOfferingsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeReservedNodeOfferingsRequest - 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.AwsServiceExceptiondefault DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client
.describeReservedNodeOfferingsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeReservedNodeOfferingsRequest.builder()
describeReservedNodeOfferingsRequest - A Consumer that will call methods on
DescribeReservedNodeOfferingsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeReservedNodesResponse describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
describeReservedNodesRequest - 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.AwsServiceExceptiondefault DescribeReservedNodesResponse describeReservedNodes(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeReservedNodesRequest.builder()
describeReservedNodesRequest - A Consumer that will call methods on
DescribeReservedNodesRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeReservedNodesResponse describeReservedNodes() throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
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.AwsServiceExceptiondescribeReservedNodes(DescribeReservedNodesRequest),
AWS API Documentationdefault DescribeReservedNodesIterable describeReservedNodesPaginator() throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client
.describeReservedNodesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeReservedNodesPaginator(DescribeReservedNodesRequest),
AWS API Documentationdefault DescribeReservedNodesIterable describeReservedNodesPaginator(DescribeReservedNodesRequest describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client
.describeReservedNodesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeReservedNodesRequest - 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.AwsServiceExceptiondefault DescribeReservedNodesIterable describeReservedNodesPaginator(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client
.describeReservedNodesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeReservedNodesRequest.builder()
describeReservedNodesRequest - A Consumer that will call methods on
DescribeReservedNodesRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeResizeResponse describeResize(DescribeResizeRequest describeResizeRequest) throws ClusterNotFoundException, ResizeNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the last resize operation for the specified cluster. If no resize operation has ever
been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was
initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
describeResizeRequest - ClusterNotFoundException - The ClusterIdentifier parameter does not refer to an existing cluster.ResizeNotFoundException - A resize operation for the specified cluster is not 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.AwsServiceExceptiondefault DescribeResizeResponse describeResize(Consumer<DescribeResizeRequest.Builder> describeResizeRequest) throws ClusterNotFoundException, ResizeNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the last resize operation for the specified cluster. If no resize operation has ever
been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was
initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
This is a convenience which creates an instance of the DescribeResizeRequest.Builder avoiding the need to
create one manually via DescribeResizeRequest.builder()
describeResizeRequest - A Consumer that will call methods on
DescribeResizeRequest.Builder to create a request.ClusterNotFoundException - The ClusterIdentifier parameter does not refer to an existing cluster.ResizeNotFoundException - A resize operation for the specified cluster is not 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.AwsServiceExceptiondefault DescribeScheduledActionsResponse describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Describes properties of scheduled actions.
describeScheduledActionsRequest - 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.AwsServiceExceptiondefault DescribeScheduledActionsResponse describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Describes properties of scheduled actions.
This is a convenience which creates an instance of the DescribeScheduledActionsRequest.Builder avoiding
the need to create one manually via DescribeScheduledActionsRequest.builder()
describeScheduledActionsRequest - A Consumer that will call methods on
DescribeScheduledActionsRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeScheduledActionsIterable describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Describes properties of scheduled actions.
This is a variant of
describeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsIterable responses = client
.describeScheduledActionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeScheduledActionsRequest - 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.AwsServiceExceptiondefault DescribeScheduledActionsIterable describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Describes properties of scheduled actions.
This is a variant of
describeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsIterable responses = client
.describeScheduledActionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeScheduledActionsRequest.builder()
describeScheduledActionsRequest - A Consumer that will call methods on
DescribeScheduledActionsRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeSnapshotCopyGrantsResponse describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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.
describeSnapshotCopyGrantsRequest - The result of the DescribeSnapshotCopyGrants action.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.AwsServiceExceptiondefault DescribeSnapshotCopyGrantsResponse describeSnapshotCopyGrants(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeSnapshotCopyGrantsRequest.builder()
describeSnapshotCopyGrantsRequest - A Consumer that will call methods on
DescribeSnapshotCopyGrantsRequest.Builder to create
a request. The result of the DescribeSnapshotCopyGrants action.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.AwsServiceExceptiondefault DescribeSnapshotCopyGrantsResponse describeSnapshotCopyGrants() throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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.
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.AwsServiceExceptiondescribeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest),
AWS API Documentationdefault DescribeSnapshotCopyGrantsIterable describeSnapshotCopyGrantsPaginator() throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client.describeSnapshotCopyGrantsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client
.describeSnapshotCopyGrantsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client.describeSnapshotCopyGrantsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeSnapshotCopyGrantsPaginator(DescribeSnapshotCopyGrantsRequest),
AWS API Documentationdefault DescribeSnapshotCopyGrantsIterable describeSnapshotCopyGrantsPaginator(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client.describeSnapshotCopyGrantsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client
.describeSnapshotCopyGrantsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client.describeSnapshotCopyGrantsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeSnapshotCopyGrantsRequest - The result of the DescribeSnapshotCopyGrants action.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.AwsServiceExceptiondefault DescribeSnapshotCopyGrantsIterable describeSnapshotCopyGrantsPaginator(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client.describeSnapshotCopyGrantsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client
.describeSnapshotCopyGrantsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client.describeSnapshotCopyGrantsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeSnapshotCopyGrantsRequest.builder()
describeSnapshotCopyGrantsRequest - A Consumer that will call methods on
DescribeSnapshotCopyGrantsRequest.Builder to create
a request. The result of the DescribeSnapshotCopyGrants action.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.AwsServiceExceptiondefault DescribeSnapshotSchedulesResponse describeSnapshotSchedules(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot schedules.
describeSnapshotSchedulesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotSchedulesResponse describeSnapshotSchedules(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 via DescribeSnapshotSchedulesRequest.builder()
describeSnapshotSchedulesRequest - A Consumer that will call methods on
DescribeSnapshotSchedulesRequest.Builder to create
a 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.AwsServiceExceptiondefault DescribeSnapshotSchedulesResponse describeSnapshotSchedules() throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot schedules.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeSnapshotSchedules(DescribeSnapshotSchedulesRequest),
AWS API Documentationdefault DescribeSnapshotSchedulesIterable describeSnapshotSchedulesPaginator() throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot schedules.
This is a variant of
describeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client.describeSnapshotSchedulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client
.describeSnapshotSchedulesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client.describeSnapshotSchedulesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeSnapshotSchedulesPaginator(DescribeSnapshotSchedulesRequest),
AWS API Documentationdefault DescribeSnapshotSchedulesIterable describeSnapshotSchedulesPaginator(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot schedules.
This is a variant of
describeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client.describeSnapshotSchedulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client
.describeSnapshotSchedulesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client.describeSnapshotSchedulesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeSnapshotSchedulesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotSchedulesIterable describeSnapshotSchedulesPaginator(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot schedules.
This is a variant of
describeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client.describeSnapshotSchedulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client
.describeSnapshotSchedulesPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client.describeSnapshotSchedulesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeSnapshotSchedulesRequest.builder()
describeSnapshotSchedulesRequest - A Consumer that will call methods on
DescribeSnapshotSchedulesRequest.Builder to create
a 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.AwsServiceExceptiondefault DescribeStorageResponse describeStorage(DescribeStorageRequest describeStorageRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns account level backups storage size and provisional storage.
describeStorageRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageResponse describeStorage(Consumer<DescribeStorageRequest.Builder> describeStorageRequest) throws AwsServiceException, SdkClientException, RedshiftException
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 via DescribeStorageRequest.builder()
describeStorageRequest - A Consumer that will call methods on
DescribeStorageRequest.Builder to create a 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.AwsServiceExceptiondefault DescribeStorageResponse describeStorage() throws AwsServiceException, SdkClientException, RedshiftException
Returns account level backups storage size and provisional storage.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeStorage(DescribeStorageRequest),
AWS API
Documentationdefault DescribeTableRestoreStatusResponse describeTableRestoreStatus(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) throws TableRestoreNotFoundException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action. If you don't specify a value for the TableRestoreRequestId parameter, then
DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and
time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of
the table specified by TableRestoreRequestId.
describeTableRestoreStatusRequest - 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.AwsServiceExceptiondefault DescribeTableRestoreStatusResponse describeTableRestoreStatus(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) throws TableRestoreNotFoundException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action. If you don't specify a value for the TableRestoreRequestId parameter, then
DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and
time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of
the table specified by TableRestoreRequestId.
This is a convenience which creates an instance of the DescribeTableRestoreStatusRequest.Builder avoiding
the need to create one manually via DescribeTableRestoreStatusRequest.builder()
describeTableRestoreStatusRequest - A Consumer that will call methods on
DescribeTableRestoreStatusRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeTableRestoreStatusIterable describeTableRestoreStatusPaginator(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) throws TableRestoreNotFoundException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action. If you don't specify a value for the TableRestoreRequestId parameter, then
DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and
time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of
the table specified by TableRestoreRequestId.
This is a variant of
describeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusIterable responses = client.describeTableRestoreStatusPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusIterable responses = client
.describeTableRestoreStatusPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusIterable responses = client.describeTableRestoreStatusPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeTableRestoreStatusRequest - 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.AwsServiceExceptiondefault DescribeTableRestoreStatusIterable describeTableRestoreStatusPaginator(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) throws TableRestoreNotFoundException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action. If you don't specify a value for the TableRestoreRequestId parameter, then
DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and
time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of
the table specified by TableRestoreRequestId.
This is a variant of
describeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusIterable responses = client.describeTableRestoreStatusPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusIterable responses = client
.describeTableRestoreStatusPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusIterable responses = client.describeTableRestoreStatusPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeTableRestoreStatusRequest.builder()
describeTableRestoreStatusRequest - A Consumer that will call methods on
DescribeTableRestoreStatusRequest.Builder to create
a request.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.AwsServiceExceptiondefault DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
describeTagsRequest - 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.AwsServiceExceptiondefault DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeTagsRequest.Builder avoiding the need to
create one manually via DescribeTagsRequest.builder()
describeTagsRequest - A Consumer that will call methods on
DescribeTagsRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeTagsResponse describeTags() throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
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.AwsServiceExceptiondescribeTags(DescribeTagsRequest),
AWS API
Documentationdefault DescribeTagsIterable describeTagsPaginator() throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
This is a variant of describeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeTagsPaginator(DescribeTagsRequest),
AWS API
Documentationdefault DescribeTagsIterable describeTagsPaginator(DescribeTagsRequest describeTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
This is a variant of describeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeTagsRequest - 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.AwsServiceExceptiondefault DescribeTagsIterable describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
This is a variant of describeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeTagsRequest.builder()
describeTagsRequest - A Consumer that will call methods on
DescribeTagsRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeUsageLimitsResponse describeUsageLimits(DescribeUsageLimitsRequest describeUsageLimitsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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.
describeUsageLimitsRequest - 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.AwsServiceExceptiondefault DescribeUsageLimitsResponse describeUsageLimits(Consumer<DescribeUsageLimitsRequest.Builder> describeUsageLimitsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via DescribeUsageLimitsRequest.builder()
describeUsageLimitsRequest - A Consumer that will call methods on
DescribeUsageLimitsRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeUsageLimitsIterable describeUsageLimitsPaginator(DescribeUsageLimitsRequest describeUsageLimitsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsIterable responses = client.describeUsageLimitsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsIterable responses = client
.describeUsageLimitsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsIterable responses = client.describeUsageLimitsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeUsageLimitsRequest - 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.AwsServiceExceptiondefault DescribeUsageLimitsIterable describeUsageLimitsPaginator(Consumer<DescribeUsageLimitsRequest.Builder> describeUsageLimitsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
describeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsIterable responses = client.describeUsageLimitsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsIterable responses = client
.describeUsageLimitsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsIterable responses = client.describeUsageLimitsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeUsageLimitsRequest.builder()
describeUsageLimitsRequest - A Consumer that will call methods on
DescribeUsageLimitsRequest.Builder to create a
request.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.AwsServiceExceptiondefault DisableLoggingResponse disableLogging(DisableLoggingRequest disableLoggingRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
disableLoggingRequest - 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.AwsServiceExceptiondefault DisableLoggingResponse disableLogging(Consumer<DisableLoggingRequest.Builder> disableLoggingRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
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 via DisableLoggingRequest.builder()
disableLoggingRequest - A Consumer that will call methods on
DisableLoggingRequest.Builder to create a request.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.AwsServiceExceptiondefault DisableSnapshotCopyResponse disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest) throws ClusterNotFoundException, SnapshotCopyAlreadyDisabledException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
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.
disableSnapshotCopyRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableSnapshotCopyResponse disableSnapshotCopy(Consumer<DisableSnapshotCopyRequest.Builder> disableSnapshotCopyRequest) throws ClusterNotFoundException, SnapshotCopyAlreadyDisabledException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via DisableSnapshotCopyRequest.builder()
disableSnapshotCopyRequest - A Consumer that will call methods on
DisableSnapshotCopyRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateDataShareConsumerResponse disassociateDataShareConsumer(DisassociateDataShareConsumerRequest disassociateDataShareConsumerRequest) throws InvalidDataShareException, InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, remove association for the specified datashare.
disassociateDataShareConsumerRequest - InvalidDataShareException - There is an error with the datashare.InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateDataShareConsumerResponse disassociateDataShareConsumer(Consumer<DisassociateDataShareConsumerRequest.Builder> disassociateDataShareConsumerRequest) throws InvalidDataShareException, InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, remove association for the specified datashare.
This is a convenience which creates an instance of the DisassociateDataShareConsumerRequest.Builder
avoiding the need to create one manually via DisassociateDataShareConsumerRequest.builder()
disassociateDataShareConsumerRequest - A Consumer that will call methods on
DisassociateDataShareConsumerRequest.Builder to
create a request.InvalidDataShareException - There is an error with the datashare.InvalidNamespaceException - The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableLoggingResponse enableLogging(EnableLoggingRequest enableLoggingRequest) throws ClusterNotFoundException, BucketNotFoundException, InsufficientS3BucketPolicyException, InvalidS3KeyPrefixException, InvalidS3BucketNameException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
enableLoggingRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableLoggingResponse enableLogging(Consumer<EnableLoggingRequest.Builder> enableLoggingRequest) throws ClusterNotFoundException, BucketNotFoundException, InsufficientS3BucketPolicyException, InvalidS3KeyPrefixException, InvalidS3BucketNameException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
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 via EnableLoggingRequest.builder()
enableLoggingRequest - A Consumer that will call methods on
EnableLoggingRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableSnapshotCopyResponse enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest) throws IncompatibleOrderableOptionsException, InvalidClusterStateException, ClusterNotFoundException, CopyToRegionDisabledException, SnapshotCopyAlreadyEnabledException, UnknownSnapshotCopyRegionException, UnauthorizedOperationException, SnapshotCopyGrantNotFoundException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
enableSnapshotCopyRequest - 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.AwsServiceExceptiondefault EnableSnapshotCopyResponse enableSnapshotCopy(Consumer<EnableSnapshotCopyRequest.Builder> enableSnapshotCopyRequest) throws IncompatibleOrderableOptionsException, InvalidClusterStateException, ClusterNotFoundException, CopyToRegionDisabledException, SnapshotCopyAlreadyEnabledException, UnknownSnapshotCopyRegionException, UnauthorizedOperationException, SnapshotCopyGrantNotFoundException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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 via EnableSnapshotCopyRequest.builder()
enableSnapshotCopyRequest - A Consumer that will call methods on
EnableSnapshotCopyRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetClusterCredentialsResponse getClusterCredentials(GetClusterCredentialsRequest getClusterCredentialsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database. The action returns the database user name prefixed with IAM: if AutoCreate is
False or IAMA: if AutoCreate is True. You can optionally
specify one or more database user groups that the user will join at log on. By default, the temporary credentials
expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds
(60 minutes). For more information, see Using IAM Authentication
to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups parameter is specified, the IAM policy must allow the
redshift:JoinGroup action with access to the listed dbgroups.
In addition, if the AutoCreate parameter is set to True, then the policy must include
the redshift:CreateClusterUser permission.
If the DbName parameter is specified, the IAM policy must allow access to the resource
dbname for the specified database name.
getClusterCredentialsRequest - The request parameters to get cluster credentials.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.AwsServiceExceptiondefault GetClusterCredentialsResponse getClusterCredentials(Consumer<GetClusterCredentialsRequest.Builder> getClusterCredentialsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database. The action returns the database user name prefixed with IAM: if AutoCreate is
False or IAMA: if AutoCreate is True. You can optionally
specify one or more database user groups that the user will join at log on. By default, the temporary credentials
expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds
(60 minutes). For more information, see Using IAM Authentication
to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups parameter is specified, the IAM policy must allow the
redshift:JoinGroup action with access to the listed dbgroups.
In addition, if the AutoCreate parameter is set to True, then the policy must include
the redshift:CreateClusterUser permission.
If the DbName parameter is specified, the IAM policy must allow access to the resource
dbname for the specified database name.
This is a convenience which creates an instance of the GetClusterCredentialsRequest.Builder avoiding the
need to create one manually via GetClusterCredentialsRequest.builder()
getClusterCredentialsRequest - A Consumer that will call methods on
GetClusterCredentialsRequest.Builder to create a
request. The request parameters to get cluster credentials.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.AwsServiceExceptiondefault GetClusterCredentialsWithIamResponse getClusterCredentialsWithIAM(GetClusterCredentialsWithIamRequest getClusterCredentialsWithIamRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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.
getClusterCredentialsWithIamRequest - 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.AwsServiceExceptiondefault GetClusterCredentialsWithIamResponse getClusterCredentialsWithIAM(Consumer<GetClusterCredentialsWithIamRequest.Builder> getClusterCredentialsWithIamRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via GetClusterCredentialsWithIamRequest.builder()
getClusterCredentialsWithIamRequest - A Consumer that will call methods on
GetClusterCredentialsWithIamRequest.Builder to
create a request.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.AwsServiceExceptiondefault GetReservedNodeExchangeConfigurationOptionsResponse getReservedNodeExchangeConfigurationOptions(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, ClusterNotFoundException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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.
getReservedNodeExchangeConfigurationOptionsRequest - 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.AwsServiceExceptiondefault GetReservedNodeExchangeConfigurationOptionsResponse getReservedNodeExchangeConfigurationOptions(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, ClusterNotFoundException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via
GetReservedNodeExchangeConfigurationOptionsRequest.builder()
getReservedNodeExchangeConfigurationOptionsRequest - A Consumer that will call methods on
GetReservedNodeExchangeConfigurationOptionsRequest.Builder
to create a request.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.AwsServiceExceptiondefault GetReservedNodeExchangeConfigurationOptionsIterable getReservedNodeExchangeConfigurationOptionsPaginator(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, ClusterNotFoundException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
getReservedNodeExchangeConfigurationOptions(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsIterable responses = client.getReservedNodeExchangeConfigurationOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsIterable responses = client
.getReservedNodeExchangeConfigurationOptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsIterable responses = client.getReservedNodeExchangeConfigurationOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
getReservedNodeExchangeConfigurationOptionsRequest - 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.AwsServiceExceptiondefault GetReservedNodeExchangeConfigurationOptionsIterable getReservedNodeExchangeConfigurationOptionsPaginator(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, ClusterNotFoundException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 variant of
getReservedNodeExchangeConfigurationOptions(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsIterable responses = client.getReservedNodeExchangeConfigurationOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsIterable responses = client
.getReservedNodeExchangeConfigurationOptionsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeConfigurationOptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsIterable responses = client.getReservedNodeExchangeConfigurationOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via
GetReservedNodeExchangeConfigurationOptionsRequest.builder()
getReservedNodeExchangeConfigurationOptionsRequest - A Consumer that will call methods on
GetReservedNodeExchangeConfigurationOptionsRequest.Builder
to create a request.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.AwsServiceExceptiondefault GetReservedNodeExchangeOfferingsResponse getReservedNodeExchangeOfferings(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
getReservedNodeExchangeOfferingsRequest - 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.AwsServiceExceptiondefault GetReservedNodeExchangeOfferingsResponse getReservedNodeExchangeOfferings(Consumer<GetReservedNodeExchangeOfferingsRequest.Builder> getReservedNodeExchangeOfferingsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
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 via GetReservedNodeExchangeOfferingsRequest.builder()
getReservedNodeExchangeOfferingsRequest - A Consumer that will call methods on
GetReservedNodeExchangeOfferingsRequest.Builder to
create a request.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.AwsServiceExceptiondefault GetReservedNodeExchangeOfferingsIterable getReservedNodeExchangeOfferingsPaginator(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
This is a variant of
getReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsIterable responses = client.getReservedNodeExchangeOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsIterable responses = client
.getReservedNodeExchangeOfferingsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsIterable responses = client.getReservedNodeExchangeOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
getReservedNodeExchangeOfferingsRequest - 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.AwsServiceExceptiondefault GetReservedNodeExchangeOfferingsIterable getReservedNodeExchangeOfferingsPaginator(Consumer<GetReservedNodeExchangeOfferingsRequest.Builder> getReservedNodeExchangeOfferingsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
This is a variant of
getReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsIterable responses = client.getReservedNodeExchangeOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsIterable responses = client
.getReservedNodeExchangeOfferingsPaginator(request);
for (software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsIterable responses = client.getReservedNodeExchangeOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via GetReservedNodeExchangeOfferingsRequest.builder()
getReservedNodeExchangeOfferingsRequest - A Consumer that will call methods on
GetReservedNodeExchangeOfferingsRequest.Builder to
create a request.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.AwsServiceExceptiondefault GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) throws ResourceNotFoundException, InvalidPolicyException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Get the resource policy for a specified resource.
getResourcePolicyRequest - 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.AwsServiceExceptiondefault GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) throws ResourceNotFoundException, InvalidPolicyException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via GetResourcePolicyRequest.builder()
getResourcePolicyRequest - A Consumer that will call methods on
GetResourcePolicyRequest.Builder to create a
request.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.AwsServiceExceptiondefault ModifyAquaConfigurationResponse modifyAquaConfiguration(ModifyAquaConfigurationRequest modifyAquaConfigurationRequest) throws ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
modifyAquaConfigurationRequest - 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.AwsServiceExceptiondefault ModifyAquaConfigurationResponse modifyAquaConfiguration(Consumer<ModifyAquaConfigurationRequest.Builder> modifyAquaConfigurationRequest) throws ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyAquaConfigurationRequest.builder()
modifyAquaConfigurationRequest - A Consumer that will call methods on
ModifyAquaConfigurationRequest.Builder to create a
request.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.AwsServiceExceptiondefault ModifyAuthenticationProfileResponse modifyAuthenticationProfile(ModifyAuthenticationProfileRequest modifyAuthenticationProfileRequest) throws AuthenticationProfileNotFoundException, AuthenticationProfileQuotaExceededException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException
Modifies an authentication profile.
modifyAuthenticationProfileRequest - 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.AwsServiceExceptiondefault ModifyAuthenticationProfileResponse modifyAuthenticationProfile(Consumer<ModifyAuthenticationProfileRequest.Builder> modifyAuthenticationProfileRequest) throws AuthenticationProfileNotFoundException, AuthenticationProfileQuotaExceededException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException
Modifies an authentication profile.
This is a convenience which creates an instance of the ModifyAuthenticationProfileRequest.Builder
avoiding the need to create one manually via ModifyAuthenticationProfileRequest.builder()
modifyAuthenticationProfileRequest - A Consumer that will call methods on
ModifyAuthenticationProfileRequest.Builder to
create a request.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.AwsServiceExceptiondefault ModifyClusterResponse modifyCluster(ModifyClusterRequest modifyClusterRequest) throws InvalidClusterStateException, InvalidClusterSecurityGroupStateException, ClusterNotFoundException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, ClusterSecurityGroupNotFoundException, ClusterParameterGroupNotFoundException, InsufficientClusterCapacityException, UnsupportedOptionException, UnauthorizedOperationException, HsmClientCertificateNotFoundException, HsmConfigurationNotFoundException, ClusterAlreadyExistsException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidElasticIpException, TableLimitExceededException, InvalidClusterTrackException, InvalidRetentionPeriodException, UnsupportedOperationException, CustomCnameAssociationException, AwsServiceException, SdkClientException, RedshiftException
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.
modifyClusterRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyClusterResponse modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest) throws InvalidClusterStateException, InvalidClusterSecurityGroupStateException, ClusterNotFoundException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, ClusterSecurityGroupNotFoundException, ClusterParameterGroupNotFoundException, InsufficientClusterCapacityException, UnsupportedOptionException, UnauthorizedOperationException, HsmClientCertificateNotFoundException, HsmConfigurationNotFoundException, ClusterAlreadyExistsException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidElasticIpException, TableLimitExceededException, InvalidClusterTrackException, InvalidRetentionPeriodException, UnsupportedOperationException, CustomCnameAssociationException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyClusterRequest.builder()
modifyClusterRequest - A Consumer that will call methods on
ModifyClusterRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyClusterDbRevisionResponse modifyClusterDbRevision(ModifyClusterDbRevisionRequest modifyClusterDbRevisionRequest) throws ClusterNotFoundException, ClusterOnLatestRevisionException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
modifyClusterDbRevisionRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyClusterDbRevisionResponse modifyClusterDbRevision(Consumer<ModifyClusterDbRevisionRequest.Builder> modifyClusterDbRevisionRequest) throws ClusterNotFoundException, ClusterOnLatestRevisionException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyClusterDbRevisionRequest.builder()
modifyClusterDbRevisionRequest - A Consumer that will call methods on
ModifyClusterDbRevisionRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyClusterIamRolesResponse modifyClusterIamRoles(ModifyClusterIamRolesRequest modifyClusterIamRolesRequest) throws InvalidClusterStateException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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.
modifyClusterIamRolesRequest - 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.AwsServiceExceptiondefault ModifyClusterIamRolesResponse modifyClusterIamRoles(Consumer<ModifyClusterIamRolesRequest.Builder> modifyClusterIamRolesRequest) throws InvalidClusterStateException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyClusterIamRolesRequest.builder()
modifyClusterIamRolesRequest - A Consumer that will call methods on
ModifyClusterIamRolesRequest.Builder to create a
request.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.AwsServiceExceptiondefault ModifyClusterMaintenanceResponse modifyClusterMaintenance(ModifyClusterMaintenanceRequest modifyClusterMaintenanceRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Modifies the maintenance settings of a cluster.
modifyClusterMaintenanceRequest - 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.AwsServiceExceptiondefault ModifyClusterMaintenanceResponse modifyClusterMaintenance(Consumer<ModifyClusterMaintenanceRequest.Builder> modifyClusterMaintenanceRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyClusterMaintenanceRequest.builder()
modifyClusterMaintenanceRequest - A Consumer that will call methods on
ModifyClusterMaintenanceRequest.Builder to create a
request.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.AwsServiceExceptiondefault ModifyClusterParameterGroupResponse modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest) throws ClusterParameterGroupNotFoundException, InvalidClusterParameterGroupStateException, AwsServiceException, SdkClientException, RedshiftException
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.
modifyClusterParameterGroupRequest - Describes a modify cluster parameter group operation.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.AwsServiceExceptiondefault ModifyClusterParameterGroupResponse modifyClusterParameterGroup(Consumer<ModifyClusterParameterGroupRequest.Builder> modifyClusterParameterGroupRequest) throws ClusterParameterGroupNotFoundException, InvalidClusterParameterGroupStateException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyClusterParameterGroupRequest.builder()
modifyClusterParameterGroupRequest - A Consumer that will call methods on
ModifyClusterParameterGroupRequest.Builder to
create a request. Describes a modify cluster parameter group operation.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.AwsServiceExceptiondefault ModifyClusterSnapshotResponse modifyClusterSnapshot(ModifyClusterSnapshotRequest modifyClusterSnapshotRequest) throws InvalidClusterSnapshotStateException, ClusterSnapshotNotFoundException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
Modifies the settings for a snapshot.
This exanmple modifies the manual retention period setting for a cluster snapshot.
modifyClusterSnapshotRequest - 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.AwsServiceExceptiondefault ModifyClusterSnapshotResponse modifyClusterSnapshot(Consumer<ModifyClusterSnapshotRequest.Builder> modifyClusterSnapshotRequest) throws InvalidClusterSnapshotStateException, ClusterSnapshotNotFoundException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyClusterSnapshotRequest.builder()
modifyClusterSnapshotRequest - A Consumer that will call methods on
ModifyClusterSnapshotRequest.Builder to create a
request.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.AwsServiceExceptiondefault ModifyClusterSnapshotScheduleResponse modifyClusterSnapshotSchedule(ModifyClusterSnapshotScheduleRequest modifyClusterSnapshotScheduleRequest) throws ClusterNotFoundException, SnapshotScheduleNotFoundException, InvalidClusterSnapshotScheduleStateException, AwsServiceException, SdkClientException, RedshiftException
Modifies a snapshot schedule for a cluster.
modifyClusterSnapshotScheduleRequest - 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.AwsServiceExceptiondefault ModifyClusterSnapshotScheduleResponse modifyClusterSnapshotSchedule(Consumer<ModifyClusterSnapshotScheduleRequest.Builder> modifyClusterSnapshotScheduleRequest) throws ClusterNotFoundException, SnapshotScheduleNotFoundException, InvalidClusterSnapshotScheduleStateException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyClusterSnapshotScheduleRequest.builder()
modifyClusterSnapshotScheduleRequest - A Consumer that will call methods on
ModifyClusterSnapshotScheduleRequest.Builder to
create a request.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.AwsServiceExceptiondefault ModifyClusterSubnetGroupResponse modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest) throws ClusterSubnetGroupNotFoundException, ClusterSubnetQuotaExceededException, SubnetAlreadyInUseException, InvalidSubnetException, UnauthorizedOperationException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
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.
modifyClusterSubnetGroupRequest - 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.AwsServiceExceptiondefault ModifyClusterSubnetGroupResponse modifyClusterSubnetGroup(Consumer<ModifyClusterSubnetGroupRequest.Builder> modifyClusterSubnetGroupRequest) throws ClusterSubnetGroupNotFoundException, ClusterSubnetQuotaExceededException, SubnetAlreadyInUseException, InvalidSubnetException, UnauthorizedOperationException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyClusterSubnetGroupRequest.builder()
modifyClusterSubnetGroupRequest - A Consumer that will call methods on
ModifyClusterSubnetGroupRequest.Builder to create a
request.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.AwsServiceExceptiondefault ModifyCustomDomainAssociationResponse modifyCustomDomainAssociation(ModifyCustomDomainAssociationRequest modifyCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, AwsServiceException, SdkClientException, RedshiftException
Contains information for changing a custom domain association.
modifyCustomDomainAssociationRequest - 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.AwsServiceExceptiondefault ModifyCustomDomainAssociationResponse modifyCustomDomainAssociation(Consumer<ModifyCustomDomainAssociationRequest.Builder> modifyCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyCustomDomainAssociationRequest.builder()
modifyCustomDomainAssociationRequest - A Consumer that will call methods on
ModifyCustomDomainAssociationRequest.Builder to
create a request.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.AwsServiceExceptiondefault ModifyEndpointAccessResponse modifyEndpointAccess(ModifyEndpointAccessRequest modifyEndpointAccessRequest) throws InvalidClusterSecurityGroupStateException, ClusterNotFoundException, InvalidEndpointStateException, EndpointNotFoundException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Modifies a Redshift-managed VPC endpoint.
modifyEndpointAccessRequest - 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.AwsServiceExceptiondefault ModifyEndpointAccessResponse modifyEndpointAccess(Consumer<ModifyEndpointAccessRequest.Builder> modifyEndpointAccessRequest) throws InvalidClusterSecurityGroupStateException, ClusterNotFoundException, InvalidEndpointStateException, EndpointNotFoundException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyEndpointAccessRequest.builder()
modifyEndpointAccessRequest - A Consumer that will call methods on
ModifyEndpointAccessRequest.Builder to create a
request.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.AwsServiceExceptiondefault ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionEventIdNotFoundException, SubscriptionCategoryNotFoundException, SubscriptionSeverityNotFoundException, SourceNotFoundException, InvalidSubscriptionStateException, AwsServiceException, SdkClientException, RedshiftException
Modifies an existing Amazon Redshift event notification subscription.
modifyEventSubscriptionRequest - 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.AwsServiceExceptiondefault ModifyEventSubscriptionResponse modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) throws SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionEventIdNotFoundException, SubscriptionCategoryNotFoundException, SubscriptionSeverityNotFoundException, SourceNotFoundException, InvalidSubscriptionStateException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyEventSubscriptionRequest.builder()
modifyEventSubscriptionRequest - A Consumer that will call methods on
ModifyEventSubscriptionRequest.Builder to create a
request.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.AwsServiceExceptiondefault ModifyScheduledActionResponse modifyScheduledAction(ModifyScheduledActionRequest modifyScheduledActionRequest) throws ScheduledActionNotFoundException, ScheduledActionTypeUnsupportedException, InvalidScheduleException, InvalidScheduledActionException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Modifies a scheduled action.
modifyScheduledActionRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyScheduledActionResponse modifyScheduledAction(Consumer<ModifyScheduledActionRequest.Builder> modifyScheduledActionRequest) throws ScheduledActionNotFoundException, ScheduledActionTypeUnsupportedException, InvalidScheduleException, InvalidScheduledActionException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Modifies a scheduled action.
This is a convenience which creates an instance of the ModifyScheduledActionRequest.Builder avoiding the
need to create one manually via ModifyScheduledActionRequest.builder()
modifyScheduledActionRequest - A Consumer that will call methods on
ModifyScheduledActionRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifySnapshotCopyRetentionPeriodResponse modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest) throws ClusterNotFoundException, SnapshotCopyDisabledException, UnauthorizedOperationException, InvalidClusterStateException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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.
modifySnapshotCopyRetentionPeriodRequest - 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.AwsServiceExceptiondefault ModifySnapshotCopyRetentionPeriodResponse modifySnapshotCopyRetentionPeriod(Consumer<ModifySnapshotCopyRetentionPeriodRequest.Builder> modifySnapshotCopyRetentionPeriodRequest) throws ClusterNotFoundException, SnapshotCopyDisabledException, UnauthorizedOperationException, InvalidClusterStateException, InvalidRetentionPeriodException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifySnapshotCopyRetentionPeriodRequest.builder()
modifySnapshotCopyRetentionPeriodRequest - A Consumer that will call methods on
ModifySnapshotCopyRetentionPeriodRequest.Builder to
create a request.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.AwsServiceExceptiondefault ModifySnapshotScheduleResponse modifySnapshotSchedule(ModifySnapshotScheduleRequest modifySnapshotScheduleRequest) throws InvalidScheduleException, SnapshotScheduleNotFoundException, SnapshotScheduleUpdateInProgressException, AwsServiceException, SdkClientException, RedshiftException
Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
modifySnapshotScheduleRequest - 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.AwsServiceExceptiondefault ModifySnapshotScheduleResponse modifySnapshotSchedule(Consumer<ModifySnapshotScheduleRequest.Builder> modifySnapshotScheduleRequest) throws InvalidScheduleException, SnapshotScheduleNotFoundException, SnapshotScheduleUpdateInProgressException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifySnapshotScheduleRequest.builder()
modifySnapshotScheduleRequest - A Consumer that will call methods on
ModifySnapshotScheduleRequest.Builder to create a
request.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.AwsServiceExceptiondefault ModifyUsageLimitResponse modifyUsageLimit(ModifyUsageLimitRequest modifyUsageLimitRequest) throws InvalidUsageLimitException, UsageLimitNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.
modifyUsageLimitRequest - 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.AwsServiceExceptiondefault ModifyUsageLimitResponse modifyUsageLimit(Consumer<ModifyUsageLimitRequest.Builder> modifyUsageLimitRequest) throws InvalidUsageLimitException, UsageLimitNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via ModifyUsageLimitRequest.builder()
modifyUsageLimitRequest - A Consumer that will call methods on
ModifyUsageLimitRequest.Builder to create a
request.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.AwsServiceExceptiondefault PauseClusterResponse pauseCluster(PauseClusterRequest pauseClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Pauses a cluster.
pauseClusterRequest - Describes a pause cluster operation. For example, a scheduled action to run the PauseCluster
API operation.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.AwsServiceExceptiondefault PauseClusterResponse pauseCluster(Consumer<PauseClusterRequest.Builder> pauseClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Pauses a cluster.
This is a convenience which creates an instance of the PauseClusterRequest.Builder avoiding the need to
create one manually via PauseClusterRequest.builder()
pauseClusterRequest - A Consumer that will call methods on
PauseClusterRequest.Builder to create a request.
Describes a pause cluster operation. For example, a scheduled action to run the PauseCluster
API operation.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.AwsServiceExceptiondefault PurchaseReservedNodeOfferingResponse purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest) throws ReservedNodeOfferingNotFoundException, ReservedNodeAlreadyExistsException, ReservedNodeQuotaExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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.
purchaseReservedNodeOfferingRequest - 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.AwsServiceExceptiondefault PurchaseReservedNodeOfferingResponse purchaseReservedNodeOffering(Consumer<PurchaseReservedNodeOfferingRequest.Builder> purchaseReservedNodeOfferingRequest) throws ReservedNodeOfferingNotFoundException, ReservedNodeAlreadyExistsException, ReservedNodeQuotaExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via PurchaseReservedNodeOfferingRequest.builder()
purchaseReservedNodeOfferingRequest - A Consumer that will call methods on
PurchaseReservedNodeOfferingRequest.Builder to
create a request.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.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws ResourceNotFoundException, InvalidPolicyException, ConflictPolicyUpdateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Updates the resource policy for a specified resource.
putResourcePolicyRequest - 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.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws ResourceNotFoundException, InvalidPolicyException, ConflictPolicyUpdateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via PutResourcePolicyRequest.builder()
putResourcePolicyRequest - A Consumer that will call methods on
PutResourcePolicyRequest.Builder to create a
request.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.AwsServiceExceptiondefault RebootClusterResponse rebootCluster(RebootClusterRequest rebootClusterRequest) throws InvalidClusterStateException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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.
rebootClusterRequest - 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.AwsServiceExceptiondefault RebootClusterResponse rebootCluster(Consumer<RebootClusterRequest.Builder> rebootClusterRequest) throws InvalidClusterStateException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via RebootClusterRequest.builder()
rebootClusterRequest - A Consumer that will call methods on
RebootClusterRequest.Builder to create a request.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.AwsServiceExceptiondefault RejectDataShareResponse rejectDataShare(RejectDataShareRequest rejectDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, rejects the specified datashare.
rejectDataShareRequest - InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RejectDataShareResponse rejectDataShare(Consumer<RejectDataShareRequest.Builder> rejectDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, rejects the specified datashare.
This is a convenience which creates an instance of the RejectDataShareRequest.Builder avoiding the need
to create one manually via RejectDataShareRequest.builder()
rejectDataShareRequest - A Consumer that will call methods on
RejectDataShareRequest.Builder to create a request.InvalidDataShareException - There is an error with the datashare.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetClusterParameterGroupResponse resetClusterParameterGroup(ResetClusterParameterGroupRequest resetClusterParameterGroupRequest) throws InvalidClusterParameterGroupStateException, ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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.
resetClusterParameterGroupRequest - 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.AwsServiceExceptiondefault ResetClusterParameterGroupResponse resetClusterParameterGroup(Consumer<ResetClusterParameterGroupRequest.Builder> resetClusterParameterGroupRequest) throws InvalidClusterParameterGroupStateException, ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
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 via ResetClusterParameterGroupRequest.builder()
resetClusterParameterGroupRequest - A Consumer that will call methods on
ResetClusterParameterGroupRequest.Builder to create
a request.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.AwsServiceExceptiondefault ResizeClusterResponse resizeCluster(ResizeClusterRequest resizeClusterRequest) throws InvalidClusterStateException, ClusterNotFoundException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, InsufficientClusterCapacityException, UnsupportedOptionException, UnsupportedOperationException, UnauthorizedOperationException, LimitExceededException, ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, DependentServiceUnavailableException, ReservedNodeAlreadyExistsException, AwsServiceException, SdkClientException, RedshiftException
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.
resizeClusterRequest - Describes a resize cluster operation. For example, a scheduled action to run the
ResizeCluster API operation.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.AwsServiceExceptiondefault ResizeClusterResponse resizeCluster(Consumer<ResizeClusterRequest.Builder> resizeClusterRequest) throws InvalidClusterStateException, ClusterNotFoundException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, InsufficientClusterCapacityException, UnsupportedOptionException, UnsupportedOperationException, UnauthorizedOperationException, LimitExceededException, ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, DependentServiceUnavailableException, ReservedNodeAlreadyExistsException, AwsServiceException, SdkClientException, RedshiftException
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 via ResizeClusterRequest.builder()
resizeClusterRequest - A Consumer that will call methods on
ResizeClusterRequest.Builder to create a request.
Describes a resize cluster operation. For example, a scheduled action to run the
ResizeCluster API operation.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.AwsServiceExceptiondefault RestoreFromClusterSnapshotResponse restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest) throws AccessToSnapshotDeniedException, ClusterAlreadyExistsException, ClusterSnapshotNotFoundException, ClusterQuotaExceededException, InsufficientClusterCapacityException, InvalidClusterSnapshotStateException, InvalidRestoreException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, InvalidVpcNetworkStateException, InvalidClusterSubnetGroupStateException, InvalidSubnetException, ClusterSubnetGroupNotFoundException, UnauthorizedOperationException, HsmClientCertificateNotFoundException, HsmConfigurationNotFoundException, InvalidElasticIpException, ClusterParameterGroupNotFoundException, ClusterSecurityGroupNotFoundException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidClusterTrackException, SnapshotScheduleNotFoundException, TagLimitExceededException, InvalidTagException, ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, DependentServiceUnavailableException, ReservedNodeAlreadyExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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.
restoreFromClusterSnapshotRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreFromClusterSnapshotResponse restoreFromClusterSnapshot(Consumer<RestoreFromClusterSnapshotRequest.Builder> restoreFromClusterSnapshotRequest) throws AccessToSnapshotDeniedException, ClusterAlreadyExistsException, ClusterSnapshotNotFoundException, ClusterQuotaExceededException, InsufficientClusterCapacityException, InvalidClusterSnapshotStateException, InvalidRestoreException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, InvalidVpcNetworkStateException, InvalidClusterSubnetGroupStateException, InvalidSubnetException, ClusterSubnetGroupNotFoundException, UnauthorizedOperationException, HsmClientCertificateNotFoundException, HsmConfigurationNotFoundException, InvalidElasticIpException, ClusterParameterGroupNotFoundException, ClusterSecurityGroupNotFoundException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidClusterTrackException, SnapshotScheduleNotFoundException, TagLimitExceededException, InvalidTagException, ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, DependentServiceUnavailableException, ReservedNodeAlreadyExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via RestoreFromClusterSnapshotRequest.builder()
restoreFromClusterSnapshotRequest - A Consumer that will call methods on
RestoreFromClusterSnapshotRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreTableFromClusterSnapshotResponse restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest) throws ClusterSnapshotNotFoundException, InProgressTableRestoreQuotaExceededException, InvalidClusterSnapshotStateException, InvalidTableRestoreArgumentException, ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.
You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing
table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored
table. If you want to replace your original table with a new, restored table, then rename or drop your original
table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table,
then you can pass the original name of the table as the NewTableName parameter value in the call to
RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created
from the snapshot.
You can't use this operation to restore tables with interleaved sort keys.
restoreTableFromClusterSnapshotRequest - 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, or
sourceTableName 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.AwsServiceExceptiondefault RestoreTableFromClusterSnapshotResponse restoreTableFromClusterSnapshot(Consumer<RestoreTableFromClusterSnapshotRequest.Builder> restoreTableFromClusterSnapshotRequest) throws ClusterSnapshotNotFoundException, InProgressTableRestoreQuotaExceededException, InvalidClusterSnapshotStateException, InvalidTableRestoreArgumentException, ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.
You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing
table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored
table. If you want to replace your original table with a new, restored table, then rename or drop your original
table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table,
then you can pass the original name of the table as the NewTableName parameter value in the call to
RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created
from the snapshot.
You can't use this operation to restore tables with interleaved sort keys.
This is a convenience which creates an instance of the RestoreTableFromClusterSnapshotRequest.Builder
avoiding the need to create one manually via RestoreTableFromClusterSnapshotRequest.builder()
restoreTableFromClusterSnapshotRequest - A Consumer that will call methods on
RestoreTableFromClusterSnapshotRequest.Builder to
create a request.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, or
sourceTableName 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.AwsServiceExceptiondefault ResumeClusterResponse resumeCluster(ResumeClusterRequest resumeClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, InsufficientClusterCapacityException, AwsServiceException, SdkClientException, RedshiftException
Resumes a paused cluster.
resumeClusterRequest - Describes a resume cluster operation. For example, a scheduled action to run the
ResumeCluster API operation.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResumeClusterResponse resumeCluster(Consumer<ResumeClusterRequest.Builder> resumeClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, InsufficientClusterCapacityException, AwsServiceException, SdkClientException, RedshiftException
Resumes a paused cluster.
This is a convenience which creates an instance of the ResumeClusterRequest.Builder avoiding the need to
create one manually via ResumeClusterRequest.builder()
resumeClusterRequest - A Consumer that will call methods on
ResumeClusterRequest.Builder to create a request.
Describes a resume cluster operation. For example, a scheduled action to run the
ResumeCluster API operation.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RevokeClusterSecurityGroupIngressResponse revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest) throws ClusterSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidClusterSecurityGroupStateException, AwsServiceException, SdkClientException, RedshiftException
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.
revokeClusterSecurityGroupIngressRequest - 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.AwsServiceExceptiondefault RevokeClusterSecurityGroupIngressResponse revokeClusterSecurityGroupIngress(Consumer<RevokeClusterSecurityGroupIngressRequest.Builder> revokeClusterSecurityGroupIngressRequest) throws ClusterSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidClusterSecurityGroupStateException, AwsServiceException, SdkClientException, RedshiftException
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 via RevokeClusterSecurityGroupIngressRequest.builder()
revokeClusterSecurityGroupIngressRequest - A Consumer that will call methods on
RevokeClusterSecurityGroupIngressRequest.Builder to
create a request.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.AwsServiceExceptiondefault RevokeEndpointAccessResponse revokeEndpointAccess(RevokeEndpointAccessRequest revokeEndpointAccessRequest) throws ClusterNotFoundException, InvalidEndpointStateException, InvalidClusterSecurityGroupStateException, EndpointNotFoundException, EndpointAuthorizationNotFoundException, InvalidAuthorizationStateException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Revokes access to a cluster.
revokeEndpointAccessRequest - 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.AwsServiceExceptiondefault RevokeEndpointAccessResponse revokeEndpointAccess(Consumer<RevokeEndpointAccessRequest.Builder> revokeEndpointAccessRequest) throws ClusterNotFoundException, InvalidEndpointStateException, InvalidClusterSecurityGroupStateException, EndpointNotFoundException, EndpointAuthorizationNotFoundException, InvalidAuthorizationStateException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Revokes access to a cluster.
This is a convenience which creates an instance of the RevokeEndpointAccessRequest.Builder avoiding the
need to create one manually via RevokeEndpointAccessRequest.builder()
revokeEndpointAccessRequest - A Consumer that will call methods on
RevokeEndpointAccessRequest.Builder to create a
request.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.AwsServiceExceptiondefault RevokeSnapshotAccessResponse revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest) throws AccessToSnapshotDeniedException, AuthorizationNotFoundException, ClusterSnapshotNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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.
revokeSnapshotAccessRequest - 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.AwsServiceExceptiondefault RevokeSnapshotAccessResponse revokeSnapshotAccess(Consumer<RevokeSnapshotAccessRequest.Builder> revokeSnapshotAccessRequest) throws AccessToSnapshotDeniedException, AuthorizationNotFoundException, ClusterSnapshotNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
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 via RevokeSnapshotAccessRequest.builder()
revokeSnapshotAccessRequest - A Consumer that will call methods on
RevokeSnapshotAccessRequest.Builder to create a
request.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.AwsServiceExceptiondefault RotateEncryptionKeyResponse rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest) throws ClusterNotFoundException, InvalidClusterStateException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
Rotates the encryption keys for a cluster.
rotateEncryptionKeyRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RotateEncryptionKeyResponse rotateEncryptionKey(Consumer<RotateEncryptionKeyRequest.Builder> rotateEncryptionKeyRequest) throws ClusterNotFoundException, InvalidClusterStateException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
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 via RotateEncryptionKeyRequest.builder()
rotateEncryptionKeyRequest - A Consumer that will call methods on
RotateEncryptionKeyRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePartnerStatusResponse updatePartnerStatus(UpdatePartnerStatusRequest updatePartnerStatusRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, AwsServiceException, SdkClientException, RedshiftException
Updates the status of a partner integration.
updatePartnerStatusRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePartnerStatusResponse updatePartnerStatus(Consumer<UpdatePartnerStatusRequest.Builder> updatePartnerStatusRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, AwsServiceException, SdkClientException, RedshiftException
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 via UpdatePartnerStatusRequest.builder()
updatePartnerStatusRequest - A Consumer that will call methods on
UpdatePartnerStatusRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RedshiftWaiter waiter()
RedshiftWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
RedshiftWaiterstatic RedshiftClient create()
RedshiftClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static RedshiftClientBuilder builder()
RedshiftClient.static ServiceMetadata serviceMetadata()
default RedshiftServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.