Interface RedshiftClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacceptReservedNodeExchange
(Consumer<AcceptReservedNodeExchangeRequest.Builder> acceptReservedNodeExchangeRequest) Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.acceptReservedNodeExchange
(AcceptReservedNodeExchangeRequest acceptReservedNodeExchangeRequest) Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.default AddPartnerResponse
addPartner
(Consumer<AddPartnerRequest.Builder> addPartnerRequest) Adds a partner integration to a cluster.default AddPartnerResponse
addPartner
(AddPartnerRequest addPartnerRequest) Adds a partner integration to a cluster.associateDataShareConsumer
(Consumer<AssociateDataShareConsumerRequest.Builder> associateDataShareConsumerRequest) From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn).associateDataShareConsumer
(AssociateDataShareConsumerRequest associateDataShareConsumerRequest) From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn).authorizeClusterSecurityGroupIngress
(Consumer<AuthorizeClusterSecurityGroupIngressRequest.Builder> authorizeClusterSecurityGroupIngressRequest) Adds an inbound (ingress) rule to an Amazon Redshift security group.authorizeClusterSecurityGroupIngress
(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest) Adds an inbound (ingress) rule to an Amazon Redshift security group.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 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 AuthorizeEndpointAccessResponse
authorizeEndpointAccess
(Consumer<AuthorizeEndpointAccessRequest.Builder> authorizeEndpointAccessRequest) Grants access to a cluster.default AuthorizeEndpointAccessResponse
authorizeEndpointAccess
(AuthorizeEndpointAccessRequest authorizeEndpointAccessRequest) Grants access to a cluster.default AuthorizeSnapshotAccessResponse
authorizeSnapshotAccess
(Consumer<AuthorizeSnapshotAccessRequest.Builder> authorizeSnapshotAccessRequest) Authorizes the specified Amazon Web Services account to restore the specified snapshot.default AuthorizeSnapshotAccessResponse
authorizeSnapshotAccess
(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest) Authorizes the specified Amazon Web Services account to restore the specified snapshot.batchDeleteClusterSnapshots
(Consumer<BatchDeleteClusterSnapshotsRequest.Builder> batchDeleteClusterSnapshotsRequest) Deletes a set of cluster snapshots.batchDeleteClusterSnapshots
(BatchDeleteClusterSnapshotsRequest batchDeleteClusterSnapshotsRequest) Deletes a set of cluster snapshots.batchModifyClusterSnapshots
(Consumer<BatchModifyClusterSnapshotsRequest.Builder> batchModifyClusterSnapshotsRequest) Modifies the settings for a set of cluster snapshots.batchModifyClusterSnapshots
(BatchModifyClusterSnapshotsRequest batchModifyClusterSnapshotsRequest) Modifies the settings for a set of cluster snapshots.static RedshiftClientBuilder
builder()
Create a builder that can be used to configure and create aRedshiftClient
.default CancelResizeResponse
cancelResize
(Consumer<CancelResizeRequest.Builder> cancelResizeRequest) Cancels a resize operation for a cluster.default CancelResizeResponse
cancelResize
(CancelResizeRequest 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 aRedshiftClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAuthenticationProfile
(Consumer<CreateAuthenticationProfileRequest.Builder> createAuthenticationProfileRequest) Creates an authentication profile with the specified parameters.createAuthenticationProfile
(CreateAuthenticationProfileRequest createAuthenticationProfileRequest) Creates an authentication profile with the specified parameters.default 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.createClusterParameterGroup
(Consumer<CreateClusterParameterGroupRequest.Builder> createClusterParameterGroupRequest) Creates an Amazon Redshift parameter group.createClusterParameterGroup
(CreateClusterParameterGroupRequest createClusterParameterGroupRequest) Creates an Amazon Redshift parameter group.createClusterSecurityGroup
(Consumer<CreateClusterSecurityGroupRequest.Builder> createClusterSecurityGroupRequest) Creates a new Amazon Redshift security group.createClusterSecurityGroup
(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest) Creates a new Amazon Redshift security group.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.createCustomDomainAssociation
(Consumer<CreateCustomDomainAssociationRequest.Builder> createCustomDomainAssociationRequest) Used to create a custom domain name for a cluster.createCustomDomainAssociation
(CreateCustomDomainAssociationRequest createCustomDomainAssociationRequest) Used to create a custom domain name for a cluster.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.createHsmClientCertificate
(Consumer<CreateHsmClientCertificateRequest.Builder> createHsmClientCertificateRequest) Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.createHsmClientCertificate
(CreateHsmClientCertificateRequest createHsmClientCertificateRequest) Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.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).createRedshiftIdcApplication
(Consumer<CreateRedshiftIdcApplicationRequest.Builder> createRedshiftIdcApplicationRequest) Creates an Amazon Redshift application for use with IAM Identity Center.createRedshiftIdcApplication
(CreateRedshiftIdcApplicationRequest createRedshiftIdcApplicationRequest) Creates an Amazon Redshift application for use with IAM Identity Center.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.deleteAuthenticationProfile
(Consumer<DeleteAuthenticationProfileRequest.Builder> deleteAuthenticationProfileRequest) Deletes an authentication profile.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.deleteClusterParameterGroup
(Consumer<DeleteClusterParameterGroupRequest.Builder> deleteClusterParameterGroupRequest) Deletes a specified Amazon Redshift parameter group.deleteClusterParameterGroup
(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest) Deletes a specified Amazon Redshift parameter group.deleteClusterSecurityGroup
(Consumer<DeleteClusterSecurityGroupRequest.Builder> deleteClusterSecurityGroupRequest) Deletes an Amazon Redshift security group.deleteClusterSecurityGroup
(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest) Deletes an Amazon Redshift security group.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.deleteCustomDomainAssociation
(Consumer<DeleteCustomDomainAssociationRequest.Builder> deleteCustomDomainAssociationRequest) Contains information about deleting a custom domain association for a cluster.deleteCustomDomainAssociation
(DeleteCustomDomainAssociationRequest deleteCustomDomainAssociationRequest) Contains information about deleting a custom domain association for a cluster.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.deleteHsmClientCertificate
(Consumer<DeleteHsmClientCertificateRequest.Builder> deleteHsmClientCertificateRequest) Deletes the specified HSM client certificate.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.deleteRedshiftIdcApplication
(Consumer<DeleteRedshiftIdcApplicationRequest.Builder> deleteRedshiftIdcApplicationRequest) Deletes an Amazon Redshift IAM Identity Center application.deleteRedshiftIdcApplication
(DeleteRedshiftIdcApplicationRequest deleteRedshiftIdcApplicationRequest) Deletes an Amazon Redshift IAM Identity Center application.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.Returns a list of attributes attached to an accountdescribeAccountAttributes
(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Returns a list of attributes attached to an accountdescribeAccountAttributes
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Returns a list of attributes attached to an accountdescribeAuthenticationProfiles
(Consumer<DescribeAuthenticationProfilesRequest.Builder> describeAuthenticationProfilesRequest) Describes an authentication profile.describeAuthenticationProfiles
(DescribeAuthenticationProfilesRequest describeAuthenticationProfilesRequest) Describes an authentication profile.Returns an array ofClusterDbRevision
objects.describeClusterDbRevisions
(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) Returns an array ofClusterDbRevision
objects.describeClusterDbRevisions
(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) Returns an array ofClusterDbRevision
objects.This is a variant ofdescribeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation.describeClusterDbRevisionsPaginator
(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) This is a variant ofdescribeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation.describeClusterDbRevisionsPaginator
(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) This is a variant ofdescribeClusterDbRevisions(software.amazon.awssdk.services.redshift.model.DescribeClusterDbRevisionsRequest)
operation.Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.describeClusterParameterGroups
(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.describeClusterParameterGroups
(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.This is a variant ofdescribeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.describeClusterParameterGroupsPaginator
(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) This is a variant ofdescribeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.describeClusterParameterGroupsPaginator
(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) This is a variant ofdescribeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.describeClusterParameters
(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.describeClusterParameters
(DescribeClusterParametersRequest describeClusterParametersRequest) Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.describeClusterParametersPaginator
(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) This is a variant ofdescribeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation.describeClusterParametersPaginator
(DescribeClusterParametersRequest describeClusterParametersRequest) This is a variant ofdescribeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation.default DescribeClustersResponse
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.describeClusterSecurityGroups
(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) Returns information about Amazon Redshift security groups.describeClusterSecurityGroups
(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) Returns information about Amazon Redshift security groups.describeClusterSecurityGroupsPaginator
(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) This is a variant ofdescribeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation.describeClusterSecurityGroupsPaginator
(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) This is a variant ofdescribeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation.default DescribeClusterSnapshotsResponse
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
This is a variant ofdescribeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.default DescribeClusterSnapshotsIterable
describeClusterSnapshotsPaginator
(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) This is a variant ofdescribeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.default DescribeClusterSnapshotsIterable
describeClusterSnapshotsPaginator
(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) This is a variant ofdescribeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.default DescribeClustersIterable
This is a variant ofdescribeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.default DescribeClustersIterable
describeClustersPaginator
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.default DescribeClustersIterable
describeClustersPaginator
(DescribeClustersRequest describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.describeClusterSubnetGroups
(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.describeClusterSubnetGroups
(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.This is a variant ofdescribeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.describeClusterSubnetGroupsPaginator
(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) This is a variant ofdescribeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.describeClusterSubnetGroupsPaginator
(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) This is a variant ofdescribeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.default DescribeClusterTracksResponse
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
This is a variant ofdescribeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation.default DescribeClusterTracksIterable
describeClusterTracksPaginator
(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest) This is a variant ofdescribeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation.default DescribeClusterTracksIterable
describeClusterTracksPaginator
(DescribeClusterTracksRequest describeClusterTracksRequest) This is a variant ofdescribeClusterTracks(software.amazon.awssdk.services.redshift.model.DescribeClusterTracksRequest)
operation.default DescribeClusterVersionsResponse
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
This is a variant ofdescribeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.default DescribeClusterVersionsIterable
describeClusterVersionsPaginator
(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) This is a variant ofdescribeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.default DescribeClusterVersionsIterable
describeClusterVersionsPaginator
(DescribeClusterVersionsRequest describeClusterVersionsRequest) This is a variant ofdescribeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.describeCustomDomainAssociations
(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest) Contains information about custom domain associations for a cluster.describeCustomDomainAssociations
(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) Contains information about custom domain associations for a cluster.describeCustomDomainAssociationsPaginator
(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest) This is a variant ofdescribeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation.describeCustomDomainAssociationsPaginator
(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) This is a variant ofdescribeCustomDomainAssociations(software.amazon.awssdk.services.redshift.model.DescribeCustomDomainAssociationsRequest)
operation.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.describeDataSharesForConsumer
(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest) Returns a list of datashares where the account identifier being called is a consumer account identifier.describeDataSharesForConsumer
(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest) Returns a list of datashares where the account identifier being called is a consumer account identifier.describeDataSharesForConsumerPaginator
(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest) This is a variant ofdescribeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)
operation.describeDataSharesForConsumerPaginator
(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest) This is a variant ofdescribeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)
operation.describeDataSharesForProducer
(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest) Returns a list of datashares when the account identifier being called is a producer account identifier.describeDataSharesForProducer
(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest) Returns a list of datashares when the account identifier being called is a producer account identifier.describeDataSharesForProducerPaginator
(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest) This is a variant ofdescribeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)
operation.describeDataSharesForProducerPaginator
(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest) This is a variant ofdescribeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)
operation.default DescribeDataSharesIterable
describeDataSharesPaginator
(Consumer<DescribeDataSharesRequest.Builder> describeDataSharesRequest) This is a variant ofdescribeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)
operation.default DescribeDataSharesIterable
describeDataSharesPaginator
(DescribeDataSharesRequest describeDataSharesRequest) This is a variant ofdescribeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)
operation.describeDefaultClusterParameters
(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) Returns a list of parameter settings for the specified parameter group family.describeDefaultClusterParameters
(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) Returns a list of parameter settings for the specified parameter group family.describeDefaultClusterParametersPaginator
(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) This is a variant ofdescribeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation.describeDefaultClusterParametersPaginator
(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) This is a variant ofdescribeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation.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) This is a variant ofdescribeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation.default DescribeEndpointAccessIterable
describeEndpointAccessPaginator
(DescribeEndpointAccessRequest describeEndpointAccessRequest) This is a variant ofdescribeEndpointAccess(software.amazon.awssdk.services.redshift.model.DescribeEndpointAccessRequest)
operation.describeEndpointAuthorization
(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest) Describes an endpoint authorization.describeEndpointAuthorization
(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) Describes an endpoint authorization.describeEndpointAuthorizationPaginator
(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest) This is a variant ofdescribeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation.describeEndpointAuthorizationPaginator
(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) This is a variant ofdescribeEndpointAuthorization(software.amazon.awssdk.services.redshift.model.DescribeEndpointAuthorizationRequest)
operation.default DescribeEventCategoriesResponse
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
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
This is a variant ofdescribeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.describeEventSubscriptions
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.describeEventSubscriptions
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.Returns information about the specified HSM client certificate.describeHsmClientCertificates
(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) Returns information about the specified HSM client certificate.describeHsmClientCertificates
(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) Returns information about the specified HSM client certificate.This is a variant ofdescribeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.describeHsmClientCertificatesPaginator
(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) This is a variant ofdescribeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.describeHsmClientCertificatesPaginator
(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) This is a variant ofdescribeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.Returns information about the specified Amazon Redshift HSM configuration.describeHsmConfigurations
(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) Returns information about the specified Amazon Redshift HSM configuration.describeHsmConfigurations
(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) Returns information about the specified Amazon Redshift HSM configuration.This is a variant ofdescribeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.describeHsmConfigurationsPaginator
(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) This is a variant ofdescribeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.describeHsmConfigurationsPaginator
(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) This is a variant ofdescribeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.describeInboundIntegrations
(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest) Returns a list of inbound integrations.describeInboundIntegrations
(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) Returns a list of inbound integrations.describeInboundIntegrationsPaginator
(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest) This is a variant ofdescribeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation.describeInboundIntegrationsPaginator
(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) This is a variant ofdescribeInboundIntegrations(software.amazon.awssdk.services.redshift.model.DescribeInboundIntegrationsRequest)
operation.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.describeNodeConfigurationOptions
(Consumer<DescribeNodeConfigurationOptionsRequest.Builder> describeNodeConfigurationOptionsRequest) Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.describeNodeConfigurationOptions
(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest) Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.describeNodeConfigurationOptionsPaginator
(Consumer<DescribeNodeConfigurationOptionsRequest.Builder> describeNodeConfigurationOptionsRequest) This is a variant ofdescribeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation.describeNodeConfigurationOptionsPaginator
(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest) This is a variant ofdescribeNodeConfigurationOptions(software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest)
operation.Returns a list of orderable cluster options.describeOrderableClusterOptions
(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) Returns a list of orderable cluster options.describeOrderableClusterOptions
(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) Returns a list of orderable cluster options.This is a variant ofdescribeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.describeOrderableClusterOptionsPaginator
(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) This is a variant ofdescribeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.describeOrderableClusterOptionsPaginator
(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) This is a variant ofdescribeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.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.describeRedshiftIdcApplications
(Consumer<DescribeRedshiftIdcApplicationsRequest.Builder> describeRedshiftIdcApplicationsRequest) Lists the Amazon Redshift IAM Identity Center applications.describeRedshiftIdcApplications
(DescribeRedshiftIdcApplicationsRequest describeRedshiftIdcApplicationsRequest) Lists the Amazon Redshift IAM Identity Center applications.describeRedshiftIdcApplicationsPaginator
(Consumer<DescribeRedshiftIdcApplicationsRequest.Builder> describeRedshiftIdcApplicationsRequest) This is a variant ofdescribeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation.describeRedshiftIdcApplicationsPaginator
(DescribeRedshiftIdcApplicationsRequest describeRedshiftIdcApplicationsRequest) This is a variant ofdescribeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation.describeReservedNodeExchangeStatus
(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest) Returns exchange status details and associated metadata for a reserved-node exchange.describeReservedNodeExchangeStatus
(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest) Returns exchange status details and associated metadata for a reserved-node exchange.describeReservedNodeExchangeStatusPaginator
(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest) This is a variant ofdescribeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation.describeReservedNodeExchangeStatusPaginator
(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest) This is a variant ofdescribeReservedNodeExchangeStatus(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeExchangeStatusRequest)
operation.Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.describeReservedNodeOfferings
(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.describeReservedNodeOfferings
(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.This is a variant ofdescribeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.describeReservedNodeOfferingsPaginator
(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) This is a variant ofdescribeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.describeReservedNodeOfferingsPaginator
(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) This is a variant ofdescribeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.default DescribeReservedNodesResponse
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
This is a variant ofdescribeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.default DescribeReservedNodesIterable
describeReservedNodesPaginator
(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) This is a variant ofdescribeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.default DescribeReservedNodesIterable
describeReservedNodesPaginator
(DescribeReservedNodesRequest describeReservedNodesRequest) This is a variant ofdescribeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.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) This is a variant ofdescribeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation.default DescribeScheduledActionsIterable
describeScheduledActionsPaginator
(DescribeScheduledActionsRequest describeScheduledActionsRequest) This is a variant ofdescribeScheduledActions(software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest)
operation.Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.describeSnapshotCopyGrants
(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.describeSnapshotCopyGrants
(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.This is a variant ofdescribeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation.describeSnapshotCopyGrantsPaginator
(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) This is a variant ofdescribeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation.describeSnapshotCopyGrantsPaginator
(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) This is a variant ofdescribeSnapshotCopyGrants(software.amazon.awssdk.services.redshift.model.DescribeSnapshotCopyGrantsRequest)
operation.Returns a list of snapshot schedules.describeSnapshotSchedules
(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest) Returns a list of snapshot schedules.describeSnapshotSchedules
(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) Returns a list of snapshot schedules.This is a variant ofdescribeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation.describeSnapshotSchedulesPaginator
(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest) This is a variant ofdescribeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation.describeSnapshotSchedulesPaginator
(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) This is a variant ofdescribeSnapshotSchedules(software.amazon.awssdk.services.redshift.model.DescribeSnapshotSchedulesRequest)
operation.default DescribeStorageResponse
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.describeTableRestoreStatus
(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action.describeTableRestoreStatus
(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action.describeTableRestoreStatusPaginator
(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) This is a variant ofdescribeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation.describeTableRestoreStatusPaginator
(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) This is a variant ofdescribeTableRestoreStatus(software.amazon.awssdk.services.redshift.model.DescribeTableRestoreStatusRequest)
operation.default DescribeTagsResponse
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
This is a variant ofdescribeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation.default DescribeTagsIterable
describeTagsPaginator
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) This is a variant ofdescribeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation.default DescribeTagsIterable
describeTagsPaginator
(DescribeTagsRequest describeTagsRequest) This is a variant ofdescribeTags(software.amazon.awssdk.services.redshift.model.DescribeTagsRequest)
operation.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) This is a variant ofdescribeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation.default DescribeUsageLimitsIterable
describeUsageLimitsPaginator
(DescribeUsageLimitsRequest describeUsageLimitsRequest) This is a variant ofdescribeUsageLimits(software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest)
operation.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.disassociateDataShareConsumer
(Consumer<DisassociateDataShareConsumerRequest.Builder> disassociateDataShareConsumerRequest) From a datashare consumer account, remove association for the specified datashare.disassociateDataShareConsumer
(DisassociateDataShareConsumerRequest disassociateDataShareConsumerRequest) From a datashare consumer account, remove association for the specified datashare.default 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 FailoverPrimaryComputeResponse
failoverPrimaryCompute
(Consumer<FailoverPrimaryComputeRequest.Builder> failoverPrimaryComputeRequest) Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.default FailoverPrimaryComputeResponse
failoverPrimaryCompute
(FailoverPrimaryComputeRequest failoverPrimaryComputeRequest) Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.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.getClusterCredentialsWithIAM
(Consumer<GetClusterCredentialsWithIamRequest.Builder> getClusterCredentialsWithIamRequest) Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database.getClusterCredentialsWithIAM
(GetClusterCredentialsWithIamRequest getClusterCredentialsWithIamRequest) Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database.getReservedNodeExchangeConfigurationOptions
(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest) Gets the configuration options for the reserved-node exchange.getReservedNodeExchangeConfigurationOptions
(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest) Gets the configuration options for the reserved-node exchange.getReservedNodeExchangeConfigurationOptionsPaginator
(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest) getReservedNodeExchangeConfigurationOptionsPaginator
(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest) getReservedNodeExchangeOfferings
(Consumer<GetReservedNodeExchangeOfferingsRequest.Builder> getReservedNodeExchangeOfferingsRequest) Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.getReservedNodeExchangeOfferings
(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest) Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.getReservedNodeExchangeOfferingsPaginator
(Consumer<GetReservedNodeExchangeOfferingsRequest.Builder> getReservedNodeExchangeOfferingsRequest) This is a variant ofgetReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation.getReservedNodeExchangeOfferingsPaginator
(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest) This is a variant ofgetReservedNodeExchangeOfferings(software.amazon.awssdk.services.redshift.model.GetReservedNodeExchangeOfferingsRequest)
operation.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 ListRecommendationsResponse
listRecommendations
(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest) List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.default ListRecommendationsResponse
listRecommendations
(ListRecommendationsRequest listRecommendationsRequest) List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.default ListRecommendationsIterable
listRecommendationsPaginator
(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest) This is a variant oflistRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation.default ListRecommendationsIterable
listRecommendationsPaginator
(ListRecommendationsRequest listRecommendationsRequest) This is a variant oflistRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation.default ModifyAquaConfigurationResponse
modifyAquaConfiguration
(Consumer<ModifyAquaConfigurationRequest.Builder> modifyAquaConfigurationRequest) This operation is retired.default ModifyAquaConfigurationResponse
modifyAquaConfiguration
(ModifyAquaConfigurationRequest modifyAquaConfigurationRequest) This operation is retired.modifyAuthenticationProfile
(Consumer<ModifyAuthenticationProfileRequest.Builder> modifyAuthenticationProfileRequest) Modifies an authentication profile.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.modifyClusterParameterGroup
(Consumer<ModifyClusterParameterGroupRequest.Builder> modifyClusterParameterGroupRequest) Modifies the parameters of a parameter group.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.modifyClusterSnapshotSchedule
(Consumer<ModifyClusterSnapshotScheduleRequest.Builder> modifyClusterSnapshotScheduleRequest) Modifies a snapshot schedule for a cluster.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.modifyCustomDomainAssociation
(Consumer<ModifyCustomDomainAssociationRequest.Builder> modifyCustomDomainAssociationRequest) Contains information for changing a custom domain association.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.modifyRedshiftIdcApplication
(Consumer<ModifyRedshiftIdcApplicationRequest.Builder> modifyRedshiftIdcApplicationRequest) Changes an existing Amazon Redshift IAM Identity Center application.modifyRedshiftIdcApplication
(ModifyRedshiftIdcApplicationRequest modifyRedshiftIdcApplicationRequest) Changes an existing Amazon Redshift IAM Identity Center application.default ModifyScheduledActionResponse
modifyScheduledAction
(Consumer<ModifyScheduledActionRequest.Builder> modifyScheduledActionRequest) Modifies a scheduled action.default ModifyScheduledActionResponse
modifyScheduledAction
(ModifyScheduledActionRequest modifyScheduledActionRequest) Modifies a scheduled action.modifySnapshotCopyRetentionPeriod
(Consumer<ModifySnapshotCopyRetentionPeriodRequest.Builder> modifySnapshotCopyRetentionPeriodRequest) Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.modifySnapshotCopyRetentionPeriod
(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest) Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.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.purchaseReservedNodeOffering
(Consumer<PurchaseReservedNodeOfferingRequest.Builder> purchaseReservedNodeOfferingRequest) Allows you to purchase reserved nodes.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.resetClusterParameterGroup
(Consumer<ResetClusterParameterGroupRequest.Builder> resetClusterParameterGroupRequest) Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default".resetClusterParameterGroup
(ResetClusterParameterGroupRequest resetClusterParameterGroupRequest) Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default".default ResizeClusterResponse
resizeCluster
(Consumer<ResizeClusterRequest.Builder> resizeClusterRequest) Changes the size of the cluster.default ResizeClusterResponse
resizeCluster
(ResizeClusterRequest resizeClusterRequest) Changes the size of the cluster.restoreFromClusterSnapshot
(Consumer<RestoreFromClusterSnapshotRequest.Builder> restoreFromClusterSnapshotRequest) Creates a new cluster from a snapshot.restoreFromClusterSnapshot
(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest) Creates a new cluster from a snapshot.restoreTableFromClusterSnapshot
(Consumer<RestoreTableFromClusterSnapshotRequest.Builder> restoreTableFromClusterSnapshotRequest) Creates a new table from a table in an Amazon Redshift cluster snapshot.restoreTableFromClusterSnapshot
(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest) Creates a new table from a table in an Amazon Redshift cluster snapshot.default ResumeClusterResponse
resumeCluster
(Consumer<ResumeClusterRequest.Builder> resumeClusterRequest) Resumes a paused cluster.default ResumeClusterResponse
resumeCluster
(ResumeClusterRequest resumeClusterRequest) Resumes a paused cluster.revokeClusterSecurityGroupIngress
(Consumer<RevokeClusterSecurityGroupIngressRequest.Builder> revokeClusterSecurityGroupIngressRequest) Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group.revokeClusterSecurityGroupIngress
(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest) Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group.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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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 ofRedshiftWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acceptReservedNodeExchange
default 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.
- Parameters:
acceptReservedNodeExchangeRequest
-- Returns:
- Result of the AcceptReservedNodeExchange operation returned by the service.
- See Also:
-
acceptReservedNodeExchange
default 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 viaAcceptReservedNodeExchangeRequest.builder()
- Parameters:
acceptReservedNodeExchangeRequest
- AConsumer
that will call methods onAcceptReservedNodeExchangeRequest.Builder
to create a request.- Returns:
- Result of the AcceptReservedNodeExchange operation returned by the service.
- See Also:
-
addPartner
default AddPartnerResponse addPartner(AddPartnerRequest addPartnerRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, UnsupportedOperationException, 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.
- Parameters:
addPartnerRequest
-- Returns:
- Result of the AddPartner operation returned by the service.
- See Also:
-
addPartner
default AddPartnerResponse addPartner(Consumer<AddPartnerRequest.Builder> addPartnerRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, UnsupportedOperationException, 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 viaAddPartnerRequest.builder()
- Parameters:
addPartnerRequest
- AConsumer
that will call methods onAddPartnerRequest.Builder
to create a request.- Returns:
- Result of the AddPartner operation returned by the service.
- See Also:
-
authorizeClusterSecurityGroupIngress
default 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.
- Parameters:
authorizeClusterSecurityGroupIngressRequest
-- Returns:
- Result of the AuthorizeClusterSecurityGroupIngress operation returned by the service.
- See Also:
-
authorizeClusterSecurityGroupIngress
default 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 viaAuthorizeClusterSecurityGroupIngressRequest.builder()
- Parameters:
authorizeClusterSecurityGroupIngressRequest
- AConsumer
that will call methods onAuthorizeClusterSecurityGroupIngressRequest.Builder
to create a request.- Returns:
- Result of the AuthorizeClusterSecurityGroupIngress operation returned by the service.
- See Also:
-
authorizeEndpointAccess
default AuthorizeEndpointAccessResponse authorizeEndpointAccess(AuthorizeEndpointAccessRequest authorizeEndpointAccessRequest) throws ClusterNotFoundException, EndpointAuthorizationsPerClusterLimitExceededException, UnsupportedOperationException, EndpointAuthorizationAlreadyExistsException, InvalidAuthorizationStateException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException Grants access to a cluster.
- Parameters:
authorizeEndpointAccessRequest
-- Returns:
- Result of the AuthorizeEndpointAccess operation returned by the service.
- See Also:
-
authorizeEndpointAccess
default 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 viaAuthorizeEndpointAccessRequest.builder()
- Parameters:
authorizeEndpointAccessRequest
- AConsumer
that will call methods onAuthorizeEndpointAccessRequest.Builder
to create a request.- Returns:
- Result of the AuthorizeEndpointAccess operation returned by the service.
- See Also:
-
authorizeSnapshotAccess
default 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.
- Parameters:
authorizeSnapshotAccessRequest
-- Returns:
- Result of the AuthorizeSnapshotAccess operation returned by the service.
- See Also:
-
authorizeSnapshotAccess
default 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 viaAuthorizeSnapshotAccessRequest.builder()
- Parameters:
authorizeSnapshotAccessRequest
- AConsumer
that will call methods onAuthorizeSnapshotAccessRequest.Builder
to create a request.- Returns:
- Result of the AuthorizeSnapshotAccess operation returned by the service.
- See Also:
-
batchDeleteClusterSnapshots
default BatchDeleteClusterSnapshotsResponse batchDeleteClusterSnapshots(BatchDeleteClusterSnapshotsRequest batchDeleteClusterSnapshotsRequest) throws BatchDeleteRequestSizeExceededException, AwsServiceException, SdkClientException, RedshiftException Deletes a set of cluster snapshots.
- Parameters:
batchDeleteClusterSnapshotsRequest
-- Returns:
- Result of the BatchDeleteClusterSnapshots operation returned by the service.
- See Also:
-
batchDeleteClusterSnapshots
default 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 viaBatchDeleteClusterSnapshotsRequest.builder()
- Parameters:
batchDeleteClusterSnapshotsRequest
- AConsumer
that will call methods onBatchDeleteClusterSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteClusterSnapshots operation returned by the service.
- See Also:
-
batchModifyClusterSnapshots
default BatchModifyClusterSnapshotsResponse batchModifyClusterSnapshots(BatchModifyClusterSnapshotsRequest batchModifyClusterSnapshotsRequest) throws InvalidRetentionPeriodException, BatchModifyClusterSnapshotsLimitExceededException, AwsServiceException, SdkClientException, RedshiftException Modifies the settings for a set of cluster snapshots.
- Parameters:
batchModifyClusterSnapshotsRequest
-- Returns:
- Result of the BatchModifyClusterSnapshots operation returned by the service.
- See Also:
-
batchModifyClusterSnapshots
default 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 viaBatchModifyClusterSnapshotsRequest.builder()
- Parameters:
batchModifyClusterSnapshotsRequest
- AConsumer
that will call methods onBatchModifyClusterSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the BatchModifyClusterSnapshots operation returned by the service.
- See Also:
-
cancelResize
default CancelResizeResponse cancelResize(CancelResizeRequest cancelResizeRequest) throws ClusterNotFoundException, ResizeNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Cancels a resize operation for a cluster.
- Parameters:
cancelResizeRequest
-- Returns:
- Result of the CancelResize operation returned by the service.
- See Also:
-
cancelResize
default 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 viaCancelResizeRequest.builder()
- Parameters:
cancelResizeRequest
- AConsumer
that will call methods onCancelResizeRequest.Builder
to create a request.- Returns:
- Result of the CancelResize operation returned by the service.
- See Also:
-
copyClusterSnapshot
default CopyClusterSnapshotResponse copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest) throws ClusterNotFoundException, 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.
- Parameters:
copyClusterSnapshotRequest
-- Returns:
- Result of the CopyClusterSnapshot operation returned by the service.
- See Also:
-
copyClusterSnapshot
default CopyClusterSnapshotResponse copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest) throws ClusterNotFoundException, 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 viaCopyClusterSnapshotRequest.builder()
- Parameters:
copyClusterSnapshotRequest
- AConsumer
that will call methods onCopyClusterSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CopyClusterSnapshot operation returned by the service.
- See Also:
-
createAuthenticationProfile
default CreateAuthenticationProfileResponse createAuthenticationProfile(CreateAuthenticationProfileRequest createAuthenticationProfileRequest) throws AuthenticationProfileAlreadyExistsException, AuthenticationProfileQuotaExceededException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException Creates an authentication profile with the specified parameters.
- Parameters:
createAuthenticationProfileRequest
-- Returns:
- Result of the CreateAuthenticationProfile operation returned by the service.
- See Also:
-
createAuthenticationProfile
default 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 viaCreateAuthenticationProfileRequest.builder()
- Parameters:
createAuthenticationProfileRequest
- AConsumer
that will call methods onCreateAuthenticationProfileRequest.Builder
to create a request.- Returns:
- Result of the CreateAuthenticationProfile operation returned by the service.
- See Also:
-
createCluster
default 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, Ipv6CidrBlockNotFoundException, UnsupportedOperationException, RedshiftIdcApplicationNotExistsException, 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.
- Parameters:
createClusterRequest
-- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createCluster
default 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, Ipv6CidrBlockNotFoundException, UnsupportedOperationException, RedshiftIdcApplicationNotExistsException, 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 viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createClusterParameterGroup
default 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.
- Parameters:
createClusterParameterGroupRequest
-- Returns:
- Result of the CreateClusterParameterGroup operation returned by the service.
- See Also:
-
createClusterParameterGroup
default 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 viaCreateClusterParameterGroupRequest.builder()
- Parameters:
createClusterParameterGroupRequest
- AConsumer
that will call methods onCreateClusterParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateClusterParameterGroup operation returned by the service.
- See Also:
-
createClusterSecurityGroup
default 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.
- Parameters:
createClusterSecurityGroupRequest
-- Returns:
- Result of the CreateClusterSecurityGroup operation returned by the service.
- See Also:
-
createClusterSecurityGroup
default 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 viaCreateClusterSecurityGroupRequest.builder()
- Parameters:
createClusterSecurityGroupRequest
- AConsumer
that will call methods onCreateClusterSecurityGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateClusterSecurityGroup operation returned by the service.
- See Also:
-
createClusterSnapshot
default 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.
- Parameters:
createClusterSnapshotRequest
-- Returns:
- Result of the CreateClusterSnapshot operation returned by the service.
- See Also:
-
createClusterSnapshot
default 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 viaCreateClusterSnapshotRequest.builder()
- Parameters:
createClusterSnapshotRequest
- AConsumer
that will call methods onCreateClusterSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CreateClusterSnapshot operation returned by the service.
- See Also:
-
createClusterSubnetGroup
default 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.
- Parameters:
createClusterSubnetGroupRequest
-- Returns:
- Result of the CreateClusterSubnetGroup operation returned by the service.
- See Also:
-
createClusterSubnetGroup
default 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 viaCreateClusterSubnetGroupRequest.builder()
- Parameters:
createClusterSubnetGroupRequest
- AConsumer
that will call methods onCreateClusterSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateClusterSubnetGroup operation returned by the service.
- See Also:
-
createCustomDomainAssociation
default 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).
- Parameters:
createCustomDomainAssociationRequest
-- Returns:
- Result of the CreateCustomDomainAssociation operation returned by the service.
- See Also:
-
createCustomDomainAssociation
default 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 viaCreateCustomDomainAssociationRequest.builder()
- Parameters:
createCustomDomainAssociationRequest
- AConsumer
that will call methods onCreateCustomDomainAssociationRequest.Builder
to create a request.- Returns:
- Result of the CreateCustomDomainAssociation operation returned by the service.
- See Also:
-
createEndpointAccess
default CreateEndpointAccessResponse createEndpointAccess(CreateEndpointAccessRequest createEndpointAccessRequest) throws ClusterNotFoundException, AccessToClusterDeniedException, EndpointsPerClusterLimitExceededException, EndpointsPerAuthorizationLimitExceededException, InvalidClusterSecurityGroupStateException, ClusterSubnetGroupNotFoundException, EndpointAlreadyExistsException, UnsupportedOperationException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException Creates a Redshift-managed VPC endpoint.
- Parameters:
createEndpointAccessRequest
-- Returns:
- Result of the CreateEndpointAccess operation returned by the service.
- See Also:
-
createEndpointAccess
default 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 viaCreateEndpointAccessRequest.builder()
- Parameters:
createEndpointAccessRequest
- AConsumer
that will call methods onCreateEndpointAccessRequest.Builder
to create a request.- Returns:
- Result of the CreateEndpointAccess operation returned by the service.
- See Also:
-
createEventSubscription
default 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.
- Parameters:
createEventSubscriptionRequest
-- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- See Also:
-
createEventSubscription
default 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 viaCreateEventSubscriptionRequest.builder()
- Parameters:
createEventSubscriptionRequest
- AConsumer
that will call methods onCreateEventSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- See Also:
-
createHsmClientCertificate
default 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.
- Parameters:
createHsmClientCertificateRequest
-- Returns:
- Result of the CreateHsmClientCertificate operation returned by the service.
- See Also:
-
createHsmClientCertificate
default 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 viaCreateHsmClientCertificateRequest.builder()
- Parameters:
createHsmClientCertificateRequest
- AConsumer
that will call methods onCreateHsmClientCertificateRequest.Builder
to create a request.- Returns:
- Result of the CreateHsmClientCertificate operation returned by the service.
- See Also:
-
createHsmConfiguration
default 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.
- Parameters:
createHsmConfigurationRequest
-- Returns:
- Result of the CreateHsmConfiguration operation returned by the service.
- See Also:
-
createHsmConfiguration
default 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 viaCreateHsmConfigurationRequest.builder()
- Parameters:
createHsmConfigurationRequest
- AConsumer
that will call methods onCreateHsmConfigurationRequest.Builder
to create a request.- Returns:
- Result of the CreateHsmConfiguration operation returned by the service.
- See Also:
-
createRedshiftIdcApplication
default CreateRedshiftIdcApplicationResponse createRedshiftIdcApplication(CreateRedshiftIdcApplicationRequest createRedshiftIdcApplicationRequest) throws RedshiftIdcApplicationAlreadyExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, RedshiftIdcApplicationQuotaExceededException, AwsServiceException, SdkClientException, RedshiftException Creates an Amazon Redshift application for use with IAM Identity Center.
- Parameters:
createRedshiftIdcApplicationRequest
-- Returns:
- Result of the CreateRedshiftIdcApplication operation returned by the service.
- See Also:
-
createRedshiftIdcApplication
default CreateRedshiftIdcApplicationResponse createRedshiftIdcApplication(Consumer<CreateRedshiftIdcApplicationRequest.Builder> createRedshiftIdcApplicationRequest) throws RedshiftIdcApplicationAlreadyExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, RedshiftIdcApplicationQuotaExceededException, AwsServiceException, SdkClientException, RedshiftException Creates an Amazon Redshift application for use with IAM Identity Center.
This is a convenience which creates an instance of the
CreateRedshiftIdcApplicationRequest.Builder
avoiding the need to create one manually viaCreateRedshiftIdcApplicationRequest.builder()
- Parameters:
createRedshiftIdcApplicationRequest
- AConsumer
that will call methods onCreateRedshiftIdcApplicationRequest.Builder
to create a request.- Returns:
- Result of the CreateRedshiftIdcApplication operation returned by the service.
- See Also:
-
createScheduledAction
default CreateScheduledActionResponse createScheduledAction(CreateScheduledActionRequest createScheduledActionRequest) throws ClusterNotFoundException, ScheduledActionAlreadyExistsException, ScheduledActionQuotaExceededException, ScheduledActionTypeUnsupportedException, InvalidScheduleException, InvalidScheduledActionException, UnauthorizedOperationException, UnsupportedOperationException, 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.- Parameters:
createScheduledActionRequest
-- Returns:
- Result of the CreateScheduledAction operation returned by the service.
- See Also:
-
createScheduledAction
default CreateScheduledActionResponse createScheduledAction(Consumer<CreateScheduledActionRequest.Builder> createScheduledActionRequest) throws ClusterNotFoundException, ScheduledActionAlreadyExistsException, ScheduledActionQuotaExceededException, ScheduledActionTypeUnsupportedException, InvalidScheduleException, InvalidScheduledActionException, UnauthorizedOperationException, UnsupportedOperationException, 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 viaCreateScheduledActionRequest.builder()
- Parameters:
createScheduledActionRequest
- AConsumer
that will call methods onCreateScheduledActionRequest.Builder
to create a request.- Returns:
- Result of the CreateScheduledAction operation returned by the service.
- See Also:
-
createSnapshotCopyGrant
default 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.
- Parameters:
createSnapshotCopyGrantRequest
- The result of theCreateSnapshotCopyGrant
action.- Returns:
- Result of the CreateSnapshotCopyGrant operation returned by the service.
- See Also:
-
createSnapshotCopyGrant
default 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 viaCreateSnapshotCopyGrantRequest.builder()
- Parameters:
createSnapshotCopyGrantRequest
- AConsumer
that will call methods onCreateSnapshotCopyGrantRequest.Builder
to create a request. The result of theCreateSnapshotCopyGrant
action.- Returns:
- Result of the CreateSnapshotCopyGrant operation returned by the service.
- See Also:
-
createSnapshotSchedule
default 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.
- Parameters:
createSnapshotScheduleRequest
-- Returns:
- Result of the CreateSnapshotSchedule operation returned by the service.
- See Also:
-
createSnapshotSchedule
default 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 viaCreateSnapshotScheduleRequest.builder()
- Parameters:
createSnapshotScheduleRequest
- AConsumer
that will call methods onCreateSnapshotScheduleRequest.Builder
to create a request.- Returns:
- Result of the CreateSnapshotSchedule operation returned by the service.
- See Also:
-
createTags
default 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.
- Parameters:
createTagsRequest
- Contains the output from theCreateTags
action.- Returns:
- Result of the CreateTags operation returned by the service.
- See Also:
-
createTags
default 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 viaCreateTagsRequest.builder()
- Parameters:
createTagsRequest
- AConsumer
that will call methods onCreateTagsRequest.Builder
to create a request. Contains the output from theCreateTags
action.- Returns:
- Result of the CreateTags operation returned by the service.
- See Also:
-
createUsageLimit
default 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.
- Parameters:
createUsageLimitRequest
-- Returns:
- Result of the CreateUsageLimit operation returned by the service.
- See Also:
-
createUsageLimit
default 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 viaCreateUsageLimitRequest.builder()
- Parameters:
createUsageLimitRequest
- AConsumer
that will call methods onCreateUsageLimitRequest.Builder
to create a request.- Returns:
- Result of the CreateUsageLimit operation returned by the service.
- See Also:
-
deleteAuthenticationProfile
default DeleteAuthenticationProfileResponse deleteAuthenticationProfile(DeleteAuthenticationProfileRequest deleteAuthenticationProfileRequest) throws AuthenticationProfileNotFoundException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException Deletes an authentication profile.
- Parameters:
deleteAuthenticationProfileRequest
-- Returns:
- Result of the DeleteAuthenticationProfile operation returned by the service.
- See Also:
-
deleteAuthenticationProfile
default 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 viaDeleteAuthenticationProfileRequest.builder()
- Parameters:
deleteAuthenticationProfileRequest
- AConsumer
that will call methods onDeleteAuthenticationProfileRequest.Builder
to create a request.- Returns:
- Result of the DeleteAuthenticationProfile operation returned by the service.
- See Also:
-
deleteCluster
default 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.
- Parameters:
deleteClusterRequest
-- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteCluster
default 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 viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.Builder
to create a request.- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteClusterParameterGroup
default 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.
- Parameters:
deleteClusterParameterGroupRequest
-- Returns:
- Result of the DeleteClusterParameterGroup operation returned by the service.
- See Also:
-
deleteClusterParameterGroup
default 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 viaDeleteClusterParameterGroupRequest.builder()
- Parameters:
deleteClusterParameterGroupRequest
- AConsumer
that will call methods onDeleteClusterParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteClusterParameterGroup operation returned by the service.
- See Also:
-
deleteClusterSecurityGroup
default 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.
- Parameters:
deleteClusterSecurityGroupRequest
-- Returns:
- Result of the DeleteClusterSecurityGroup operation returned by the service.
- See Also:
-
deleteClusterSecurityGroup
default 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 viaDeleteClusterSecurityGroupRequest.builder()
- Parameters:
deleteClusterSecurityGroupRequest
- AConsumer
that will call methods onDeleteClusterSecurityGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteClusterSecurityGroup operation returned by the service.
- See Also:
-
deleteClusterSnapshot
default 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.
- Parameters:
deleteClusterSnapshotRequest
-- Returns:
- Result of the DeleteClusterSnapshot operation returned by the service.
- See Also:
-
deleteClusterSnapshot
default 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 viaDeleteClusterSnapshotRequest.builder()
- Parameters:
deleteClusterSnapshotRequest
- AConsumer
that will call methods onDeleteClusterSnapshotRequest.Builder
to create a request.- Returns:
- Result of the DeleteClusterSnapshot operation returned by the service.
- See Also:
-
deleteClusterSubnetGroup
default DeleteClusterSubnetGroupResponse deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest) throws InvalidClusterSubnetGroupStateException, InvalidClusterSubnetStateException, ClusterSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException Deletes the specified cluster subnet group.
- Parameters:
deleteClusterSubnetGroupRequest
-- Returns:
- Result of the DeleteClusterSubnetGroup operation returned by the service.
- See Also:
-
deleteClusterSubnetGroup
default 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 viaDeleteClusterSubnetGroupRequest.builder()
- Parameters:
deleteClusterSubnetGroupRequest
- AConsumer
that will call methods onDeleteClusterSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteClusterSubnetGroup operation returned by the service.
- See Also:
-
deleteCustomDomainAssociation
default DeleteCustomDomainAssociationResponse deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest deleteCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, CustomDomainAssociationNotFoundException, AwsServiceException, SdkClientException, RedshiftException Contains information about deleting a custom domain association for a cluster.
- Parameters:
deleteCustomDomainAssociationRequest
-- Returns:
- Result of the DeleteCustomDomainAssociation operation returned by the service.
- See Also:
-
deleteCustomDomainAssociation
default DeleteCustomDomainAssociationResponse deleteCustomDomainAssociation(Consumer<DeleteCustomDomainAssociationRequest.Builder> deleteCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, CustomDomainAssociationNotFoundException, 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 viaDeleteCustomDomainAssociationRequest.builder()
- Parameters:
deleteCustomDomainAssociationRequest
- AConsumer
that will call methods onDeleteCustomDomainAssociationRequest.Builder
to create a request.- Returns:
- Result of the DeleteCustomDomainAssociation operation returned by the service.
- See Also:
-
deleteEndpointAccess
default DeleteEndpointAccessResponse deleteEndpointAccess(DeleteEndpointAccessRequest deleteEndpointAccessRequest) throws ClusterNotFoundException, InvalidEndpointStateException, InvalidClusterSecurityGroupStateException, EndpointNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException Deletes a Redshift-managed VPC endpoint.
- Parameters:
deleteEndpointAccessRequest
-- Returns:
- Result of the DeleteEndpointAccess operation returned by the service.
- See Also:
-
deleteEndpointAccess
default 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 viaDeleteEndpointAccessRequest.builder()
- Parameters:
deleteEndpointAccessRequest
- AConsumer
that will call methods onDeleteEndpointAccessRequest.Builder
to create a request.- Returns:
- Result of the DeleteEndpointAccess operation returned by the service.
- See Also:
-
deleteEventSubscription
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidSubscriptionStateException, AwsServiceException, SdkClientException, RedshiftException Deletes an Amazon Redshift event notification subscription.
- Parameters:
deleteEventSubscriptionRequest
-- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- See Also:
-
deleteEventSubscription
default 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 viaDeleteEventSubscriptionRequest.builder()
- Parameters:
deleteEventSubscriptionRequest
- AConsumer
that will call methods onDeleteEventSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- See Also:
-
deleteHsmClientCertificate
default DeleteHsmClientCertificateResponse deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest) throws InvalidHsmClientCertificateStateException, HsmClientCertificateNotFoundException, AwsServiceException, SdkClientException, RedshiftException Deletes the specified HSM client certificate.
- Parameters:
deleteHsmClientCertificateRequest
-- Returns:
- Result of the DeleteHsmClientCertificate operation returned by the service.
- See Also:
-
deleteHsmClientCertificate
default 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 viaDeleteHsmClientCertificateRequest.builder()
- Parameters:
deleteHsmClientCertificateRequest
- AConsumer
that will call methods onDeleteHsmClientCertificateRequest.Builder
to create a request.- Returns:
- Result of the DeleteHsmClientCertificate operation returned by the service.
- See Also:
-
deleteHsmConfiguration
default DeleteHsmConfigurationResponse deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest) throws InvalidHsmConfigurationStateException, HsmConfigurationNotFoundException, AwsServiceException, SdkClientException, RedshiftException Deletes the specified Amazon Redshift HSM configuration.
- Parameters:
deleteHsmConfigurationRequest
-- Returns:
- Result of the DeleteHsmConfiguration operation returned by the service.
- See Also:
-
deleteHsmConfiguration
default 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 viaDeleteHsmConfigurationRequest.builder()
- Parameters:
deleteHsmConfigurationRequest
- AConsumer
that will call methods onDeleteHsmConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteHsmConfiguration operation returned by the service.
- See Also:
-
deletePartner
default DeletePartnerResponse deletePartner(DeletePartnerRequest deletePartnerRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, UnsupportedOperationException, 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.
- Parameters:
deletePartnerRequest
-- Returns:
- Result of the DeletePartner operation returned by the service.
- See Also:
-
deletePartner
default DeletePartnerResponse deletePartner(Consumer<DeletePartnerRequest.Builder> deletePartnerRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, UnsupportedOperationException, 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 viaDeletePartnerRequest.builder()
- Parameters:
deletePartnerRequest
- AConsumer
that will call methods onDeletePartnerRequest.Builder
to create a request.- Returns:
- Result of the DeletePartner operation returned by the service.
- See Also:
-
deleteRedshiftIdcApplication
default DeleteRedshiftIdcApplicationResponse deleteRedshiftIdcApplication(DeleteRedshiftIdcApplicationRequest deleteRedshiftIdcApplicationRequest) throws RedshiftIdcApplicationNotExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, AwsServiceException, SdkClientException, RedshiftException Deletes an Amazon Redshift IAM Identity Center application.
- Parameters:
deleteRedshiftIdcApplicationRequest
-- Returns:
- Result of the DeleteRedshiftIdcApplication operation returned by the service.
- See Also:
-
deleteRedshiftIdcApplication
default DeleteRedshiftIdcApplicationResponse deleteRedshiftIdcApplication(Consumer<DeleteRedshiftIdcApplicationRequest.Builder> deleteRedshiftIdcApplicationRequest) throws RedshiftIdcApplicationNotExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, AwsServiceException, SdkClientException, RedshiftException Deletes an Amazon Redshift IAM Identity Center application.
This is a convenience which creates an instance of the
DeleteRedshiftIdcApplicationRequest.Builder
avoiding the need to create one manually viaDeleteRedshiftIdcApplicationRequest.builder()
- Parameters:
deleteRedshiftIdcApplicationRequest
- AConsumer
that will call methods onDeleteRedshiftIdcApplicationRequest.Builder
to create a request.- Returns:
- Result of the DeleteRedshiftIdcApplication operation returned by the service.
- See Also:
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws ResourceNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Deletes the resource policy for a specified resource.
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- See Also:
-
deleteResourcePolicy
default 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 viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- See Also:
-
deleteScheduledAction
default DeleteScheduledActionResponse deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException Deletes a scheduled action.
- Parameters:
deleteScheduledActionRequest
-- Returns:
- Result of the DeleteScheduledAction operation returned by the service.
- See Also:
-
deleteScheduledAction
default 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 viaDeleteScheduledActionRequest.builder()
- Parameters:
deleteScheduledActionRequest
- AConsumer
that will call methods onDeleteScheduledActionRequest.Builder
to create a request.- Returns:
- Result of the DeleteScheduledAction operation returned by the service.
- See Also:
-
deleteSnapshotCopyGrant
default DeleteSnapshotCopyGrantResponse deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest) throws InvalidSnapshotCopyGrantStateException, SnapshotCopyGrantNotFoundException, AwsServiceException, SdkClientException, RedshiftException Deletes the specified snapshot copy grant.
- Parameters:
deleteSnapshotCopyGrantRequest
- The result of theDeleteSnapshotCopyGrant
action.- Returns:
- Result of the DeleteSnapshotCopyGrant operation returned by the service.
- See Also:
-
deleteSnapshotCopyGrant
default 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 viaDeleteSnapshotCopyGrantRequest.builder()
- Parameters:
deleteSnapshotCopyGrantRequest
- AConsumer
that will call methods onDeleteSnapshotCopyGrantRequest.Builder
to create a request. The result of theDeleteSnapshotCopyGrant
action.- Returns:
- Result of the DeleteSnapshotCopyGrant operation returned by the service.
- See Also:
-
deleteSnapshotSchedule
default DeleteSnapshotScheduleResponse deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest) throws InvalidClusterSnapshotScheduleStateException, SnapshotScheduleNotFoundException, AwsServiceException, SdkClientException, RedshiftException Deletes a snapshot schedule.
- Parameters:
deleteSnapshotScheduleRequest
-- Returns:
- Result of the DeleteSnapshotSchedule operation returned by the service.
- See Also:
-
deleteSnapshotSchedule
default 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 viaDeleteSnapshotScheduleRequest.builder()
- Parameters:
deleteSnapshotScheduleRequest
- AConsumer
that will call methods onDeleteSnapshotScheduleRequest.Builder
to create a request.- Returns:
- Result of the DeleteSnapshotSchedule operation returned by the service.
- See Also:
-
deleteTags
default 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.
- Parameters:
deleteTagsRequest
- Contains the output from theDeleteTags
action.- Returns:
- Result of the DeleteTags operation returned by the service.
- See Also:
-
deleteTags
default 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 viaDeleteTagsRequest.builder()
- Parameters:
deleteTagsRequest
- AConsumer
that will call methods onDeleteTagsRequest.Builder
to create a request. Contains the output from theDeleteTags
action.- Returns:
- Result of the DeleteTags operation returned by the service.
- See Also:
-
deleteUsageLimit
default DeleteUsageLimitResponse deleteUsageLimit(DeleteUsageLimitRequest deleteUsageLimitRequest) throws UsageLimitNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Deletes a usage limit from a cluster.
- Parameters:
deleteUsageLimitRequest
-- Returns:
- Result of the DeleteUsageLimit operation returned by the service.
- See Also:
-
deleteUsageLimit
default 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 viaDeleteUsageLimitRequest.builder()
- Parameters:
deleteUsageLimitRequest
- AConsumer
that will call methods onDeleteUsageLimitRequest.Builder
to create a request.- Returns:
- Result of the DeleteUsageLimit operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws AwsServiceException, SdkClientException, RedshiftException Returns a list of attributes attached to an account
- Parameters:
describeAccountAttributesRequest
-- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributes
default 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 viaDescribeAccountAttributesRequest.builder()
- Parameters:
describeAccountAttributesRequest
- AConsumer
that will call methods onDescribeAccountAttributesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes() throws AwsServiceException, SdkClientException, RedshiftExceptionReturns a list of attributes attached to an account
- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAuthenticationProfiles
default DescribeAuthenticationProfilesResponse describeAuthenticationProfiles(DescribeAuthenticationProfilesRequest describeAuthenticationProfilesRequest) throws AuthenticationProfileNotFoundException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException Describes an authentication profile.
- Parameters:
describeAuthenticationProfilesRequest
-- Returns:
- Result of the DescribeAuthenticationProfiles operation returned by the service.
- See Also:
-
describeAuthenticationProfiles
default 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 viaDescribeAuthenticationProfilesRequest.builder()
- Parameters:
describeAuthenticationProfilesRequest
- AConsumer
that will call methods onDescribeAuthenticationProfilesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAuthenticationProfiles operation returned by the service.
- See Also:
-
describeClusterDbRevisions
default DescribeClusterDbRevisionsResponse describeClusterDbRevisions(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException Returns an array of
ClusterDbRevision
objects.- Parameters:
describeClusterDbRevisionsRequest
-- Returns:
- Result of the DescribeClusterDbRevisions operation returned by the service.
- See Also:
-
describeClusterDbRevisions
default 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 viaDescribeClusterDbRevisionsRequest.builder()
- Parameters:
describeClusterDbRevisionsRequest
- AConsumer
that will call methods onDescribeClusterDbRevisionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterDbRevisions operation returned by the service.
- See Also:
-
describeClusterDbRevisions
default DescribeClusterDbRevisionsResponse describeClusterDbRevisions() throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftExceptionReturns an array of
ClusterDbRevision
objects.- Returns:
- Result of the DescribeClusterDbRevisions operation returned by the service.
- See Also:
-
describeClusterDbRevisionsPaginator
default DescribeClusterDbRevisionsIterable describeClusterDbRevisionsPaginator() throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client.describeClusterDbRevisionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterDbRevisionsPaginator
default DescribeClusterDbRevisionsIterable describeClusterDbRevisionsPaginator(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client.describeClusterDbRevisionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeClusterDbRevisionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterDbRevisionsPaginator
default DescribeClusterDbRevisionsIterable describeClusterDbRevisionsPaginator(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterDbRevisionsIterable responses = client.describeClusterDbRevisionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeClusterDbRevisionsRequest.builder()
- Parameters:
describeClusterDbRevisionsRequest
- AConsumer
that will call methods onDescribeClusterDbRevisionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterParameterGroups
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all parameter groups that have any combination of those values are returned.If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
- Parameters:
describeClusterParameterGroupsRequest
-- Returns:
- Result of the DescribeClusterParameterGroups operation returned by the service.
- See Also:
-
describeClusterParameterGroups
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all parameter groups that have any combination of those values are returned.If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the
DescribeClusterParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeClusterParameterGroupsRequest.builder()
- Parameters:
describeClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterParameterGroups operation returned by the service.
- See Also:
-
describeClusterParameterGroups
default DescribeClusterParameterGroupsResponse describeClusterParameterGroups() throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionReturns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all parameter groups that have any combination of those values are returned.If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
- Returns:
- Result of the DescribeClusterParameterGroups operation returned by the service.
- See Also:
-
describeClusterParameterGroupsPaginator
default DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator() throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterParameterGroupsPaginator
default DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeClusterParameterGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterParameterGroupsPaginator
default DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeClusterParameterGroupsRequest.builder()
- Parameters:
describeClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterParameters
default 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.
- Parameters:
describeClusterParametersRequest
-- Returns:
- Result of the DescribeClusterParameters operation returned by the service.
- See Also:
-
describeClusterParameters
default 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 viaDescribeClusterParametersRequest.builder()
- Parameters:
describeClusterParametersRequest
- AConsumer
that will call methods onDescribeClusterParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterParameters operation returned by the service.
- See Also:
-
describeClusterParametersPaginator
default DescribeClusterParametersIterable describeClusterParametersPaginator(DescribeClusterParametersRequest describeClusterParametersRequest) throws ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeClusterParametersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterParametersPaginator
default DescribeClusterParametersIterable describeClusterParametersPaginator(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) throws ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeClusterParametersRequest.builder()
- Parameters:
describeClusterParametersRequest
- AConsumer
that will call methods onDescribeClusterParametersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterSecurityGroups
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all security groups that have any combination of those values are returned.If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
- Parameters:
describeClusterSecurityGroupsRequest
-- Returns:
- Result of the DescribeClusterSecurityGroups operation returned by the service.
- See Also:
-
describeClusterSecurityGroups
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all security groups that have any combination of those values are returned.If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the
DescribeClusterSecurityGroupsRequest.Builder
avoiding the need to create one manually viaDescribeClusterSecurityGroupsRequest.builder()
- Parameters:
describeClusterSecurityGroupsRequest
- AConsumer
that will call methods onDescribeClusterSecurityGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterSecurityGroups operation returned by the service.
- See Also:
-
describeClusterSecurityGroupsPaginator
default DescribeClusterSecurityGroupsIterable describeClusterSecurityGroupsPaginator(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeClusterSecurityGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterSecurityGroupsPaginator
default DescribeClusterSecurityGroupsIterable describeClusterSecurityGroupsPaginator(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeClusterSecurityGroupsRequest.builder()
- Parameters:
describeClusterSecurityGroupsRequest
- AConsumer
that will call methods onDescribeClusterSecurityGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterSnapshots
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
- Parameters:
describeClusterSnapshotsRequest
-- Returns:
- Result of the DescribeClusterSnapshots operation returned by the service.
- See Also:
-
describeClusterSnapshots
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the
DescribeClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeClusterSnapshotsRequest.builder()
- Parameters:
describeClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeClusterSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterSnapshots operation returned by the service.
- See Also:
-
describeClusterSnapshots
default DescribeClusterSnapshotsResponse describeClusterSnapshots() throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftExceptionReturns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
- Returns:
- Result of the DescribeClusterSnapshots operation returned by the service.
- See Also:
-
describeClusterSnapshotsPaginator
default DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator() throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterSnapshotsPaginator
default DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeClusterSnapshotsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterSnapshotsPaginator
default DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeClusterSnapshotsRequest.builder()
- Parameters:
describeClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterSubnetGroups
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all subnet groups that have any combination of those values are returned.If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
- Parameters:
describeClusterSubnetGroupsRequest
-- Returns:
- Result of the DescribeClusterSubnetGroups operation returned by the service.
- See Also:
-
describeClusterSubnetGroups
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all subnet groups that have any combination of those values are returned.If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the
DescribeClusterSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeClusterSubnetGroupsRequest.builder()
- Parameters:
describeClusterSubnetGroupsRequest
- AConsumer
that will call methods onDescribeClusterSubnetGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterSubnetGroups operation returned by the service.
- See Also:
-
describeClusterSubnetGroups
default DescribeClusterSubnetGroupsResponse describeClusterSubnetGroups() throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionReturns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all subnet groups that have any combination of those values are returned.If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
- Returns:
- Result of the DescribeClusterSubnetGroups operation returned by the service.
- See Also:
-
describeClusterSubnetGroupsPaginator
default DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator() throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterSubnetGroupsPaginator
default DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeClusterSubnetGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterSubnetGroupsPaginator
default DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeClusterSubnetGroupsRequest.builder()
- Parameters:
describeClusterSubnetGroupsRequest
- AConsumer
that will call methods onDescribeClusterSubnetGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterTracks
default DescribeClusterTracksResponse describeClusterTracks(DescribeClusterTracksRequest describeClusterTracksRequest) throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException Returns a list of all the available maintenance tracks.
- Parameters:
describeClusterTracksRequest
-- Returns:
- Result of the DescribeClusterTracks operation returned by the service.
- See Also:
-
describeClusterTracks
default 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 viaDescribeClusterTracksRequest.builder()
- Parameters:
describeClusterTracksRequest
- AConsumer
that will call methods onDescribeClusterTracksRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterTracks operation returned by the service.
- See Also:
-
describeClusterTracks
default DescribeClusterTracksResponse describeClusterTracks() throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftExceptionReturns a list of all the available maintenance tracks.
- Returns:
- Result of the DescribeClusterTracks operation returned by the service.
- See Also:
-
describeClusterTracksPaginator
default DescribeClusterTracksIterable describeClusterTracksPaginator() throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client.describeClusterTracksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterTracksPaginator
default DescribeClusterTracksIterable describeClusterTracksPaginator(DescribeClusterTracksRequest describeClusterTracksRequest) throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client.describeClusterTracksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeClusterTracksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterTracksPaginator
default DescribeClusterTracksIterable describeClusterTracksPaginator(Consumer<DescribeClusterTracksRequest.Builder> describeClusterTracksRequest) throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterTracksIterable responses = client.describeClusterTracksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeClusterTracksRequest.builder()
- Parameters:
describeClusterTracksRequest
- AConsumer
that will call methods onDescribeClusterTracksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterVersions
default 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.
- Parameters:
describeClusterVersionsRequest
-- Returns:
- Result of the DescribeClusterVersions operation returned by the service.
- See Also:
-
describeClusterVersions
default 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 viaDescribeClusterVersionsRequest.builder()
- Parameters:
describeClusterVersionsRequest
- AConsumer
that will call methods onDescribeClusterVersionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterVersions operation returned by the service.
- See Also:
-
describeClusterVersions
default DescribeClusterVersionsResponse describeClusterVersions() throws AwsServiceException, SdkClientException, RedshiftExceptionReturns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
- Returns:
- Result of the DescribeClusterVersions operation returned by the service.
- See Also:
-
describeClusterVersionsPaginator
default DescribeClusterVersionsIterable describeClusterVersionsPaginator() throws AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterVersionsPaginator
default DescribeClusterVersionsIterable describeClusterVersionsPaginator(DescribeClusterVersionsRequest describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeClusterVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusterVersionsPaginator
default DescribeClusterVersionsIterable describeClusterVersionsPaginator(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeClusterVersionsRequest.builder()
- Parameters:
describeClusterVersionsRequest
- AConsumer
that will call methods onDescribeClusterVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusters
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all clusters that have any combination of those values are returned.If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
- Parameters:
describeClustersRequest
-- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClusters
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all clusters that have any combination of those values are returned.If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters() throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionReturns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all clusters that have any combination of those values are returned.If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClustersPaginator
default DescribeClustersIterable describeClustersPaginator() throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClustersPaginator
default DescribeClustersIterable describeClustersPaginator(DescribeClustersRequest describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClustersPaginator
default DescribeClustersIterable describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCustomDomainAssociations
default DescribeCustomDomainAssociationsResponse describeCustomDomainAssociations(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) throws CustomDomainAssociationNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Contains information about custom domain associations for a cluster.
- Parameters:
describeCustomDomainAssociationsRequest
-- Returns:
- Result of the DescribeCustomDomainAssociations operation returned by the service.
- See Also:
-
describeCustomDomainAssociations
default 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 viaDescribeCustomDomainAssociationsRequest.builder()
- Parameters:
describeCustomDomainAssociationsRequest
- AConsumer
that will call methods onDescribeCustomDomainAssociationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeCustomDomainAssociations operation returned by the service.
- See Also:
-
describeCustomDomainAssociationsPaginator
default DescribeCustomDomainAssociationsIterable describeCustomDomainAssociationsPaginator(DescribeCustomDomainAssociationsRequest describeCustomDomainAssociationsRequest) throws CustomDomainAssociationNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsIterable responses = client.describeCustomDomainAssociationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeCustomDomainAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCustomDomainAssociationsPaginator
default DescribeCustomDomainAssociationsIterable describeCustomDomainAssociationsPaginator(Consumer<DescribeCustomDomainAssociationsRequest.Builder> describeCustomDomainAssociationsRequest) throws CustomDomainAssociationNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeCustomDomainAssociationsIterable responses = client.describeCustomDomainAssociationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeCustomDomainAssociationsRequest.builder()
- Parameters:
describeCustomDomainAssociationsRequest
- AConsumer
that will call methods onDescribeCustomDomainAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDefaultClusterParameters
default 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.
- Parameters:
describeDefaultClusterParametersRequest
-- Returns:
- Result of the DescribeDefaultClusterParameters operation returned by the service.
- See Also:
-
describeDefaultClusterParameters
default 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 viaDescribeDefaultClusterParametersRequest.builder()
- Parameters:
describeDefaultClusterParametersRequest
- AConsumer
that will call methods onDescribeDefaultClusterParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeDefaultClusterParameters operation returned by the service.
- See Also:
-
describeDefaultClusterParametersPaginator
default DescribeDefaultClusterParametersIterable describeDefaultClusterParametersPaginator(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeDefaultClusterParametersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDefaultClusterParametersPaginator
default DescribeDefaultClusterParametersIterable describeDefaultClusterParametersPaginator(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeDefaultClusterParametersRequest.builder()
- Parameters:
describeDefaultClusterParametersRequest
- AConsumer
that will call methods onDescribeDefaultClusterParametersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEndpointAccess
default DescribeEndpointAccessResponse describeEndpointAccess(DescribeEndpointAccessRequest describeEndpointAccessRequest) throws ClusterNotFoundException, InvalidClusterStateException, EndpointNotFoundException, AwsServiceException, SdkClientException, RedshiftException Describes a Redshift-managed VPC endpoint.
- Parameters:
describeEndpointAccessRequest
-- Returns:
- Result of the DescribeEndpointAccess operation returned by the service.
- See Also:
-
describeEndpointAccess
default 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 viaDescribeEndpointAccessRequest.builder()
- Parameters:
describeEndpointAccessRequest
- AConsumer
that will call methods onDescribeEndpointAccessRequest.Builder
to create a request.- Returns:
- Result of the DescribeEndpointAccess operation returned by the service.
- See Also:
-
describeEndpointAccessPaginator
default DescribeEndpointAccessIterable describeEndpointAccessPaginator(DescribeEndpointAccessRequest describeEndpointAccessRequest) throws ClusterNotFoundException, InvalidClusterStateException, EndpointNotFoundException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessIterable responses = client.describeEndpointAccessPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeEndpointAccessRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEndpointAccessPaginator
default DescribeEndpointAccessIterable describeEndpointAccessPaginator(Consumer<DescribeEndpointAccessRequest.Builder> describeEndpointAccessRequest) throws ClusterNotFoundException, InvalidClusterStateException, EndpointNotFoundException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEndpointAccessIterable responses = client.describeEndpointAccessPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeEndpointAccessRequest.builder()
- Parameters:
describeEndpointAccessRequest
- AConsumer
that will call methods onDescribeEndpointAccessRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEndpointAuthorization
default DescribeEndpointAuthorizationResponse describeEndpointAuthorization(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Describes an endpoint authorization.
- Parameters:
describeEndpointAuthorizationRequest
-- Returns:
- Result of the DescribeEndpointAuthorization operation returned by the service.
- See Also:
-
describeEndpointAuthorization
default 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 viaDescribeEndpointAuthorizationRequest.builder()
- Parameters:
describeEndpointAuthorizationRequest
- AConsumer
that will call methods onDescribeEndpointAuthorizationRequest.Builder
to create a request.- Returns:
- Result of the DescribeEndpointAuthorization operation returned by the service.
- See Also:
-
describeEndpointAuthorizationPaginator
default DescribeEndpointAuthorizationIterable describeEndpointAuthorizationPaginator(DescribeEndpointAuthorizationRequest describeEndpointAuthorizationRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationIterable responses = client.describeEndpointAuthorizationPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeEndpointAuthorizationRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEndpointAuthorizationPaginator
default DescribeEndpointAuthorizationIterable describeEndpointAuthorizationPaginator(Consumer<DescribeEndpointAuthorizationRequest.Builder> describeEndpointAuthorizationRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEndpointAuthorizationIterable responses = client.describeEndpointAuthorizationPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeEndpointAuthorizationRequest.builder()
- Parameters:
describeEndpointAuthorizationRequest
- AConsumer
that will call methods onDescribeEndpointAuthorizationRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventCategories
default 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.
- Parameters:
describeEventCategoriesRequest
-- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventCategories
default 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 viaDescribeEventCategoriesRequest.builder()
- Parameters:
describeEventCategoriesRequest
- AConsumer
that will call methods onDescribeEventCategoriesRequest.Builder
to create a request.- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, RedshiftExceptionDisplays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventSubscriptions
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all subscriptions that have any combination of those values are returned.If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptions
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all subscriptions that have any combination of those values are returned.If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions() throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionLists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all subscriptions that have any combination of those values are returned.If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEvents
default 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.
- Parameters:
describeEventsRequest
-- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default 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 viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, RedshiftExceptionReturns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeHsmClientCertificates
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all HSM client certificates that have any combination of those values are returned.If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
- Parameters:
describeHsmClientCertificatesRequest
-- Returns:
- Result of the DescribeHsmClientCertificates operation returned by the service.
- See Also:
-
describeHsmClientCertificates
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all HSM client certificates that have any combination of those values are returned.If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the
DescribeHsmClientCertificatesRequest.Builder
avoiding the need to create one manually viaDescribeHsmClientCertificatesRequest.builder()
- Parameters:
describeHsmClientCertificatesRequest
- AConsumer
that will call methods onDescribeHsmClientCertificatesRequest.Builder
to create a request.- Returns:
- Result of the DescribeHsmClientCertificates operation returned by the service.
- See Also:
-
describeHsmClientCertificates
default DescribeHsmClientCertificatesResponse describeHsmClientCertificates() throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionReturns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all HSM client certificates that have any combination of those values are returned.If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
- Returns:
- Result of the DescribeHsmClientCertificates operation returned by the service.
- See Also:
-
describeHsmClientCertificatesPaginator
default DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator() throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeHsmClientCertificatesPaginator
default DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeHsmClientCertificatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeHsmClientCertificatesPaginator
default DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeHsmClientCertificatesRequest.builder()
- Parameters:
describeHsmClientCertificatesRequest
- AConsumer
that will call methods onDescribeHsmClientCertificatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeHsmConfigurations
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all HSM connections that have any combination of those values are returned.If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
- Parameters:
describeHsmConfigurationsRequest
-- Returns:
- Result of the DescribeHsmConfigurations operation returned by the service.
- See Also:
-
describeHsmConfigurations
default 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
andenvironment
for tag keys, andadmin
andtest
for tag values, all HSM connections that have any combination of those values are returned.If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the
DescribeHsmConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeHsmConfigurationsRequest.builder()
- Parameters:
describeHsmConfigurationsRequest
- AConsumer
that will call methods onDescribeHsmConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeHsmConfigurations operation returned by the service.
- See Also:
-
describeHsmConfigurations
default DescribeHsmConfigurationsResponse describeHsmConfigurations() throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionReturns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all HSM connections that have any combination of those values are returned.If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
- Returns:
- Result of the DescribeHsmConfigurations operation returned by the service.
- See Also:
-
describeHsmConfigurationsPaginator
default DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator() throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeHsmConfigurationsPaginator
default DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeHsmConfigurationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeHsmConfigurationsPaginator
default DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeHsmConfigurationsRequest.builder()
- Parameters:
describeHsmConfigurationsRequest
- AConsumer
that will call methods onDescribeHsmConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeInboundIntegrations
default DescribeInboundIntegrationsResponse describeInboundIntegrations(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) throws IntegrationNotFoundException, InvalidNamespaceException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Returns a list of inbound integrations.
- Parameters:
describeInboundIntegrationsRequest
-- Returns:
- Result of the DescribeInboundIntegrations operation returned by the service.
- See Also:
-
describeInboundIntegrations
default 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 viaDescribeInboundIntegrationsRequest.builder()
- Parameters:
describeInboundIntegrationsRequest
- AConsumer
that will call methods onDescribeInboundIntegrationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeInboundIntegrations operation returned by the service.
- See Also:
-
describeInboundIntegrationsPaginator
default DescribeInboundIntegrationsIterable describeInboundIntegrationsPaginator(DescribeInboundIntegrationsRequest describeInboundIntegrationsRequest) throws IntegrationNotFoundException, InvalidNamespaceException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsIterable responses = client.describeInboundIntegrationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeInboundIntegrationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeInboundIntegrationsPaginator
default DescribeInboundIntegrationsIterable describeInboundIntegrationsPaginator(Consumer<DescribeInboundIntegrationsRequest.Builder> describeInboundIntegrationsRequest) throws IntegrationNotFoundException, InvalidNamespaceException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeInboundIntegrationsIterable responses = client.describeInboundIntegrationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeInboundIntegrationsRequest.builder()
- Parameters:
describeInboundIntegrationsRequest
- AConsumer
that will call methods onDescribeInboundIntegrationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLoggingStatus
default DescribeLoggingStatusResponse describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
- Parameters:
describeLoggingStatusRequest
-- Returns:
- Result of the DescribeLoggingStatus operation returned by the service.
- See Also:
-
describeLoggingStatus
default DescribeLoggingStatusResponse describeLoggingStatus(Consumer<DescribeLoggingStatusRequest.Builder> describeLoggingStatusRequest) throws ClusterNotFoundException, UnsupportedOperationException, 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 viaDescribeLoggingStatusRequest.builder()
- Parameters:
describeLoggingStatusRequest
- AConsumer
that will call methods onDescribeLoggingStatusRequest.Builder
to create a request.- Returns:
- Result of the DescribeLoggingStatus operation returned by the service.
- See Also:
-
describeNodeConfigurationOptions
default 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.
- Parameters:
describeNodeConfigurationOptionsRequest
-- Returns:
- Result of the DescribeNodeConfigurationOptions operation returned by the service.
- See Also:
-
describeNodeConfigurationOptions
default 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 viaDescribeNodeConfigurationOptionsRequest.builder()
- Parameters:
describeNodeConfigurationOptionsRequest
- AConsumer
that will call methods onDescribeNodeConfigurationOptionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeNodeConfigurationOptions operation returned by the service.
- See Also:
-
describeNodeConfigurationOptionsPaginator
default DescribeNodeConfigurationOptionsIterable describeNodeConfigurationOptionsPaginator(DescribeNodeConfigurationOptionsRequest describeNodeConfigurationOptionsRequest) throws ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterNotFoundException, AccessToSnapshotDeniedException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsIterable responses = client.describeNodeConfigurationOptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeNodeConfigurationOptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeNodeConfigurationOptionsPaginator
default DescribeNodeConfigurationOptionsIterable describeNodeConfigurationOptionsPaginator(Consumer<DescribeNodeConfigurationOptionsRequest.Builder> describeNodeConfigurationOptionsRequest) throws ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterNotFoundException, AccessToSnapshotDeniedException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeNodeConfigurationOptionsIterable responses = client.describeNodeConfigurationOptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeNodeConfigurationOptionsRequest.builder()
- Parameters:
describeNodeConfigurationOptionsRequest
- AConsumer
that will call methods onDescribeNodeConfigurationOptionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOrderableClusterOptions
default 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.
- Parameters:
describeOrderableClusterOptionsRequest
-- Returns:
- Result of the DescribeOrderableClusterOptions operation returned by the service.
- See Also:
-
describeOrderableClusterOptions
default 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 viaDescribeOrderableClusterOptionsRequest.builder()
- Parameters:
describeOrderableClusterOptionsRequest
- AConsumer
that will call methods onDescribeOrderableClusterOptionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeOrderableClusterOptions operation returned by the service.
- See Also:
-
describeOrderableClusterOptions
default DescribeOrderableClusterOptionsResponse describeOrderableClusterOptions() throws AwsServiceException, SdkClientException, RedshiftExceptionReturns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
- Returns:
- Result of the DescribeOrderableClusterOptions operation returned by the service.
- See Also:
-
describeOrderableClusterOptionsPaginator
default DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator() throws AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOrderableClusterOptionsPaginator
default DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeOrderableClusterOptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOrderableClusterOptionsPaginator
default DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeOrderableClusterOptionsRequest.builder()
- Parameters:
describeOrderableClusterOptionsRequest
- AConsumer
that will call methods onDescribeOrderableClusterOptionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePartners
default DescribePartnersResponse describePartners(DescribePartnersRequest describePartnersRequest) throws ClusterNotFoundException, UnauthorizedPartnerIntegrationException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Returns information about the partner integrations defined for a cluster.
- Parameters:
describePartnersRequest
-- Returns:
- Result of the DescribePartners operation returned by the service.
- See Also:
-
describePartners
default DescribePartnersResponse describePartners(Consumer<DescribePartnersRequest.Builder> describePartnersRequest) throws ClusterNotFoundException, UnauthorizedPartnerIntegrationException, UnsupportedOperationException, 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 viaDescribePartnersRequest.builder()
- Parameters:
describePartnersRequest
- AConsumer
that will call methods onDescribePartnersRequest.Builder
to create a request.- Returns:
- Result of the DescribePartners operation returned by the service.
- See Also:
-
describeRedshiftIdcApplications
default DescribeRedshiftIdcApplicationsResponse describeRedshiftIdcApplications(DescribeRedshiftIdcApplicationsRequest describeRedshiftIdcApplicationsRequest) throws RedshiftIdcApplicationNotExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, AwsServiceException, SdkClientException, RedshiftException Lists the Amazon Redshift IAM Identity Center applications.
- Parameters:
describeRedshiftIdcApplicationsRequest
-- Returns:
- Result of the DescribeRedshiftIdcApplications operation returned by the service.
- See Also:
-
describeRedshiftIdcApplications
default DescribeRedshiftIdcApplicationsResponse describeRedshiftIdcApplications(Consumer<DescribeRedshiftIdcApplicationsRequest.Builder> describeRedshiftIdcApplicationsRequest) throws RedshiftIdcApplicationNotExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, AwsServiceException, SdkClientException, RedshiftException Lists the Amazon Redshift IAM Identity Center applications.
This is a convenience which creates an instance of the
DescribeRedshiftIdcApplicationsRequest.Builder
avoiding the need to create one manually viaDescribeRedshiftIdcApplicationsRequest.builder()
- Parameters:
describeRedshiftIdcApplicationsRequest
- AConsumer
that will call methods onDescribeRedshiftIdcApplicationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeRedshiftIdcApplications operation returned by the service.
- See Also:
-
describeRedshiftIdcApplicationsPaginator
default DescribeRedshiftIdcApplicationsIterable describeRedshiftIdcApplicationsPaginator(DescribeRedshiftIdcApplicationsRequest describeRedshiftIdcApplicationsRequest) throws RedshiftIdcApplicationNotExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, AwsServiceException, SdkClientException, RedshiftException This is a variant of
describeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsIterable responses = client.describeRedshiftIdcApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsIterable responses = client .describeRedshiftIdcApplicationsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsIterable responses = client.describeRedshiftIdcApplicationsPaginator(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
describeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation.- Parameters:
describeRedshiftIdcApplicationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRedshiftIdcApplicationsPaginator
default DescribeRedshiftIdcApplicationsIterable describeRedshiftIdcApplicationsPaginator(Consumer<DescribeRedshiftIdcApplicationsRequest.Builder> describeRedshiftIdcApplicationsRequest) throws RedshiftIdcApplicationNotExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, AwsServiceException, SdkClientException, RedshiftException This is a variant of
describeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsIterable responses = client.describeRedshiftIdcApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsIterable responses = client .describeRedshiftIdcApplicationsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.DescribeRedshiftIdcApplicationsIterable responses = client.describeRedshiftIdcApplicationsPaginator(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
describeRedshiftIdcApplications(software.amazon.awssdk.services.redshift.model.DescribeRedshiftIdcApplicationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRedshiftIdcApplicationsRequest.Builder
avoiding the need to create one manually viaDescribeRedshiftIdcApplicationsRequest.builder()
- Parameters:
describeRedshiftIdcApplicationsRequest
- AConsumer
that will call methods onDescribeRedshiftIdcApplicationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedNodeExchangeStatus
default 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.
- Parameters:
describeReservedNodeExchangeStatusRequest
-- Returns:
- Result of the DescribeReservedNodeExchangeStatus operation returned by the service.
- See Also:
-
describeReservedNodeExchangeStatus
default 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 viaDescribeReservedNodeExchangeStatusRequest.builder()
- Parameters:
describeReservedNodeExchangeStatusRequest
- AConsumer
that will call methods onDescribeReservedNodeExchangeStatusRequest.Builder
to create a request.- Returns:
- Result of the DescribeReservedNodeExchangeStatus operation returned by the service.
- See Also:
-
describeReservedNodeExchangeStatusPaginator
default DescribeReservedNodeExchangeStatusIterable describeReservedNodeExchangeStatusPaginator(DescribeReservedNodeExchangeStatusRequest describeReservedNodeExchangeStatusRequest) throws ReservedNodeNotFoundException, ReservedNodeExchangeNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusIterable responses = client.describeReservedNodeExchangeStatusPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeReservedNodeExchangeStatusRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedNodeExchangeStatusPaginator
default DescribeReservedNodeExchangeStatusIterable describeReservedNodeExchangeStatusPaginator(Consumer<DescribeReservedNodeExchangeStatusRequest.Builder> describeReservedNodeExchangeStatusRequest) throws ReservedNodeNotFoundException, ReservedNodeExchangeNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeExchangeStatusIterable responses = client.describeReservedNodeExchangeStatusPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeReservedNodeExchangeStatusRequest.builder()
- Parameters:
describeReservedNodeExchangeStatusRequest
- AConsumer
that will call methods onDescribeReservedNodeExchangeStatusRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedNodeOfferings
default 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.
- Parameters:
describeReservedNodeOfferingsRequest
-- Returns:
- Result of the DescribeReservedNodeOfferings operation returned by the service.
- See Also:
-
describeReservedNodeOfferings
default 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 viaDescribeReservedNodeOfferingsRequest.builder()
- Parameters:
describeReservedNodeOfferingsRequest
- AConsumer
that will call methods onDescribeReservedNodeOfferingsRequest.Builder
to create a request.- Returns:
- Result of the DescribeReservedNodeOfferings operation returned by the service.
- See Also:
-
describeReservedNodeOfferings
default DescribeReservedNodeOfferingsResponse describeReservedNodeOfferings() throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftExceptionReturns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
- Returns:
- Result of the DescribeReservedNodeOfferings operation returned by the service.
- See Also:
-
describeReservedNodeOfferingsPaginator
default DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator() throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedNodeOfferingsPaginator
default DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeReservedNodeOfferingsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedNodeOfferingsPaginator
default DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeReservedNodeOfferingsRequest.builder()
- Parameters:
describeReservedNodeOfferingsRequest
- AConsumer
that will call methods onDescribeReservedNodeOfferingsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedNodes
default DescribeReservedNodesResponse describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException Returns the descriptions of the reserved nodes.
- Parameters:
describeReservedNodesRequest
-- Returns:
- Result of the DescribeReservedNodes operation returned by the service.
- See Also:
-
describeReservedNodes
default 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 viaDescribeReservedNodesRequest.builder()
- Parameters:
describeReservedNodesRequest
- AConsumer
that will call methods onDescribeReservedNodesRequest.Builder
to create a request.- Returns:
- Result of the DescribeReservedNodes operation returned by the service.
- See Also:
-
describeReservedNodes
default DescribeReservedNodesResponse describeReservedNodes() throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftExceptionReturns the descriptions of the reserved nodes.
- Returns:
- Result of the DescribeReservedNodes operation returned by the service.
- See Also:
-
describeReservedNodesPaginator
default DescribeReservedNodesIterable describeReservedNodesPaginator() throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedNodesPaginator
default DescribeReservedNodesIterable describeReservedNodesPaginator(DescribeReservedNodesRequest describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeReservedNodesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedNodesPaginator
default DescribeReservedNodesIterable describeReservedNodesPaginator(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeReservedNodesRequest.builder()
- Parameters:
describeReservedNodesRequest
- AConsumer
that will call methods onDescribeReservedNodesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeResize
default DescribeResizeResponse describeResize(DescribeResizeRequest describeResizeRequest) throws ClusterNotFoundException, ResizeNotFoundException, UnsupportedOperationException, 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 asSUCCEEDED
until the next resize.A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
- Parameters:
describeResizeRequest
-- Returns:
- Result of the DescribeResize operation returned by the service.
- See Also:
-
describeResize
default DescribeResizeResponse describeResize(Consumer<DescribeResizeRequest.Builder> describeResizeRequest) throws ClusterNotFoundException, ResizeNotFoundException, UnsupportedOperationException, 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 asSUCCEEDED
until the next resize.A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
This is a convenience which creates an instance of the
DescribeResizeRequest.Builder
avoiding the need to create one manually viaDescribeResizeRequest.builder()
- Parameters:
describeResizeRequest
- AConsumer
that will call methods onDescribeResizeRequest.Builder
to create a request.- Returns:
- Result of the DescribeResize operation returned by the service.
- See Also:
-
describeScheduledActions
default DescribeScheduledActionsResponse describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException Describes properties of scheduled actions.
- Parameters:
describeScheduledActionsRequest
-- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- See Also:
-
describeScheduledActions
default 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 viaDescribeScheduledActionsRequest.builder()
- Parameters:
describeScheduledActionsRequest
- AConsumer
that will call methods onDescribeScheduledActionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- See Also:
-
describeScheduledActionsPaginator
default DescribeScheduledActionsIterable describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeScheduledActionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeScheduledActionsPaginator
default DescribeScheduledActionsIterable describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) throws ScheduledActionNotFoundException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeScheduledActionsRequest.builder()
- Parameters:
describeScheduledActionsRequest
- AConsumer
that will call methods onDescribeScheduledActionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSnapshotCopyGrants
default 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.
- Parameters:
describeSnapshotCopyGrantsRequest
- The result of theDescribeSnapshotCopyGrants
action.- Returns:
- Result of the DescribeSnapshotCopyGrants operation returned by the service.
- See Also:
-
describeSnapshotCopyGrants
default 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 viaDescribeSnapshotCopyGrantsRequest.builder()
- Parameters:
describeSnapshotCopyGrantsRequest
- AConsumer
that will call methods onDescribeSnapshotCopyGrantsRequest.Builder
to create a request. The result of theDescribeSnapshotCopyGrants
action.- Returns:
- Result of the DescribeSnapshotCopyGrants operation returned by the service.
- See Also:
-
describeSnapshotCopyGrants
default DescribeSnapshotCopyGrantsResponse describeSnapshotCopyGrants() throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionReturns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
- Returns:
- Result of the DescribeSnapshotCopyGrants operation returned by the service.
- See Also:
-
describeSnapshotCopyGrantsPaginator
default DescribeSnapshotCopyGrantsIterable describeSnapshotCopyGrantsPaginator() throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client.describeSnapshotCopyGrantsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSnapshotCopyGrantsPaginator
default DescribeSnapshotCopyGrantsIterable describeSnapshotCopyGrantsPaginator(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client.describeSnapshotCopyGrantsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeSnapshotCopyGrantsRequest
- The result of theDescribeSnapshotCopyGrants
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSnapshotCopyGrantsPaginator
default DescribeSnapshotCopyGrantsIterable describeSnapshotCopyGrantsPaginator(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotCopyGrantsIterable responses = client.describeSnapshotCopyGrantsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeSnapshotCopyGrantsRequest.builder()
- Parameters:
describeSnapshotCopyGrantsRequest
- AConsumer
that will call methods onDescribeSnapshotCopyGrantsRequest.Builder
to create a request. The result of theDescribeSnapshotCopyGrants
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSnapshotSchedules
default DescribeSnapshotSchedulesResponse describeSnapshotSchedules(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) throws AwsServiceException, SdkClientException, RedshiftException Returns a list of snapshot schedules.
- Parameters:
describeSnapshotSchedulesRequest
-- Returns:
- Result of the DescribeSnapshotSchedules operation returned by the service.
- See Also:
-
describeSnapshotSchedules
default 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 viaDescribeSnapshotSchedulesRequest.builder()
- Parameters:
describeSnapshotSchedulesRequest
- AConsumer
that will call methods onDescribeSnapshotSchedulesRequest.Builder
to create a request.- Returns:
- Result of the DescribeSnapshotSchedules operation returned by the service.
- See Also:
-
describeSnapshotSchedules
default DescribeSnapshotSchedulesResponse describeSnapshotSchedules() throws AwsServiceException, SdkClientException, RedshiftExceptionReturns a list of snapshot schedules.
- Returns:
- Result of the DescribeSnapshotSchedules operation returned by the service.
- See Also:
-
describeSnapshotSchedulesPaginator
default DescribeSnapshotSchedulesIterable describeSnapshotSchedulesPaginator() throws AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client.describeSnapshotSchedulesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSnapshotSchedulesPaginator
default DescribeSnapshotSchedulesIterable describeSnapshotSchedulesPaginator(DescribeSnapshotSchedulesRequest describeSnapshotSchedulesRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client.describeSnapshotSchedulesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeSnapshotSchedulesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSnapshotSchedulesPaginator
default DescribeSnapshotSchedulesIterable describeSnapshotSchedulesPaginator(Consumer<DescribeSnapshotSchedulesRequest.Builder> describeSnapshotSchedulesRequest) throws AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeSnapshotSchedulesIterable responses = client.describeSnapshotSchedulesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeSnapshotSchedulesRequest.builder()
- Parameters:
describeSnapshotSchedulesRequest
- AConsumer
that will call methods onDescribeSnapshotSchedulesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStorage
default DescribeStorageResponse describeStorage(DescribeStorageRequest describeStorageRequest) throws AwsServiceException, SdkClientException, RedshiftException Returns account level backups storage size and provisional storage.
- Parameters:
describeStorageRequest
-- Returns:
- Result of the DescribeStorage operation returned by the service.
- See Also:
-
describeStorage
default 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 viaDescribeStorageRequest.builder()
- Parameters:
describeStorageRequest
- AConsumer
that will call methods onDescribeStorageRequest.Builder
to create a request.- Returns:
- Result of the DescribeStorage operation returned by the service.
- See Also:
-
describeStorage
default DescribeStorageResponse describeStorage() throws AwsServiceException, SdkClientException, RedshiftExceptionReturns account level backups storage size and provisional storage.
- Returns:
- Result of the DescribeStorage operation returned by the service.
- See Also:
-
describeTableRestoreStatus
default 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, thenDescribeTableRestoreStatus
returns the status of all table restore requests ordered by the date and time of the request in ascending order. OtherwiseDescribeTableRestoreStatus
returns the status of the table specified byTableRestoreRequestId
.- Parameters:
describeTableRestoreStatusRequest
-- Returns:
- Result of the DescribeTableRestoreStatus operation returned by the service.
- See Also:
-
describeTableRestoreStatus
default 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, thenDescribeTableRestoreStatus
returns the status of all table restore requests ordered by the date and time of the request in ascending order. OtherwiseDescribeTableRestoreStatus
returns the status of the table specified byTableRestoreRequestId
.
This is a convenience which creates an instance of the
DescribeTableRestoreStatusRequest.Builder
avoiding the need to create one manually viaDescribeTableRestoreStatusRequest.builder()
- Parameters:
describeTableRestoreStatusRequest
- AConsumer
that will call methods onDescribeTableRestoreStatusRequest.Builder
to create a request.- Returns:
- Result of the DescribeTableRestoreStatus operation returned by the service.
- See Also:
-
describeTableRestoreStatusPaginator
default DescribeTableRestoreStatusIterable describeTableRestoreStatusPaginator(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) throws TableRestoreNotFoundException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusIterable responses = client.describeTableRestoreStatusPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeTableRestoreStatusRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTableRestoreStatusPaginator
default DescribeTableRestoreStatusIterable describeTableRestoreStatusPaginator(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) throws TableRestoreNotFoundException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeTableRestoreStatusIterable responses = client.describeTableRestoreStatusPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeTableRestoreStatusRequest.builder()
- Parameters:
describeTableRestoreStatusRequest
- AConsumer
that will call methods onDescribeTableRestoreStatusRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTags
default 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
andMarker
parameters together with the ARN parameter. -
The
MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all resources that have any combination of those values are returned.If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
- Parameters:
describeTagsRequest
-- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
-
describeTags
default 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
andMarker
parameters together with the ARN parameter. -
The
MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all resources that have any combination of those values are returned.If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builder
avoiding the need to create one manually viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request.- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
-
describeTags
default DescribeTagsResponse describeTags() throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionReturns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for
DescribeTags
:-
You cannot specify an ARN and a resource-type value together in the same request.
-
You cannot use the
MaxRecords
andMarker
parameters together with the ARN parameter. -
The
MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have
owner
andenvironment
for tag keys, andadmin
andtest
for tag values, all resources that have any combination of those values are returned.If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator() throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftExceptionThis 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator(DescribeTagsRequest describeTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeTagsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUsageLimits
default 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.
- Parameters:
describeUsageLimitsRequest
-- Returns:
- Result of the DescribeUsageLimits operation returned by the service.
- See Also:
-
-
describeUsageLimits
default 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 viaDescribeUsageLimitsRequest.builder()
- Parameters:
describeUsageLimitsRequest
- AConsumer
that will call methods onDescribeUsageLimitsRequest.Builder
to create a request.- Returns:
- Result of the DescribeUsageLimits operation returned by the service.
- See Also:
-
-
describeUsageLimitsPaginator
default DescribeUsageLimitsIterable describeUsageLimitsPaginator(DescribeUsageLimitsRequest describeUsageLimitsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsIterable responses = client.describeUsageLimitsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeUsageLimitsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUsageLimitsPaginator
default DescribeUsageLimitsIterable describeUsageLimitsPaginator(Consumer<DescribeUsageLimitsRequest.Builder> describeUsageLimitsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.DescribeUsageLimitsIterable responses = client.describeUsageLimitsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeUsageLimitsRequest.builder()
- Parameters:
describeUsageLimitsRequest
- AConsumer
that will call methods onDescribeUsageLimitsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
disableLogging
default DisableLoggingResponse disableLogging(DisableLoggingRequest disableLoggingRequest) throws ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
- Parameters:
disableLoggingRequest
-- Returns:
- Result of the DisableLogging operation returned by the service.
- See Also:
-
disableLogging
default DisableLoggingResponse disableLogging(Consumer<DisableLoggingRequest.Builder> disableLoggingRequest) throws ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, 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 viaDisableLoggingRequest.builder()
- Parameters:
disableLoggingRequest
- AConsumer
that will call methods onDisableLoggingRequest.Builder
to create a request.- Returns:
- Result of the DisableLogging operation returned by the service.
- See Also:
-
disableSnapshotCopy
default DisableSnapshotCopyResponse disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest) throws ClusterNotFoundException, SnapshotCopyAlreadyDisabledException, InvalidClusterStateException, UnauthorizedOperationException, UnsupportedOperationException, 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.
- Parameters:
disableSnapshotCopyRequest
-- Returns:
- Result of the DisableSnapshotCopy operation returned by the service.
- See Also:
-
disableSnapshotCopy
default DisableSnapshotCopyResponse disableSnapshotCopy(Consumer<DisableSnapshotCopyRequest.Builder> disableSnapshotCopyRequest) throws ClusterNotFoundException, SnapshotCopyAlreadyDisabledException, InvalidClusterStateException, UnauthorizedOperationException, UnsupportedOperationException, 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 viaDisableSnapshotCopyRequest.builder()
- Parameters:
disableSnapshotCopyRequest
- AConsumer
that will call methods onDisableSnapshotCopyRequest.Builder
to create a request.- Returns:
- Result of the DisableSnapshotCopy operation returned by the service.
- See Also:
-
enableLogging
default EnableLoggingResponse enableLogging(EnableLoggingRequest enableLoggingRequest) throws ClusterNotFoundException, BucketNotFoundException, InsufficientS3BucketPolicyException, InvalidS3KeyPrefixException, InvalidS3BucketNameException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
- Parameters:
enableLoggingRequest
-- Returns:
- Result of the EnableLogging operation returned by the service.
- See Also:
-
enableLogging
default EnableLoggingResponse enableLogging(Consumer<EnableLoggingRequest.Builder> enableLoggingRequest) throws ClusterNotFoundException, BucketNotFoundException, InsufficientS3BucketPolicyException, InvalidS3KeyPrefixException, InvalidS3BucketNameException, InvalidClusterStateException, UnsupportedOperationException, 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 viaEnableLoggingRequest.builder()
- Parameters:
enableLoggingRequest
- AConsumer
that will call methods onEnableLoggingRequest.Builder
to create a request.- Returns:
- Result of the EnableLogging operation returned by the service.
- See Also:
-
enableSnapshotCopy
default 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.
- Parameters:
enableSnapshotCopyRequest
-- Returns:
- Result of the EnableSnapshotCopy operation returned by the service.
- See Also:
-
enableSnapshotCopy
default 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 viaEnableSnapshotCopyRequest.builder()
- Parameters:
enableSnapshotCopyRequest
- AConsumer
that will call methods onEnableSnapshotCopyRequest.Builder
to create a request.- Returns:
- Result of the EnableSnapshotCopy operation returned by the service.
- See Also:
-
failoverPrimaryCompute
default FailoverPrimaryComputeResponse failoverPrimaryCompute(FailoverPrimaryComputeRequest failoverPrimaryComputeRequest) throws ClusterNotFoundException, UnsupportedOperationException, UnauthorizedOperationException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
- Parameters:
failoverPrimaryComputeRequest
-- Returns:
- Result of the FailoverPrimaryCompute operation returned by the service.
- See Also:
-
failoverPrimaryCompute
default FailoverPrimaryComputeResponse failoverPrimaryCompute(Consumer<FailoverPrimaryComputeRequest.Builder> failoverPrimaryComputeRequest) throws ClusterNotFoundException, UnsupportedOperationException, UnauthorizedOperationException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
This is a convenience which creates an instance of the
FailoverPrimaryComputeRequest.Builder
avoiding the need to create one manually viaFailoverPrimaryComputeRequest.builder()
- Parameters:
failoverPrimaryComputeRequest
- AConsumer
that will call methods onFailoverPrimaryComputeRequest.Builder
to create a request.- Returns:
- Result of the FailoverPrimaryCompute operation returned by the service.
- See Also:
-
getClusterCredentials
default 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:
ifAutoCreate
isFalse
orIAMA:
ifAutoCreate
isTrue
. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the
DbGroups
parameter is specified, the IAM policy must allow theredshift:JoinGroup
action with access to the listeddbgroups
.In addition, if the
AutoCreate
parameter is set toTrue
, then the policy must include theredshift:CreateClusterUser
permission.If the
DbName
parameter is specified, the IAM policy must allow access to the resourcedbname
for the specified database name.- Parameters:
getClusterCredentialsRequest
- The request parameters to get cluster credentials.- Returns:
- Result of the GetClusterCredentials operation returned by the service.
- See Also:
-
getClusterCredentials
default 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:
ifAutoCreate
isFalse
orIAMA:
ifAutoCreate
isTrue
. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the
DbGroups
parameter is specified, the IAM policy must allow theredshift:JoinGroup
action with access to the listeddbgroups
.In addition, if the
AutoCreate
parameter is set toTrue
, then the policy must include theredshift:CreateClusterUser
permission.If the
DbName
parameter is specified, the IAM policy must allow access to the resourcedbname
for the specified database name.
This is a convenience which creates an instance of the
GetClusterCredentialsRequest.Builder
avoiding the need to create one manually viaGetClusterCredentialsRequest.builder()
- Parameters:
getClusterCredentialsRequest
- AConsumer
that will call methods onGetClusterCredentialsRequest.Builder
to create a request. The request parameters to get cluster credentials.- Returns:
- Result of the GetClusterCredentials operation returned by the service.
- See Also:
-
getClusterCredentialsWithIAM
default 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.
- Parameters:
getClusterCredentialsWithIamRequest
-- Returns:
- Result of the GetClusterCredentialsWithIAM operation returned by the service.
- See Also:
-
getClusterCredentialsWithIAM
default 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 viaGetClusterCredentialsWithIamRequest.builder()
- Parameters:
getClusterCredentialsWithIamRequest
- AConsumer
that will call methods onGetClusterCredentialsWithIamRequest.Builder
to create a request.- Returns:
- Result of the GetClusterCredentialsWithIAM operation returned by the service.
- See Also:
-
getReservedNodeExchangeConfigurationOptions
default 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.
- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest
-- Returns:
- Result of the GetReservedNodeExchangeConfigurationOptions operation returned by the service.
- See Also:
-
getReservedNodeExchangeConfigurationOptions
default 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 viaGetReservedNodeExchangeConfigurationOptionsRequest.builder()
- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest
- AConsumer
that will call methods onGetReservedNodeExchangeConfigurationOptionsRequest.Builder
to create a request.- Returns:
- Result of the GetReservedNodeExchangeConfigurationOptions operation returned by the service.
- See Also:
-
getReservedNodeExchangeConfigurationOptionsPaginator
default GetReservedNodeExchangeConfigurationOptionsIterable getReservedNodeExchangeConfigurationOptionsPaginator(GetReservedNodeExchangeConfigurationOptionsRequest getReservedNodeExchangeConfigurationOptionsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, ClusterNotFoundException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsIterable responses = client.getReservedNodeExchangeConfigurationOptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getReservedNodeExchangeConfigurationOptionsPaginator
default GetReservedNodeExchangeConfigurationOptionsIterable getReservedNodeExchangeConfigurationOptionsPaginator(Consumer<GetReservedNodeExchangeConfigurationOptionsRequest.Builder> getReservedNodeExchangeConfigurationOptionsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, ClusterNotFoundException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeConfigurationOptionsIterable responses = client.getReservedNodeExchangeConfigurationOptionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetReservedNodeExchangeConfigurationOptionsRequest.builder()
- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest
- AConsumer
that will call methods onGetReservedNodeExchangeConfigurationOptionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getReservedNodeExchangeOfferings
default 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.
- Parameters:
getReservedNodeExchangeOfferingsRequest
-- Returns:
- Result of the GetReservedNodeExchangeOfferings operation returned by the service.
- See Also:
-
getReservedNodeExchangeOfferings
default 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 viaGetReservedNodeExchangeOfferingsRequest.builder()
- Parameters:
getReservedNodeExchangeOfferingsRequest
- AConsumer
that will call methods onGetReservedNodeExchangeOfferingsRequest.Builder
to create a request.- Returns:
- Result of the GetReservedNodeExchangeOfferings operation returned by the service.
- See Also:
-
getReservedNodeExchangeOfferingsPaginator
default GetReservedNodeExchangeOfferingsIterable getReservedNodeExchangeOfferingsPaginator(GetReservedNodeExchangeOfferingsRequest getReservedNodeExchangeOfferingsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsIterable responses = client.getReservedNodeExchangeOfferingsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getReservedNodeExchangeOfferingsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getReservedNodeExchangeOfferingsPaginator
default GetReservedNodeExchangeOfferingsIterable getReservedNodeExchangeOfferingsPaginator(Consumer<GetReservedNodeExchangeOfferingsRequest.Builder> getReservedNodeExchangeOfferingsRequest) throws ReservedNodeNotFoundException, InvalidReservedNodeStateException, ReservedNodeAlreadyMigratedException, ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException 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 Streamsoftware.amazon.awssdk.services.redshift.paginators.GetReservedNodeExchangeOfferingsIterable responses = client.getReservedNodeExchangeOfferingsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetReservedNodeExchangeOfferingsRequest.builder()
- Parameters:
getReservedNodeExchangeOfferingsRequest
- AConsumer
that will call methods onGetReservedNodeExchangeOfferingsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getResourcePolicy
default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) throws ResourceNotFoundException, InvalidPolicyException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Get the resource policy for a specified resource.
- Parameters:
getResourcePolicyRequest
-- Returns:
- Result of the GetResourcePolicy operation returned by the service.
- See Also:
-
getResourcePolicy
default 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 viaGetResourcePolicyRequest.builder()
- Parameters:
getResourcePolicyRequest
- AConsumer
that will call methods onGetResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the GetResourcePolicy operation returned by the service.
- See Also:
-
listRecommendations
default ListRecommendationsResponse listRecommendations(ListRecommendationsRequest listRecommendationsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.
- Parameters:
listRecommendationsRequest
-- Returns:
- Result of the ListRecommendations operation returned by the service.
- See Also:
-
listRecommendations
default ListRecommendationsResponse listRecommendations(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.
This is a convenience which creates an instance of the
ListRecommendationsRequest.Builder
avoiding the need to create one manually viaListRecommendationsRequest.builder()
- Parameters:
listRecommendationsRequest
- AConsumer
that will call methods onListRecommendationsRequest.Builder
to create a request.- Returns:
- Result of the ListRecommendations operation returned by the service.
- See Also:
-
listRecommendationsPaginator
default ListRecommendationsIterable listRecommendationsPaginator(ListRecommendationsRequest listRecommendationsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException This is a variant of
listRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
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 Streamsoftware.amazon.awssdk.services.redshift.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.redshift.paginators.ListRecommendationsIterable responses = client .listRecommendationsPaginator(request); for (software.amazon.awssdk.services.redshift.model.ListRecommendationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(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
listRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation.- Parameters:
listRecommendationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecommendationsPaginator
default ListRecommendationsIterable listRecommendationsPaginator(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest) throws ClusterNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException This is a variant of
listRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
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 Streamsoftware.amazon.awssdk.services.redshift.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.redshift.paginators.ListRecommendationsIterable responses = client .listRecommendationsPaginator(request); for (software.amazon.awssdk.services.redshift.model.ListRecommendationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(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
listRecommendations(software.amazon.awssdk.services.redshift.model.ListRecommendationsRequest)
operation.
This is a convenience which creates an instance of the
ListRecommendationsRequest.Builder
avoiding the need to create one manually viaListRecommendationsRequest.builder()
- Parameters:
listRecommendationsRequest
- AConsumer
that will call methods onListRecommendationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
modifyAquaConfiguration
default 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).
- Parameters:
modifyAquaConfigurationRequest
-- Returns:
- Result of the ModifyAquaConfiguration operation returned by the service.
- See Also:
-
modifyAquaConfiguration
default 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 viaModifyAquaConfigurationRequest.builder()
- Parameters:
modifyAquaConfigurationRequest
- AConsumer
that will call methods onModifyAquaConfigurationRequest.Builder
to create a request.- Returns:
- Result of the ModifyAquaConfiguration operation returned by the service.
- See Also:
-
modifyAuthenticationProfile
default ModifyAuthenticationProfileResponse modifyAuthenticationProfile(ModifyAuthenticationProfileRequest modifyAuthenticationProfileRequest) throws AuthenticationProfileNotFoundException, AuthenticationProfileQuotaExceededException, InvalidAuthenticationProfileRequestException, AwsServiceException, SdkClientException, RedshiftException Modifies an authentication profile.
- Parameters:
modifyAuthenticationProfileRequest
-- Returns:
- Result of the ModifyAuthenticationProfile operation returned by the service.
- See Also:
-
modifyAuthenticationProfile
default 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 viaModifyAuthenticationProfileRequest.builder()
- Parameters:
modifyAuthenticationProfileRequest
- AConsumer
that will call methods onModifyAuthenticationProfileRequest.Builder
to create a request.- Returns:
- Result of the ModifyAuthenticationProfile operation returned by the service.
- See Also:
-
modifyCluster
default 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, Ipv6CidrBlockNotFoundException, 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.
- Parameters:
modifyClusterRequest
-- Returns:
- Result of the ModifyCluster operation returned by the service.
- See Also:
-
modifyCluster
default 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, Ipv6CidrBlockNotFoundException, 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 viaModifyClusterRequest.builder()
- Parameters:
modifyClusterRequest
- AConsumer
that will call methods onModifyClusterRequest.Builder
to create a request.- Returns:
- Result of the ModifyCluster operation returned by the service.
- See Also:
-
modifyClusterDbRevision
default ModifyClusterDbRevisionResponse modifyClusterDbRevision(ModifyClusterDbRevisionRequest modifyClusterDbRevisionRequest) throws ClusterNotFoundException, ClusterOnLatestRevisionException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
- Parameters:
modifyClusterDbRevisionRequest
-- Returns:
- Result of the ModifyClusterDbRevision operation returned by the service.
- See Also:
-
modifyClusterDbRevision
default ModifyClusterDbRevisionResponse modifyClusterDbRevision(Consumer<ModifyClusterDbRevisionRequest.Builder> modifyClusterDbRevisionRequest) throws ClusterNotFoundException, ClusterOnLatestRevisionException, InvalidClusterStateException, UnsupportedOperationException, 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 viaModifyClusterDbRevisionRequest.builder()
- Parameters:
modifyClusterDbRevisionRequest
- AConsumer
that will call methods onModifyClusterDbRevisionRequest.Builder
to create a request.- Returns:
- Result of the ModifyClusterDbRevision operation returned by the service.
- See Also:
-
modifyClusterIamRoles
default 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.
- Parameters:
modifyClusterIamRolesRequest
-- Returns:
- Result of the ModifyClusterIamRoles operation returned by the service.
- See Also:
-
modifyClusterIamRoles
default 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 viaModifyClusterIamRolesRequest.builder()
- Parameters:
modifyClusterIamRolesRequest
- AConsumer
that will call methods onModifyClusterIamRolesRequest.Builder
to create a request.- Returns:
- Result of the ModifyClusterIamRoles operation returned by the service.
- See Also:
-
modifyClusterMaintenance
default ModifyClusterMaintenanceResponse modifyClusterMaintenance(ModifyClusterMaintenanceRequest modifyClusterMaintenanceRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException Modifies the maintenance settings of a cluster.
- Parameters:
modifyClusterMaintenanceRequest
-- Returns:
- Result of the ModifyClusterMaintenance operation returned by the service.
- See Also:
-
modifyClusterMaintenance
default 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 viaModifyClusterMaintenanceRequest.builder()
- Parameters:
modifyClusterMaintenanceRequest
- AConsumer
that will call methods onModifyClusterMaintenanceRequest.Builder
to create a request.- Returns:
- Result of the ModifyClusterMaintenance operation returned by the service.
- See Also:
-
modifyClusterParameterGroup
default 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.
- Parameters:
modifyClusterParameterGroupRequest
- Describes a modify cluster parameter group operation.- Returns:
- Result of the ModifyClusterParameterGroup operation returned by the service.
- See Also:
-
modifyClusterParameterGroup
default 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 viaModifyClusterParameterGroupRequest.builder()
- Parameters:
modifyClusterParameterGroupRequest
- AConsumer
that will call methods onModifyClusterParameterGroupRequest.Builder
to create a request. Describes a modify cluster parameter group operation.- Returns:
- Result of the ModifyClusterParameterGroup operation returned by the service.
- See Also:
-
modifyClusterSnapshot
default 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.
- Parameters:
modifyClusterSnapshotRequest
-- Returns:
- Result of the ModifyClusterSnapshot operation returned by the service.
- See Also:
-
modifyClusterSnapshot
default 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 viaModifyClusterSnapshotRequest.builder()
- Parameters:
modifyClusterSnapshotRequest
- AConsumer
that will call methods onModifyClusterSnapshotRequest.Builder
to create a request.- Returns:
- Result of the ModifyClusterSnapshot operation returned by the service.
- See Also:
-
modifyClusterSnapshotSchedule
default ModifyClusterSnapshotScheduleResponse modifyClusterSnapshotSchedule(ModifyClusterSnapshotScheduleRequest modifyClusterSnapshotScheduleRequest) throws ClusterNotFoundException, SnapshotScheduleNotFoundException, InvalidClusterSnapshotScheduleStateException, AwsServiceException, SdkClientException, RedshiftException Modifies a snapshot schedule for a cluster.
- Parameters:
modifyClusterSnapshotScheduleRequest
-- Returns:
- Result of the ModifyClusterSnapshotSchedule operation returned by the service.
- See Also:
-
modifyClusterSnapshotSchedule
default 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 viaModifyClusterSnapshotScheduleRequest.builder()
- Parameters:
modifyClusterSnapshotScheduleRequest
- AConsumer
that will call methods onModifyClusterSnapshotScheduleRequest.Builder
to create a request.- Returns:
- Result of the ModifyClusterSnapshotSchedule operation returned by the service.
- See Also:
-
modifyClusterSubnetGroup
default 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.
- Parameters:
modifyClusterSubnetGroupRequest
-- Returns:
- Result of the ModifyClusterSubnetGroup operation returned by the service.
- See Also:
-
modifyClusterSubnetGroup
default 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 viaModifyClusterSubnetGroupRequest.builder()
- Parameters:
modifyClusterSubnetGroupRequest
- AConsumer
that will call methods onModifyClusterSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the ModifyClusterSubnetGroup operation returned by the service.
- See Also:
-
modifyCustomDomainAssociation
default ModifyCustomDomainAssociationResponse modifyCustomDomainAssociation(ModifyCustomDomainAssociationRequest modifyCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, CustomDomainAssociationNotFoundException, AwsServiceException, SdkClientException, RedshiftException Contains information for changing a custom domain association.
- Parameters:
modifyCustomDomainAssociationRequest
-- Returns:
- Result of the ModifyCustomDomainAssociation operation returned by the service.
- See Also:
-
modifyCustomDomainAssociation
default ModifyCustomDomainAssociationResponse modifyCustomDomainAssociation(Consumer<ModifyCustomDomainAssociationRequest.Builder> modifyCustomDomainAssociationRequest) throws UnsupportedOperationException, ClusterNotFoundException, CustomCnameAssociationException, CustomDomainAssociationNotFoundException, 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 viaModifyCustomDomainAssociationRequest.builder()
- Parameters:
modifyCustomDomainAssociationRequest
- AConsumer
that will call methods onModifyCustomDomainAssociationRequest.Builder
to create a request.- Returns:
- Result of the ModifyCustomDomainAssociation operation returned by the service.
- See Also:
-
modifyEndpointAccess
default ModifyEndpointAccessResponse modifyEndpointAccess(ModifyEndpointAccessRequest modifyEndpointAccessRequest) throws InvalidClusterSecurityGroupStateException, ClusterNotFoundException, InvalidEndpointStateException, EndpointNotFoundException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException Modifies a Redshift-managed VPC endpoint.
- Parameters:
modifyEndpointAccessRequest
-- Returns:
- Result of the ModifyEndpointAccess operation returned by the service.
- See Also:
-
modifyEndpointAccess
default 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 viaModifyEndpointAccessRequest.builder()
- Parameters:
modifyEndpointAccessRequest
- AConsumer
that will call methods onModifyEndpointAccessRequest.Builder
to create a request.- Returns:
- Result of the ModifyEndpointAccess operation returned by the service.
- See Also:
-
modifyEventSubscription
default 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.
- Parameters:
modifyEventSubscriptionRequest
-- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- See Also:
-
modifyEventSubscription
default 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 viaModifyEventSubscriptionRequest.builder()
- Parameters:
modifyEventSubscriptionRequest
- AConsumer
that will call methods onModifyEventSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- See Also:
-
modifyRedshiftIdcApplication
default ModifyRedshiftIdcApplicationResponse modifyRedshiftIdcApplication(ModifyRedshiftIdcApplicationRequest modifyRedshiftIdcApplicationRequest) throws RedshiftIdcApplicationNotExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, AwsServiceException, SdkClientException, RedshiftException Changes an existing Amazon Redshift IAM Identity Center application.
- Parameters:
modifyRedshiftIdcApplicationRequest
-- Returns:
- Result of the ModifyRedshiftIdcApplication operation returned by the service.
- See Also:
-
modifyRedshiftIdcApplication
default ModifyRedshiftIdcApplicationResponse modifyRedshiftIdcApplication(Consumer<ModifyRedshiftIdcApplicationRequest.Builder> modifyRedshiftIdcApplicationRequest) throws RedshiftIdcApplicationNotExistsException, DependentServiceUnavailableException, UnsupportedOperationException, DependentServiceAccessDeniedException, AwsServiceException, SdkClientException, RedshiftException Changes an existing Amazon Redshift IAM Identity Center application.
This is a convenience which creates an instance of the
ModifyRedshiftIdcApplicationRequest.Builder
avoiding the need to create one manually viaModifyRedshiftIdcApplicationRequest.builder()
- Parameters:
modifyRedshiftIdcApplicationRequest
- AConsumer
that will call methods onModifyRedshiftIdcApplicationRequest.Builder
to create a request.- Returns:
- Result of the ModifyRedshiftIdcApplication operation returned by the service.
- See Also:
-
modifyScheduledAction
default ModifyScheduledActionResponse modifyScheduledAction(ModifyScheduledActionRequest modifyScheduledActionRequest) throws ClusterNotFoundException, ScheduledActionNotFoundException, ScheduledActionTypeUnsupportedException, InvalidScheduleException, InvalidScheduledActionException, UnauthorizedOperationException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Modifies a scheduled action.
- Parameters:
modifyScheduledActionRequest
-- Returns:
- Result of the ModifyScheduledAction operation returned by the service.
- See Also:
-
modifyScheduledAction
default ModifyScheduledActionResponse modifyScheduledAction(Consumer<ModifyScheduledActionRequest.Builder> modifyScheduledActionRequest) throws ClusterNotFoundException, ScheduledActionNotFoundException, ScheduledActionTypeUnsupportedException, InvalidScheduleException, InvalidScheduledActionException, UnauthorizedOperationException, UnsupportedOperationException, 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 viaModifyScheduledActionRequest.builder()
- Parameters:
modifyScheduledActionRequest
- AConsumer
that will call methods onModifyScheduledActionRequest.Builder
to create a request.- Returns:
- Result of the ModifyScheduledAction operation returned by the service.
- See Also:
-
modifySnapshotCopyRetentionPeriod
default 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.
- Parameters:
modifySnapshotCopyRetentionPeriodRequest
-- Returns:
- Result of the ModifySnapshotCopyRetentionPeriod operation returned by the service.
- See Also:
-
modifySnapshotCopyRetentionPeriod
default 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 viaModifySnapshotCopyRetentionPeriodRequest.builder()
- Parameters:
modifySnapshotCopyRetentionPeriodRequest
- AConsumer
that will call methods onModifySnapshotCopyRetentionPeriodRequest.Builder
to create a request.- Returns:
- Result of the ModifySnapshotCopyRetentionPeriod operation returned by the service.
- See Also:
-
modifySnapshotSchedule
default ModifySnapshotScheduleResponse modifySnapshotSchedule(ModifySnapshotScheduleRequest modifySnapshotScheduleRequest) throws InvalidScheduleException, SnapshotScheduleNotFoundException, SnapshotScheduleUpdateInProgressException, AwsServiceException, SdkClientException, RedshiftException Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
- Parameters:
modifySnapshotScheduleRequest
-- Returns:
- Result of the ModifySnapshotSchedule operation returned by the service.
- See Also:
-
modifySnapshotSchedule
default 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 viaModifySnapshotScheduleRequest.builder()
- Parameters:
modifySnapshotScheduleRequest
- AConsumer
that will call methods onModifySnapshotScheduleRequest.Builder
to create a request.- Returns:
- Result of the ModifySnapshotSchedule operation returned by the service.
- See Also:
-
modifyUsageLimit
default 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.
- Parameters:
modifyUsageLimitRequest
-- Returns:
- Result of the ModifyUsageLimit operation returned by the service.
- See Also:
-
modifyUsageLimit
default 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 viaModifyUsageLimitRequest.builder()
- Parameters:
modifyUsageLimitRequest
- AConsumer
that will call methods onModifyUsageLimitRequest.Builder
to create a request.- Returns:
- Result of the ModifyUsageLimit operation returned by the service.
- See Also:
-
pauseCluster
default PauseClusterResponse pauseCluster(PauseClusterRequest pauseClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Pauses a cluster.
- Parameters:
pauseClusterRequest
- Describes a pause cluster operation. For example, a scheduled action to run thePauseCluster
API operation.- Returns:
- Result of the PauseCluster operation returned by the service.
- See Also:
-
pauseCluster
default PauseClusterResponse pauseCluster(Consumer<PauseClusterRequest.Builder> pauseClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, 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 viaPauseClusterRequest.builder()
- Parameters:
pauseClusterRequest
- AConsumer
that will call methods onPauseClusterRequest.Builder
to create a request. Describes a pause cluster operation. For example, a scheduled action to run thePauseCluster
API operation.- Returns:
- Result of the PauseCluster operation returned by the service.
- See Also:
-
purchaseReservedNodeOffering
default 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.
- Parameters:
purchaseReservedNodeOfferingRequest
-- Returns:
- Result of the PurchaseReservedNodeOffering operation returned by the service.
- See Also:
-
purchaseReservedNodeOffering
default 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 viaPurchaseReservedNodeOfferingRequest.builder()
- Parameters:
purchaseReservedNodeOfferingRequest
- AConsumer
that will call methods onPurchaseReservedNodeOfferingRequest.Builder
to create a request.- Returns:
- Result of the PurchaseReservedNodeOffering operation returned by the service.
- See Also:
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws ResourceNotFoundException, InvalidPolicyException, ConflictPolicyUpdateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Updates the resource policy for a specified resource.
- Parameters:
putResourcePolicyRequest
-- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- See Also:
-
putResourcePolicy
default 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 viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- See Also:
-
rebootCluster
default 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.- Parameters:
rebootClusterRequest
-- Returns:
- Result of the RebootCluster operation returned by the service.
- See Also:
-
rebootCluster
default 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 viaRebootClusterRequest.builder()
- Parameters:
rebootClusterRequest
- AConsumer
that will call methods onRebootClusterRequest.Builder
to create a request.- Returns:
- Result of the RebootCluster operation returned by the service.
- See Also:
-
resetClusterParameterGroup
default 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.
- Parameters:
resetClusterParameterGroupRequest
-- Returns:
- Result of the ResetClusterParameterGroup operation returned by the service.
- See Also:
-
resetClusterParameterGroup
default 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 viaResetClusterParameterGroupRequest.builder()
- Parameters:
resetClusterParameterGroupRequest
- AConsumer
that will call methods onResetClusterParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the ResetClusterParameterGroup operation returned by the service.
- See Also:
-
resizeCluster
default 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.
- Parameters:
resizeClusterRequest
- Describes a resize cluster operation. For example, a scheduled action to run theResizeCluster
API operation.- Returns:
- Result of the ResizeCluster operation returned by the service.
- See Also:
-
-
resizeCluster
default 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 viaResizeClusterRequest.builder()
- Parameters:
resizeClusterRequest
- AConsumer
that will call methods onResizeClusterRequest.Builder
to create a request. Describes a resize cluster operation. For example, a scheduled action to run theResizeCluster
API operation.- Returns:
- Result of the ResizeCluster operation returned by the service.
- See Also:
-
-
restoreFromClusterSnapshot
default 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, Ipv6CidrBlockNotFoundException, 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.
- Parameters:
restoreFromClusterSnapshotRequest
-- Returns:
- Result of the RestoreFromClusterSnapshot operation returned by the service.
- See Also:
-
restoreFromClusterSnapshot
default 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, Ipv6CidrBlockNotFoundException, 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 viaRestoreFromClusterSnapshotRequest.builder()
- Parameters:
restoreFromClusterSnapshotRequest
- AConsumer
that will call methods onRestoreFromClusterSnapshotRequest.Builder
to create a request.- Returns:
- Result of the RestoreFromClusterSnapshot operation returned by the service.
- See Also:
-
restoreTableFromClusterSnapshot
default 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 callRestoreTableFromClusterSnapshot
. When you have renamed your original table, then you can pass the original name of the table as theNewTableName
parameter value in the call toRestoreTableFromClusterSnapshot
. This way, you can replace the original table with the table created from the snapshot.You can't use this operation to restore tables with interleaved sort keys.
- Parameters:
restoreTableFromClusterSnapshotRequest
-- Returns:
- Result of the RestoreTableFromClusterSnapshot operation returned by the service.
- See Also:
-
restoreTableFromClusterSnapshot
default 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 callRestoreTableFromClusterSnapshot
. When you have renamed your original table, then you can pass the original name of the table as theNewTableName
parameter value in the call toRestoreTableFromClusterSnapshot
. This way, you can replace the original table with the table created from the snapshot.You can't use this operation to restore tables with interleaved sort keys.
This is a convenience which creates an instance of the
RestoreTableFromClusterSnapshotRequest.Builder
avoiding the need to create one manually viaRestoreTableFromClusterSnapshotRequest.builder()
- Parameters:
restoreTableFromClusterSnapshotRequest
- AConsumer
that will call methods onRestoreTableFromClusterSnapshotRequest.Builder
to create a request.- Returns:
- Result of the RestoreTableFromClusterSnapshot operation returned by the service.
- See Also:
-
resumeCluster
default ResumeClusterResponse resumeCluster(ResumeClusterRequest resumeClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, InsufficientClusterCapacityException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Resumes a paused cluster.
- Parameters:
resumeClusterRequest
- Describes a resume cluster operation. For example, a scheduled action to run theResumeCluster
API operation.- Returns:
- Result of the ResumeCluster operation returned by the service.
- See Also:
-
resumeCluster
default ResumeClusterResponse resumeCluster(Consumer<ResumeClusterRequest.Builder> resumeClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, InsufficientClusterCapacityException, UnsupportedOperationException, 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 viaResumeClusterRequest.builder()
- Parameters:
resumeClusterRequest
- AConsumer
that will call methods onResumeClusterRequest.Builder
to create a request. Describes a resume cluster operation. For example, a scheduled action to run theResumeCluster
API operation.- Returns:
- Result of the ResumeCluster operation returned by the service.
- See Also:
-
revokeClusterSecurityGroupIngress
default 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.
- Parameters:
revokeClusterSecurityGroupIngressRequest
-- Returns:
- Result of the RevokeClusterSecurityGroupIngress operation returned by the service.
- See Also:
-
revokeClusterSecurityGroupIngress
default 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 viaRevokeClusterSecurityGroupIngressRequest.builder()
- Parameters:
revokeClusterSecurityGroupIngressRequest
- AConsumer
that will call methods onRevokeClusterSecurityGroupIngressRequest.Builder
to create a request.- Returns:
- Result of the RevokeClusterSecurityGroupIngress operation returned by the service.
- See Also:
-
revokeEndpointAccess
default RevokeEndpointAccessResponse revokeEndpointAccess(RevokeEndpointAccessRequest revokeEndpointAccessRequest) throws ClusterNotFoundException, InvalidEndpointStateException, InvalidClusterSecurityGroupStateException, EndpointNotFoundException, EndpointAuthorizationNotFoundException, InvalidAuthorizationStateException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException Revokes access to a cluster.
- Parameters:
revokeEndpointAccessRequest
-- Returns:
- Result of the RevokeEndpointAccess operation returned by the service.
- See Also:
-
revokeEndpointAccess
default 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 viaRevokeEndpointAccessRequest.builder()
- Parameters:
revokeEndpointAccessRequest
- AConsumer
that will call methods onRevokeEndpointAccessRequest.Builder
to create a request.- Returns:
- Result of the RevokeEndpointAccess operation returned by the service.
- See Also:
-
revokeSnapshotAccess
default 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.
- Parameters:
revokeSnapshotAccessRequest
-- Returns:
- Result of the RevokeSnapshotAccess operation returned by the service.
- See Also:
-
revokeSnapshotAccess
default 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 viaRevokeSnapshotAccessRequest.builder()
- Parameters:
revokeSnapshotAccessRequest
- AConsumer
that will call methods onRevokeSnapshotAccessRequest.Builder
to create a request.- Returns:
- Result of the RevokeSnapshotAccess operation returned by the service.
- See Also:
-
rotateEncryptionKey
default RotateEncryptionKeyResponse rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest) throws ClusterNotFoundException, InvalidClusterStateException, DependentServiceRequestThrottlingException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Rotates the encryption keys for a cluster.
- Parameters:
rotateEncryptionKeyRequest
-- Returns:
- Result of the RotateEncryptionKey operation returned by the service.
- See Also:
-
rotateEncryptionKey
default RotateEncryptionKeyResponse rotateEncryptionKey(Consumer<RotateEncryptionKeyRequest.Builder> rotateEncryptionKeyRequest) throws ClusterNotFoundException, InvalidClusterStateException, DependentServiceRequestThrottlingException, UnsupportedOperationException, 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 viaRotateEncryptionKeyRequest.builder()
- Parameters:
rotateEncryptionKeyRequest
- AConsumer
that will call methods onRotateEncryptionKeyRequest.Builder
to create a request.- Returns:
- Result of the RotateEncryptionKey operation returned by the service.
- See Also:
-
updatePartnerStatus
default UpdatePartnerStatusResponse updatePartnerStatus(UpdatePartnerStatusRequest updatePartnerStatusRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException Updates the status of a partner integration.
- Parameters:
updatePartnerStatusRequest
-- Returns:
- Result of the UpdatePartnerStatus operation returned by the service.
- See Also:
-
updatePartnerStatus
default UpdatePartnerStatusResponse updatePartnerStatus(Consumer<UpdatePartnerStatusRequest.Builder> updatePartnerStatusRequest) throws PartnerNotFoundException, ClusterNotFoundException, UnauthorizedPartnerIntegrationException, UnsupportedOperationException, 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 viaUpdatePartnerStatusRequest.builder()
- Parameters:
updatePartnerStatusRequest
- AConsumer
that will call methods onUpdatePartnerStatusRequest.Builder
to create a request.- Returns:
- Result of the UpdatePartnerStatus operation returned by the service.
- See Also:
-
waiter
Create an instance ofRedshiftWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
RedshiftWaiter
-
create
Create aRedshiftClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRedshiftClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-