Interface RedshiftClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface RedshiftClient extends AwsClient
Service client for accessing Amazon Redshift. This can be created using the staticbuilder()method.Amazon Redshift 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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ReservedNodeAlreadyExistsException- User already has a reservation with the given identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaAcceptReservedNodeExchangeRequest.builder()- Parameters:
acceptReservedNodeExchangeRequest- AConsumerthat will call methods onAcceptReservedNodeExchangeRequest.Builderto create a request.- Returns:
- Result of the AcceptReservedNodeExchange operation returned by the service.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ReservedNodeAlreadyExistsException- User already has a reservation with the given identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
PartnerNotFoundException- The name of the partner was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException- The partner integration is not authorized.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaAddPartnerRequest.builder()- Parameters:
addPartnerRequest- AConsumerthat will call methods onAddPartnerRequest.Builderto create a request.- Returns:
- Result of the AddPartner operation returned by the service.
- Throws:
PartnerNotFoundException- The name of the partner was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException- The partner integration is not authorized.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateDataShareConsumer
default AssociateDataShareConsumerResponse associateDataShareConsumer(AssociateDataShareConsumerRequest associateDataShareConsumerRequest) throws InvalidDataShareException, InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.
- Parameters:
associateDataShareConsumerRequest-- Returns:
- Result of the AssociateDataShareConsumer operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateDataShareConsumer
default AssociateDataShareConsumerResponse associateDataShareConsumer(Consumer<AssociateDataShareConsumerRequest.Builder> associateDataShareConsumerRequest) throws InvalidDataShareException, InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.
This is a convenience which creates an instance of the
AssociateDataShareConsumerRequest.Builderavoiding the need to create one manually viaAssociateDataShareConsumerRequest.builder()- Parameters:
associateDataShareConsumerRequest- AConsumerthat will call methods onAssociateDataShareConsumerRequest.Builderto create a request.- Returns:
- Result of the AssociateDataShareConsumer operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.AuthorizationAlreadyExistsException- The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.AuthorizationQuotaExceededException- The authorization quota for the cluster security group has been reached.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaAuthorizeClusterSecurityGroupIngressRequest.builder()- Parameters:
authorizeClusterSecurityGroupIngressRequest- AConsumerthat will call methods onAuthorizeClusterSecurityGroupIngressRequest.Builderto create a request.- Returns:
- Result of the AuthorizeClusterSecurityGroupIngress operation returned by the service.
- Throws:
ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.AuthorizationAlreadyExistsException- The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.AuthorizationQuotaExceededException- The authorization quota for the cluster security group has been reached.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
authorizeDataShare
default AuthorizeDataShareResponse authorizeDataShare(AuthorizeDataShareRequest authorizeDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access permissions.
- Parameters:
authorizeDataShareRequest-- Returns:
- Result of the AuthorizeDataShare operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
authorizeDataShare
default AuthorizeDataShareResponse authorizeDataShare(Consumer<AuthorizeDataShareRequest.Builder> authorizeDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access permissions.
This is a convenience which creates an instance of the
AuthorizeDataShareRequest.Builderavoiding the need to create one manually viaAuthorizeDataShareRequest.builder()- Parameters:
authorizeDataShareRequest- AConsumerthat will call methods onAuthorizeDataShareRequest.Builderto create a request.- Returns:
- Result of the AuthorizeDataShare operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.EndpointAuthorizationsPerClusterLimitExceededException- The number of endpoint authorizations per cluster has exceeded its limit.UnsupportedOperationException- The requested operation isn't supported.EndpointAuthorizationAlreadyExistsException- The authorization already exists for this endpoint.InvalidAuthorizationStateException- The status of the authorization is not valid.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaAuthorizeEndpointAccessRequest.builder()- Parameters:
authorizeEndpointAccessRequest- AConsumerthat will call methods onAuthorizeEndpointAccessRequest.Builderto create a request.- Returns:
- Result of the AuthorizeEndpointAccess operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.EndpointAuthorizationsPerClusterLimitExceededException- The number of endpoint authorizations per cluster has exceeded its limit.UnsupportedOperationException- The requested operation isn't supported.EndpointAuthorizationAlreadyExistsException- The authorization already exists for this endpoint.InvalidAuthorizationStateException- The status of the authorization is not valid.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.AuthorizationAlreadyExistsException- The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.AuthorizationQuotaExceededException- The authorization quota for the cluster security group has been reached.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaAuthorizeSnapshotAccessRequest.builder()- Parameters:
authorizeSnapshotAccessRequest- AConsumerthat will call methods onAuthorizeSnapshotAccessRequest.Builderto create a request.- Returns:
- Result of the AuthorizeSnapshotAccess operation returned by the service.
- Throws:
ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.AuthorizationAlreadyExistsException- The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.AuthorizationQuotaExceededException- The authorization quota for the cluster security group has been reached.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
BatchDeleteRequestSizeExceededException- The maximum number for a batch delete of snapshots has been reached. The limit is 100.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaBatchDeleteClusterSnapshotsRequest.builder()- Parameters:
batchDeleteClusterSnapshotsRequest- AConsumerthat will call methods onBatchDeleteClusterSnapshotsRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteClusterSnapshots operation returned by the service.
- Throws:
BatchDeleteRequestSizeExceededException- The maximum number for a batch delete of snapshots has been reached. The limit is 100.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
BatchModifyClusterSnapshotsLimitExceededException- The maximum number for snapshot identifiers has been reached. The limit is 100.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaBatchModifyClusterSnapshotsRequest.builder()- Parameters:
batchModifyClusterSnapshotsRequest- AConsumerthat will call methods onBatchModifyClusterSnapshotsRequest.Builderto create a request.- Returns:
- Result of the BatchModifyClusterSnapshots operation returned by the service.
- Throws:
InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
BatchModifyClusterSnapshotsLimitExceededException- The maximum number for snapshot identifiers has been reached. The limit is 100.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ResizeNotFoundException- A resize operation for the specified cluster is not found.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCancelResizeRequest.builder()- Parameters:
cancelResizeRequest- AConsumerthat will call methods onCancelResizeRequest.Builderto create a request.- Returns:
- Result of the CancelResize operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ResizeNotFoundException- A resize operation for the specified cluster is not found.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotAlreadyExistsException- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterSnapshotQuotaExceededException- The request would result in the user exceeding the allowed number of cluster snapshots.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCopyClusterSnapshotRequest.builder()- Parameters:
copyClusterSnapshotRequest- AConsumerthat will call methods onCopyClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the CopyClusterSnapshot operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotAlreadyExistsException- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterSnapshotQuotaExceededException- The request would result in the user exceeding the allowed number of cluster snapshots.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
AuthenticationProfileAlreadyExistsException- The authentication profile already exists.AuthenticationProfileQuotaExceededException- The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.InvalidAuthenticationProfileRequestException- The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateAuthenticationProfileRequest.builder()- Parameters:
createAuthenticationProfileRequest- AConsumerthat will call methods onCreateAuthenticationProfileRequest.Builderto create a request.- Returns:
- Result of the CreateAuthenticationProfile operation returned by the service.
- Throws:
AuthenticationProfileAlreadyExistsException- The authentication profile already exists.AuthenticationProfileQuotaExceededException- The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.InvalidAuthenticationProfileRequestException- The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterAlreadyExistsException- The account already has a cluster with the given identifier.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.ClusterQuotaExceededException- The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesQuotaExceededException- The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException- The operation would exceed the number of nodes allowed for a cluster.ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidVpcNetworkStateException- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException- The Elastic IP (EIP) is invalid or cannot be found.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidClusterTrackException- The provided cluster track name is not valid.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
Ipv6CidrBlockNotFoundException- There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.UnsupportedOperationException- The requested operation isn't supported.RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateClusterRequest.builder()- Parameters:
createClusterRequest- AConsumerthat will call methods onCreateClusterRequest.Builderto create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- Throws:
ClusterAlreadyExistsException- The account already has a cluster with the given identifier.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.ClusterQuotaExceededException- The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesQuotaExceededException- The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException- The operation would exceed the number of nodes allowed for a cluster.ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidVpcNetworkStateException- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException- The Elastic IP (EIP) is invalid or cannot be found.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidClusterTrackException- The provided cluster track name is not valid.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
Ipv6CidrBlockNotFoundException- There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.UnsupportedOperationException- The requested operation isn't supported.RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterParameterGroupQuotaExceededException- The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.ClusterParameterGroupAlreadyExistsException- A cluster parameter group with the same name already exists.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateClusterParameterGroupRequest.builder()- Parameters:
createClusterParameterGroupRequest- AConsumerthat will call methods onCreateClusterParameterGroupRequest.Builderto create a request.- Returns:
- Result of the CreateClusterParameterGroup operation returned by the service.
- Throws:
ClusterParameterGroupQuotaExceededException- The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.ClusterParameterGroupAlreadyExistsException- A cluster parameter group with the same name already exists.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterSecurityGroupAlreadyExistsException- A cluster security group with the same name already exists.ClusterSecurityGroupQuotaExceededException- The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateClusterSecurityGroupRequest.builder()- Parameters:
createClusterSecurityGroupRequest- AConsumerthat will call methods onCreateClusterSecurityGroupRequest.Builderto create a request.- Returns:
- Result of the CreateClusterSecurityGroup operation returned by the service.
- Throws:
ClusterSecurityGroupAlreadyExistsException- A cluster security group with the same name already exists.ClusterSecurityGroupQuotaExceededException- The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
availablestate.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.
- Throws:
ClusterSnapshotAlreadyExistsException- The value specified as a snapshot identifier is already used by an existing snapshot.InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotQuotaExceededException- The request would result in the user exceeding the allowed number of cluster snapshots.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
availablestate.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.Builderavoiding the need to create one manually viaCreateClusterSnapshotRequest.builder()- Parameters:
createClusterSnapshotRequest- AConsumerthat will call methods onCreateClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the CreateClusterSnapshot operation returned by the service.
- Throws:
ClusterSnapshotAlreadyExistsException- The value specified as a snapshot identifier is already used by an existing snapshot.InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotQuotaExceededException- The request would result in the user exceeding the allowed number of cluster snapshots.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterSubnetGroupAlreadyExistsException- A ClusterSubnetGroupName is already used by an existing cluster subnet group.ClusterSubnetGroupQuotaExceededException- The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.ClusterSubnetQuotaExceededException- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.InvalidSubnetException- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateClusterSubnetGroupRequest.builder()- Parameters:
createClusterSubnetGroupRequest- AConsumerthat will call methods onCreateClusterSubnetGroupRequest.Builderto create a request.- Returns:
- Result of the CreateClusterSubnetGroup operation returned by the service.
- Throws:
ClusterSubnetGroupAlreadyExistsException- A ClusterSubnetGroupName is already used by an existing cluster subnet group.ClusterSubnetGroupQuotaExceededException- The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.ClusterSubnetQuotaExceededException- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.InvalidSubnetException- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
UnsupportedOperationException- The requested operation isn't supported.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.CustomCnameAssociationException- An error occurred when an attempt was made to change the custom domain association.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateCustomDomainAssociationRequest.builder()- Parameters:
createCustomDomainAssociationRequest- AConsumerthat will call methods onCreateCustomDomainAssociationRequest.Builderto create a request.- Returns:
- Result of the CreateCustomDomainAssociation operation returned by the service.
- Throws:
UnsupportedOperationException- The requested operation isn't supported.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.CustomCnameAssociationException- An error occurred when an attempt was made to change the custom domain association.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.AccessToClusterDeniedException- You are not authorized to access the cluster.EndpointsPerClusterLimitExceededException- The number of Redshift-managed VPC endpoints per cluster has exceeded its limit.EndpointsPerAuthorizationLimitExceededException- The number of Redshift-managed VPC endpoints per authorization has exceeded its limit.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.EndpointAlreadyExistsException- The account already has a Redshift-managed VPC endpoint with the given identifier.UnsupportedOperationException- The requested operation isn't supported.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateEndpointAccessRequest.builder()- Parameters:
createEndpointAccessRequest- AConsumerthat will call methods onCreateEndpointAccessRequest.Builderto create a request.- Returns:
- Result of the CreateEndpointAccess operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.AccessToClusterDeniedException- You are not authorized to access the cluster.EndpointsPerClusterLimitExceededException- The number of Redshift-managed VPC endpoints per cluster has exceeded its limit.EndpointsPerAuthorizationLimitExceededException- The number of Redshift-managed VPC endpoints per authorization has exceeded its limit.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.EndpointAlreadyExistsException- The account already has a Redshift-managed VPC endpoint with the given identifier.UnsupportedOperationException- The requested operation isn't supported.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
EventSubscriptionQuotaExceededException- The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.SubscriptionAlreadyExistException- There is already an existing event notification subscription with the specified name.SnsInvalidTopicException- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SnsNoAuthorizationException- You do not have permission to publish to the specified Amazon SNS topic.SnsTopicArnNotFoundException- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException- The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.SubscriptionSeverityNotFoundException- The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException- The specified Amazon Redshift event source could not be found.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateEventSubscriptionRequest.builder()- Parameters:
createEventSubscriptionRequest- AConsumerthat will call methods onCreateEventSubscriptionRequest.Builderto create a request.- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException- The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.SubscriptionAlreadyExistException- There is already an existing event notification subscription with the specified name.SnsInvalidTopicException- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SnsNoAuthorizationException- You do not have permission to publish to the specified Amazon SNS topic.SnsTopicArnNotFoundException- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException- The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.SubscriptionSeverityNotFoundException- The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException- The specified Amazon Redshift event source could not be found.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
HsmClientCertificateAlreadyExistsException- There is already an existing Amazon Redshift HSM client certificate with the specified identifier.HsmClientCertificateQuotaExceededException- The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateHsmClientCertificateRequest.builder()- Parameters:
createHsmClientCertificateRequest- AConsumerthat will call methods onCreateHsmClientCertificateRequest.Builderto create a request.- Returns:
- Result of the CreateHsmClientCertificate operation returned by the service.
- Throws:
HsmClientCertificateAlreadyExistsException- There is already an existing Amazon Redshift HSM client certificate with the specified identifier.HsmClientCertificateQuotaExceededException- The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
HsmConfigurationAlreadyExistsException- There is already an existing Amazon Redshift HSM configuration with the specified identifier.HsmConfigurationQuotaExceededException- The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateHsmConfigurationRequest.builder()- Parameters:
createHsmConfigurationRequest- AConsumerthat will call methods onCreateHsmConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateHsmConfiguration operation returned by the service.
- Throws:
HsmConfigurationAlreadyExistsException- There is already an existing Amazon Redshift HSM configuration with the specified identifier.HsmConfigurationQuotaExceededException- The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
RedshiftIdcApplicationAlreadyExistsException- The application you attempted to add already exists.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.RedshiftIdcApplicationQuotaExceededException- The maximum number of Redshift IAM Identity Center applications was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateRedshiftIdcApplicationRequest.builder()- Parameters:
createRedshiftIdcApplicationRequest- AConsumerthat will call methods onCreateRedshiftIdcApplicationRequest.Builderto create a request.- Returns:
- Result of the CreateRedshiftIdcApplication operation returned by the service.
- Throws:
RedshiftIdcApplicationAlreadyExistsException- The application you attempted to add already exists.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.RedshiftIdcApplicationQuotaExceededException- The maximum number of Redshift IAM Identity Center applications was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ResizeClusterAPI operation.- Parameters:
createScheduledActionRequest-- Returns:
- Result of the CreateScheduledAction operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ScheduledActionAlreadyExistsException- The scheduled action already exists.ScheduledActionQuotaExceededException- The quota for scheduled actions exceeded.ScheduledActionTypeUnsupportedException- The action type specified for a scheduled action is not supported.InvalidScheduleException- The schedule you submitted isn't valid.InvalidScheduledActionException- The scheduled action is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ResizeClusterAPI operation.
This is a convenience which creates an instance of the
CreateScheduledActionRequest.Builderavoiding the need to create one manually viaCreateScheduledActionRequest.builder()- Parameters:
createScheduledActionRequest- AConsumerthat will call methods onCreateScheduledActionRequest.Builderto create a request.- Returns:
- Result of the CreateScheduledAction operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ScheduledActionAlreadyExistsException- The scheduled action already exists.ScheduledActionQuotaExceededException- The quota for scheduled actions exceeded.ScheduledActionTypeUnsupportedException- The action type specified for a scheduled action is not supported.InvalidScheduleException- The schedule you submitted isn't valid.InvalidScheduledActionException- The scheduled action is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 theCreateSnapshotCopyGrantaction.- Returns:
- Result of the CreateSnapshotCopyGrant operation returned by the service.
- Throws:
SnapshotCopyGrantAlreadyExistsException- The snapshot copy grant can't be created because a grant with the same name already exists.SnapshotCopyGrantQuotaExceededException- The Amazon Web Services account has exceeded the maximum number of snapshot copy grants in this region.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateSnapshotCopyGrantRequest.builder()- Parameters:
createSnapshotCopyGrantRequest- AConsumerthat will call methods onCreateSnapshotCopyGrantRequest.Builderto create a request. The result of theCreateSnapshotCopyGrantaction.- Returns:
- Result of the CreateSnapshotCopyGrant operation returned by the service.
- Throws:
SnapshotCopyGrantAlreadyExistsException- The snapshot copy grant can't be created because a grant with the same name already exists.SnapshotCopyGrantQuotaExceededException- The Amazon Web Services account has exceeded the maximum number of snapshot copy grants in this region.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SnapshotScheduleAlreadyExistsException- The specified snapshot schedule already exists.InvalidScheduleException- The schedule you submitted isn't valid.SnapshotScheduleQuotaExceededException- You have exceeded the quota of snapshot schedules.TagLimitExceededException- You have exceeded the number of tags allowed.ScheduleDefinitionTypeUnsupportedException- The definition you submitted is not supported.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateSnapshotScheduleRequest.builder()- Parameters:
createSnapshotScheduleRequest- AConsumerthat will call methods onCreateSnapshotScheduleRequest.Builderto create a request.- Returns:
- Result of the CreateSnapshotSchedule operation returned by the service.
- Throws:
SnapshotScheduleAlreadyExistsException- The specified snapshot schedule already exists.InvalidScheduleException- The schedule you submitted isn't valid.SnapshotScheduleQuotaExceededException- You have exceeded the quota of snapshot schedules.TagLimitExceededException- You have exceeded the number of tags allowed.ScheduleDefinitionTypeUnsupportedException- The definition you submitted is not supported.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 theCreateTagsaction.- Returns:
- Result of the CreateTags operation returned by the service.
- Throws:
TagLimitExceededException- You have exceeded the number of tags allowed.ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateTagsRequest.builder()- Parameters:
createTagsRequest- AConsumerthat will call methods onCreateTagsRequest.Builderto create a request. Contains the output from theCreateTagsaction.- Returns:
- Result of the CreateTags operation returned by the service.
- Throws:
TagLimitExceededException- You have exceeded the number of tags allowed.ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.UsageLimitAlreadyExistsException- The usage limit already exists.InvalidUsageLimitException- The usage limit is not valid.TagLimitExceededException- You have exceeded the number of tags allowed.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateUsageLimitRequest.builder()- Parameters:
createUsageLimitRequest- AConsumerthat will call methods onCreateUsageLimitRequest.Builderto create a request.- Returns:
- Result of the CreateUsageLimit operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.UsageLimitAlreadyExistsException- The usage limit already exists.InvalidUsageLimitException- The usage limit is not valid.TagLimitExceededException- You have exceeded the number of tags allowed.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deauthorizeDataShare
default DeauthorizeDataShareResponse deauthorizeDataShare(DeauthorizeDataShareRequest deauthorizeDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a datashare producer account, removes authorization from the specified datashare.
- Parameters:
deauthorizeDataShareRequest-- Returns:
- Result of the DeauthorizeDataShare operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deauthorizeDataShare
default DeauthorizeDataShareResponse deauthorizeDataShare(Consumer<DeauthorizeDataShareRequest.Builder> deauthorizeDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a datashare producer account, removes authorization from the specified datashare.
This is a convenience which creates an instance of the
DeauthorizeDataShareRequest.Builderavoiding the need to create one manually viaDeauthorizeDataShareRequest.builder()- Parameters:
deauthorizeDataShareRequest- AConsumerthat will call methods onDeauthorizeDataShareRequest.Builderto create a request.- Returns:
- Result of the DeauthorizeDataShare operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
AuthenticationProfileNotFoundException- The authentication profile can't be found.InvalidAuthenticationProfileRequestException- The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteAuthenticationProfileRequest.builder()- Parameters:
deleteAuthenticationProfileRequest- AConsumerthat will call methods onDeleteAuthenticationProfileRequest.Builderto create a request.- Returns:
- Result of the DeleteAuthenticationProfile operation returned by the service.
- Throws:
AuthenticationProfileNotFoundException- The authentication profile can't be found.InvalidAuthenticationProfileRequestException- The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
falseand 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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterSnapshotAlreadyExistsException- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotQuotaExceededException- The request would result in the user exceeding the allowed number of cluster snapshots.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
falseand 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.Builderavoiding the need to create one manually viaDeleteClusterRequest.builder()- Parameters:
deleteClusterRequest- AConsumerthat will call methods onDeleteClusterRequest.Builderto create a request.- Returns:
- Result of the DeleteCluster operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterSnapshotAlreadyExistsException- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotQuotaExceededException- The request would result in the user exceeding the allowed number of cluster snapshots.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterParameterGroupStateException- The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteClusterParameterGroupRequest.builder()- Parameters:
deleteClusterParameterGroupRequest- AConsumerthat will call methods onDeleteClusterParameterGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteClusterParameterGroup operation returned by the service.
- Throws:
InvalidClusterParameterGroupStateException- The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteClusterSecurityGroupRequest.builder()- Parameters:
deleteClusterSecurityGroupRequest- AConsumerthat will call methods onDeleteClusterSecurityGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteClusterSecurityGroup operation returned by the service.
- Throws:
InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteClusterSnapshot
default DeleteClusterSnapshotResponse deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) throws InvalidClusterSnapshotStateException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified manual snapshot. The snapshot must be in the
availablestate, 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.
- Throws:
InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
availablestate, 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.Builderavoiding the need to create one manually viaDeleteClusterSnapshotRequest.builder()- Parameters:
deleteClusterSnapshotRequest- AConsumerthat will call methods onDeleteClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the DeleteClusterSnapshot operation returned by the service.
- Throws:
InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterSubnetGroupStateException- The cluster subnet group cannot be deleted because it is in use.InvalidClusterSubnetStateException- The state of the subnet is invalid.ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteClusterSubnetGroupRequest.builder()- Parameters:
deleteClusterSubnetGroupRequest- AConsumerthat will call methods onDeleteClusterSubnetGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteClusterSubnetGroup operation returned by the service.
- Throws:
InvalidClusterSubnetGroupStateException- The cluster subnet group cannot be deleted because it is in use.InvalidClusterSubnetStateException- The state of the subnet is invalid.ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
UnsupportedOperationException- The requested operation isn't supported.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.CustomCnameAssociationException- An error occurred when an attempt was made to change the custom domain association.CustomDomainAssociationNotFoundException- An error occurred. The custom domain name couldn't be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteCustomDomainAssociationRequest.builder()- Parameters:
deleteCustomDomainAssociationRequest- AConsumerthat will call methods onDeleteCustomDomainAssociationRequest.Builderto create a request.- Returns:
- Result of the DeleteCustomDomainAssociation operation returned by the service.
- Throws:
UnsupportedOperationException- The requested operation isn't supported.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.CustomCnameAssociationException- An error occurred when an attempt was made to change the custom domain association.CustomDomainAssociationNotFoundException- An error occurred. The custom domain name couldn't be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidEndpointStateException- The status of the endpoint is not valid.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteEndpointAccessRequest.builder()- Parameters:
deleteEndpointAccessRequest- AConsumerthat will call methods onDeleteEndpointAccessRequest.Builderto create a request.- Returns:
- Result of the DeleteEndpointAccess operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidEndpointStateException- The status of the endpoint is not valid.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidSubscriptionStateException- The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteEventSubscriptionRequest.builder()- Parameters:
deleteEventSubscriptionRequest- AConsumerthat will call methods onDeleteEventSubscriptionRequest.Builderto create a request.- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidSubscriptionStateException- The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidHsmClientCertificateStateException- The specified HSM client certificate is not in theavailablestate, or it is still in use by one or more Amazon Redshift clusters.HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteHsmClientCertificateRequest.builder()- Parameters:
deleteHsmClientCertificateRequest- AConsumerthat will call methods onDeleteHsmClientCertificateRequest.Builderto create a request.- Returns:
- Result of the DeleteHsmClientCertificate operation returned by the service.
- Throws:
InvalidHsmClientCertificateStateException- The specified HSM client certificate is not in theavailablestate, or it is still in use by one or more Amazon Redshift clusters.HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidHsmConfigurationStateException- The specified HSM configuration is not in theavailablestate, or it is still in use by one or more Amazon Redshift clusters.HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteHsmConfigurationRequest.builder()- Parameters:
deleteHsmConfigurationRequest- AConsumerthat will call methods onDeleteHsmConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteHsmConfiguration operation returned by the service.
- Throws:
InvalidHsmConfigurationStateException- The specified HSM configuration is not in theavailablestate, or it is still in use by one or more Amazon Redshift clusters.HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
PartnerNotFoundException- The name of the partner was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException- The partner integration is not authorized.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeletePartnerRequest.builder()- Parameters:
deletePartnerRequest- AConsumerthat will call methods onDeletePartnerRequest.Builderto create a request.- Returns:
- Result of the DeletePartner operation returned by the service.
- Throws:
PartnerNotFoundException- The name of the partner was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException- The partner integration is not authorized.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteRedshiftIdcApplicationRequest.builder()- Parameters:
deleteRedshiftIdcApplicationRequest- AConsumerthat will call methods onDeleteRedshiftIdcApplicationRequest.Builderto create a request.- Returns:
- Result of the DeleteRedshiftIdcApplication operation returned by the service.
- Throws:
RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The resource could not be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()- Parameters:
deleteResourcePolicyRequest- AConsumerthat will call methods onDeleteResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- Throws:
ResourceNotFoundException- The resource could not be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ScheduledActionNotFoundException- The scheduled action cannot be found.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteScheduledActionRequest.builder()- Parameters:
deleteScheduledActionRequest- AConsumerthat will call methods onDeleteScheduledActionRequest.Builderto create a request.- Returns:
- Result of the DeleteScheduledAction operation returned by the service.
- Throws:
ScheduledActionNotFoundException- The scheduled action cannot be found.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSnapshotCopyGrant
default DeleteSnapshotCopyGrantResponse deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest) throws InvalidSnapshotCopyGrantStateException, SnapshotCopyGrantNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified snapshot copy grant.
- Parameters:
deleteSnapshotCopyGrantRequest- The result of theDeleteSnapshotCopyGrantaction.- Returns:
- Result of the DeleteSnapshotCopyGrant operation returned by the service.
- Throws:
InvalidSnapshotCopyGrantStateException- The snapshot copy grant can't be deleted because it is used by one or more clusters.SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteSnapshotCopyGrantRequest.builder()- Parameters:
deleteSnapshotCopyGrantRequest- AConsumerthat will call methods onDeleteSnapshotCopyGrantRequest.Builderto create a request. The result of theDeleteSnapshotCopyGrantaction.- Returns:
- Result of the DeleteSnapshotCopyGrant operation returned by the service.
- Throws:
InvalidSnapshotCopyGrantStateException- The snapshot copy grant can't be deleted because it is used by one or more clusters.SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterSnapshotScheduleStateException- The cluster snapshot schedule state is not valid.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteSnapshotScheduleRequest.builder()- Parameters:
deleteSnapshotScheduleRequest- AConsumerthat will call methods onDeleteSnapshotScheduleRequest.Builderto create a request.- Returns:
- Result of the DeleteSnapshotSchedule operation returned by the service.
- Throws:
InvalidClusterSnapshotScheduleStateException- The cluster snapshot schedule state is not valid.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 theDeleteTagsaction.- Returns:
- Result of the DeleteTags operation returned by the service.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteTagsRequest.builder()- Parameters:
deleteTagsRequest- AConsumerthat will call methods onDeleteTagsRequest.Builderto create a request. Contains the output from theDeleteTagsaction.- Returns:
- Result of the DeleteTags operation returned by the service.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
UsageLimitNotFoundException- The usage limit identifier can't be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteUsageLimitRequest.builder()- Parameters:
deleteUsageLimitRequest- AConsumerthat will call methods onDeleteUsageLimitRequest.Builderto create a request.- Returns:
- Result of the DeleteUsageLimit operation returned by the service.
- Throws:
UsageLimitNotFoundException- The usage limit identifier can't be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeAccountAttributesRequest.builder()- Parameters:
describeAccountAttributesRequest- AConsumerthat will call methods onDescribeAccountAttributesRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes() throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of attributes attached to an account
- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeAccountAttributes(DescribeAccountAttributesRequest), AWS API Documentation
-
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.
- Throws:
AuthenticationProfileNotFoundException- The authentication profile can't be found.InvalidAuthenticationProfileRequestException- The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeAuthenticationProfilesRequest.builder()- Parameters:
describeAuthenticationProfilesRequest- AConsumerthat will call methods onDescribeAuthenticationProfilesRequest.Builderto create a request.- Returns:
- Result of the DescribeAuthenticationProfiles operation returned by the service.
- Throws:
AuthenticationProfileNotFoundException- The authentication profile can't be found.InvalidAuthenticationProfileRequestException- The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterDbRevisions
default DescribeClusterDbRevisionsResponse describeClusterDbRevisions(DescribeClusterDbRevisionsRequest describeClusterDbRevisionsRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of
ClusterDbRevisionobjects.- Parameters:
describeClusterDbRevisionsRequest-- Returns:
- Result of the DescribeClusterDbRevisions operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterDbRevisions
default DescribeClusterDbRevisionsResponse describeClusterDbRevisions(Consumer<DescribeClusterDbRevisionsRequest.Builder> describeClusterDbRevisionsRequest) throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of
ClusterDbRevisionobjects.
This is a convenience which creates an instance of the
DescribeClusterDbRevisionsRequest.Builderavoiding the need to create one manually viaDescribeClusterDbRevisionsRequest.builder()- Parameters:
describeClusterDbRevisionsRequest- AConsumerthat will call methods onDescribeClusterDbRevisionsRequest.Builderto create a request.- Returns:
- Result of the DescribeClusterDbRevisions operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterDbRevisions
default DescribeClusterDbRevisionsResponse describeClusterDbRevisions() throws ClusterNotFoundException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Returns an array of
ClusterDbRevisionobjects.- Returns:
- Result of the DescribeClusterDbRevisions operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterDbRevisions(DescribeClusterDbRevisionsRequest), AWS API Documentation
-
describeClusterDbRevisionsPaginator
default DescribeClusterDbRevisionsIterable describeClusterDbRevisionsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterDbRevisionsPaginator(DescribeClusterDbRevisionsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeClusterDbRevisionsRequest.builder()- Parameters:
describeClusterDbRevisionsRequest- AConsumerthat will call methods onDescribeClusterDbRevisionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.Builderavoiding the need to create one manually viaDescribeClusterParameterGroupsRequest.builder()- Parameters:
describeClusterParameterGroupsRequest- AConsumerthat will call methods onDescribeClusterParameterGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeClusterParameterGroups operation returned by the service.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterParameterGroups
default DescribeClusterParameterGroupsResponse describeClusterParameterGroups() throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterParameterGroups(DescribeClusterParameterGroupsRequest), AWS API Documentation
-
describeClusterParameterGroupsPaginator
default DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeClusterParameterGroupsRequest.builder()- Parameters:
describeClusterParameterGroupsRequest- AConsumerthat will call methods onDescribeClusterParameterGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeClusterParametersRequest.builder()- Parameters:
describeClusterParametersRequest- AConsumerthat will call methods onDescribeClusterParametersRequest.Builderto create a request.- Returns:
- Result of the DescribeClusterParameters operation returned by the service.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeClusterParametersRequest.builder()- Parameters:
describeClusterParametersRequest- AConsumerthat will call methods onDescribeClusterParametersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.Builderavoiding the need to create one manually viaDescribeClusterSecurityGroupsRequest.builder()- Parameters:
describeClusterSecurityGroupsRequest- AConsumerthat will call methods onDescribeClusterSecurityGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeClusterSecurityGroups operation returned by the service.
- Throws:
ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeClusterSecurityGroupsRequest.builder()- Parameters:
describeClusterSecurityGroupsRequest- AConsumerthat will call methods onDescribeClusterSecurityGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidTagException- The tag is invalid.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.Builderavoiding the need to create one manually viaDescribeClusterSnapshotsRequest.builder()- Parameters:
describeClusterSnapshotsRequest- AConsumerthat will call methods onDescribeClusterSnapshotsRequest.Builderto create a request.- Returns:
- Result of the DescribeClusterSnapshots operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidTagException- The tag is invalid.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterSnapshots
default DescribeClusterSnapshotsResponse describeClusterSnapshots() throws ClusterNotFoundException, ClusterSnapshotNotFoundException, InvalidTagException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidTagException- The tag is invalid.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterSnapshots(DescribeClusterSnapshotsRequest), AWS API Documentation
-
describeClusterSnapshotsPaginator
default DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidTagException- The tag is invalid.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidTagException- The tag is invalid.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeClusterSnapshotsRequest.builder()- Parameters:
describeClusterSnapshotsRequest- AConsumerthat will call methods onDescribeClusterSnapshotsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidTagException- The tag is invalid.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.Builderavoiding the need to create one manually viaDescribeClusterSubnetGroupsRequest.builder()- Parameters:
describeClusterSubnetGroupsRequest- AConsumerthat will call methods onDescribeClusterSubnetGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeClusterSubnetGroups operation returned by the service.
- Throws:
ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterSubnetGroups
default DescribeClusterSubnetGroupsResponse describeClusterSubnetGroups() throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest), AWS API Documentation
-
describeClusterSubnetGroupsPaginator
default DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeClusterSubnetGroupsRequest.builder()- Parameters:
describeClusterSubnetGroupsRequest- AConsumerthat will call methods onDescribeClusterSubnetGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterTrackException- The provided cluster track name is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeClusterTracksRequest.builder()- Parameters:
describeClusterTracksRequest- AConsumerthat will call methods onDescribeClusterTracksRequest.Builderto create a request.- Returns:
- Result of the DescribeClusterTracks operation returned by the service.
- Throws:
InvalidClusterTrackException- The provided cluster track name is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterTracks
default DescribeClusterTracksResponse describeClusterTracks() throws InvalidClusterTrackException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of all the available maintenance tracks.
- Returns:
- Result of the DescribeClusterTracks operation returned by the service.
- Throws:
InvalidClusterTrackException- The provided cluster track name is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterTracks(DescribeClusterTracksRequest), AWS API Documentation
-
describeClusterTracksPaginator
default DescribeClusterTracksIterable describeClusterTracksPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidClusterTrackException- The provided cluster track name is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterTracksPaginator(DescribeClusterTracksRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidClusterTrackException- The provided cluster track name is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeClusterTracksRequest.builder()- Parameters:
describeClusterTracksRequest- AConsumerthat will call methods onDescribeClusterTracksRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidClusterTrackException- The provided cluster track name is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeClusterVersionsRequest.builder()- Parameters:
describeClusterVersionsRequest- AConsumerthat will call methods onDescribeClusterVersionsRequest.Builderto create a request.- Returns:
- Result of the DescribeClusterVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterVersions
default DescribeClusterVersionsResponse describeClusterVersions() throws AwsServiceException, SdkClientException, RedshiftException
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
- Returns:
- Result of the DescribeClusterVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterVersions(DescribeClusterVersionsRequest), AWS API Documentation
-
describeClusterVersionsPaginator
default DescribeClusterVersionsIterable describeClusterVersionsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusterVersionsPaginator(DescribeClusterVersionsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeClusterVersionsRequest.builder()- Parameters:
describeClusterVersionsRequest- AConsumerthat will call methods onDescribeClusterVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.Builderavoiding the need to create one manually viaDescribeClustersRequest.builder()- Parameters:
describeClustersRequest- AConsumerthat will call methods onDescribeClustersRequest.Builderto create a request.- Returns:
- Result of the DescribeClusters operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusters
default DescribeClustersResponse describeClusters() throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClusters(DescribeClustersRequest), AWS API Documentation
-
describeClustersPaginator
default DescribeClustersIterable describeClustersPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeClustersPaginator(DescribeClustersRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeClustersRequest.builder()- Parameters:
describeClustersRequest- AConsumerthat will call methods onDescribeClustersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
CustomDomainAssociationNotFoundException- An error occurred. The custom domain name couldn't be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeCustomDomainAssociationsRequest.builder()- Parameters:
describeCustomDomainAssociationsRequest- AConsumerthat will call methods onDescribeCustomDomainAssociationsRequest.Builderto create a request.- Returns:
- Result of the DescribeCustomDomainAssociations operation returned by the service.
- Throws:
CustomDomainAssociationNotFoundException- An error occurred. The custom domain name couldn't be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
CustomDomainAssociationNotFoundException- An error occurred. The custom domain name couldn't be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeCustomDomainAssociationsRequest.builder()- Parameters:
describeCustomDomainAssociationsRequest- AConsumerthat will call methods onDescribeCustomDomainAssociationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
CustomDomainAssociationNotFoundException- An error occurred. The custom domain name couldn't be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataShares
default DescribeDataSharesResponse describeDataShares(DescribeDataSharesRequest describeDataSharesRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
Shows the status of any inbound or outbound datashares available in the specified account.
- Parameters:
describeDataSharesRequest-- Returns:
- Result of the DescribeDataShares operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataShares
default DescribeDataSharesResponse describeDataShares(Consumer<DescribeDataSharesRequest.Builder> describeDataSharesRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
Shows the status of any inbound or outbound datashares available in the specified account.
This is a convenience which creates an instance of the
DescribeDataSharesRequest.Builderavoiding the need to create one manually viaDescribeDataSharesRequest.builder()- Parameters:
describeDataSharesRequest- AConsumerthat will call methods onDescribeDataSharesRequest.Builderto create a request.- Returns:
- Result of the DescribeDataShares operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesPaginator
default DescribeDataSharesIterable describeDataSharesPaginator(DescribeDataSharesRequest describeDataSharesRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
This is a variant of
describeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client.describeDataSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client .describeDataSharesPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client.describeDataSharesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)operation.- Parameters:
describeDataSharesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesPaginator
default DescribeDataSharesIterable describeDataSharesPaginator(Consumer<DescribeDataSharesRequest.Builder> describeDataSharesRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
This is a variant of
describeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client.describeDataSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client .describeDataSharesPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesIterable responses = client.describeDataSharesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataShares(software.amazon.awssdk.services.redshift.model.DescribeDataSharesRequest)operation.
This is a convenience which creates an instance of the
DescribeDataSharesRequest.Builderavoiding the need to create one manually viaDescribeDataSharesRequest.builder()- Parameters:
describeDataSharesRequest- AConsumerthat will call methods onDescribeDataSharesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesForConsumer
default DescribeDataSharesForConsumerResponse describeDataSharesForConsumer(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares where the account identifier being called is a consumer account identifier.
- Parameters:
describeDataSharesForConsumerRequest-- Returns:
- Result of the DescribeDataSharesForConsumer operation returned by the service.
- Throws:
InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesForConsumer
default DescribeDataSharesForConsumerResponse describeDataSharesForConsumer(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares where the account identifier being called is a consumer account identifier.
This is a convenience which creates an instance of the
DescribeDataSharesForConsumerRequest.Builderavoiding the need to create one manually viaDescribeDataSharesForConsumerRequest.builder()- Parameters:
describeDataSharesForConsumerRequest- AConsumerthat will call methods onDescribeDataSharesForConsumerRequest.Builderto create a request.- Returns:
- Result of the DescribeDataSharesForConsumer operation returned by the service.
- Throws:
InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesForConsumerPaginator
default DescribeDataSharesForConsumerIterable describeDataSharesForConsumerPaginator(DescribeDataSharesForConsumerRequest describeDataSharesForConsumerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
This is a variant of
describeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client.describeDataSharesForConsumerPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client .describeDataSharesForConsumerPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client.describeDataSharesForConsumerPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)operation.- Parameters:
describeDataSharesForConsumerRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesForConsumerPaginator
default DescribeDataSharesForConsumerIterable describeDataSharesForConsumerPaginator(Consumer<DescribeDataSharesForConsumerRequest.Builder> describeDataSharesForConsumerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
This is a variant of
describeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client.describeDataSharesForConsumerPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client .describeDataSharesForConsumerPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForConsumerIterable responses = client.describeDataSharesForConsumerPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataSharesForConsumer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForConsumerRequest)operation.
This is a convenience which creates an instance of the
DescribeDataSharesForConsumerRequest.Builderavoiding the need to create one manually viaDescribeDataSharesForConsumerRequest.builder()- Parameters:
describeDataSharesForConsumerRequest- AConsumerthat will call methods onDescribeDataSharesForConsumerRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesForProducer
default DescribeDataSharesForProducerResponse describeDataSharesForProducer(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares when the account identifier being called is a producer account identifier.
- Parameters:
describeDataSharesForProducerRequest-- Returns:
- Result of the DescribeDataSharesForProducer operation returned by the service.
- Throws:
InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesForProducer
default DescribeDataSharesForProducerResponse describeDataSharesForProducer(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of datashares when the account identifier being called is a producer account identifier.
This is a convenience which creates an instance of the
DescribeDataSharesForProducerRequest.Builderavoiding the need to create one manually viaDescribeDataSharesForProducerRequest.builder()- Parameters:
describeDataSharesForProducerRequest- AConsumerthat will call methods onDescribeDataSharesForProducerRequest.Builderto create a request.- Returns:
- Result of the DescribeDataSharesForProducer operation returned by the service.
- Throws:
InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesForProducerPaginator
default DescribeDataSharesForProducerIterable describeDataSharesForProducerPaginator(DescribeDataSharesForProducerRequest describeDataSharesForProducerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
This is a variant of
describeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client.describeDataSharesForProducerPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client .describeDataSharesForProducerPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client.describeDataSharesForProducerPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)operation.- Parameters:
describeDataSharesForProducerRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSharesForProducerPaginator
default DescribeDataSharesForProducerIterable describeDataSharesForProducerPaginator(Consumer<DescribeDataSharesForProducerRequest.Builder> describeDataSharesForProducerRequest) throws InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
This is a variant of
describeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client.describeDataSharesForProducerPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client .describeDataSharesForProducerPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.redshift.paginators.DescribeDataSharesForProducerIterable responses = client.describeDataSharesForProducerPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataSharesForProducer(software.amazon.awssdk.services.redshift.model.DescribeDataSharesForProducerRequest)operation.
This is a convenience which creates an instance of the
DescribeDataSharesForProducerRequest.Builderavoiding the need to create one manually viaDescribeDataSharesForProducerRequest.builder()- Parameters:
describeDataSharesForProducerRequest- AConsumerthat will call methods onDescribeDataSharesForProducerRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeDefaultClusterParametersRequest.builder()- Parameters:
describeDefaultClusterParametersRequest- AConsumerthat will call methods onDescribeDefaultClusterParametersRequest.Builderto create a request.- Returns:
- Result of the DescribeDefaultClusterParameters operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeDefaultClusterParametersRequest.builder()- Parameters:
describeDefaultClusterParametersRequest- AConsumerthat will call methods onDescribeDefaultClusterParametersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeEndpointAccessRequest.builder()- Parameters:
describeEndpointAccessRequest- AConsumerthat will call methods onDescribeEndpointAccessRequest.Builderto create a request.- Returns:
- Result of the DescribeEndpointAccess operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeEndpointAccessRequest.builder()- Parameters:
describeEndpointAccessRequest- AConsumerthat will call methods onDescribeEndpointAccessRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeEndpointAuthorizationRequest.builder()- Parameters:
describeEndpointAuthorizationRequest- AConsumerthat will call methods onDescribeEndpointAuthorizationRequest.Builderto create a request.- Returns:
- Result of the DescribeEndpointAuthorization operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeEndpointAuthorizationRequest.builder()- Parameters:
describeEndpointAuthorizationRequest- AConsumerthat will call methods onDescribeEndpointAuthorizationRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeEventCategoriesRequest.builder()- Parameters:
describeEventCategoriesRequest- AConsumerthat will call methods onDescribeEventCategoriesRequest.Builderto create a request.- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, RedshiftException
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEventCategories(DescribeEventCategoriesRequest), AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.Builderavoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()- Parameters:
describeEventSubscriptionsRequest- AConsumerthat will call methods onDescribeEventSubscriptionsRequest.Builderto create a request.- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions() throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEventSubscriptions(DescribeEventSubscriptionsRequest), AWS API Documentation
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()- Parameters:
describeEventSubscriptionsRequest- AConsumerthat will call methods onDescribeEventSubscriptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeEventsRequest.builder()- Parameters:
describeEventsRequest- AConsumerthat will call methods onDescribeEventsRequest.Builderto create a request.- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEvents
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, RedshiftException
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEvents(DescribeEventsRequest), AWS API Documentation
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEventsPaginator(DescribeEventsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeEventsRequest.builder()- Parameters:
describeEventsRequest- AConsumerthat will call methods onDescribeEventsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.Builderavoiding the need to create one manually viaDescribeHsmClientCertificatesRequest.builder()- Parameters:
describeHsmClientCertificatesRequest- AConsumerthat will call methods onDescribeHsmClientCertificatesRequest.Builderto create a request.- Returns:
- Result of the DescribeHsmClientCertificates operation returned by the service.
- Throws:
HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeHsmClientCertificates
default DescribeHsmClientCertificatesResponse describeHsmClientCertificates() throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeHsmClientCertificates(DescribeHsmClientCertificatesRequest), AWS API Documentation
-
describeHsmClientCertificatesPaginator
default DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeHsmClientCertificatesRequest.builder()- Parameters:
describeHsmClientCertificatesRequest- AConsumerthat will call methods onDescribeHsmClientCertificatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ownerandenvironmentfor tag keys, andadminandtestfor 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.Builderavoiding the need to create one manually viaDescribeHsmConfigurationsRequest.builder()- Parameters:
describeHsmConfigurationsRequest- AConsumerthat will call methods onDescribeHsmConfigurationsRequest.Builderto create a request.- Returns:
- Result of the DescribeHsmConfigurations operation returned by the service.
- Throws:
HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeHsmConfigurations
default DescribeHsmConfigurationsResponse describeHsmConfigurations() throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeHsmConfigurations(DescribeHsmConfigurationsRequest), AWS API Documentation
-
describeHsmConfigurationsPaginator
default DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeHsmConfigurationsRequest.builder()- Parameters:
describeHsmConfigurationsRequest- AConsumerthat will call methods onDescribeHsmConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
IntegrationNotFoundException- The integration can't be found.InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeInboundIntegrationsRequest.builder()- Parameters:
describeInboundIntegrationsRequest- AConsumerthat will call methods onDescribeInboundIntegrationsRequest.Builderto create a request.- Returns:
- Result of the DescribeInboundIntegrations operation returned by the service.
- Throws:
IntegrationNotFoundException- The integration can't be found.InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
IntegrationNotFoundException- The integration can't be found.InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeInboundIntegrationsRequest.builder()- Parameters:
describeInboundIntegrationsRequest- AConsumerthat will call methods onDescribeInboundIntegrationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
IntegrationNotFoundException- The integration can't be found.InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeLoggingStatusRequest.builder()- Parameters:
describeLoggingStatusRequest- AConsumerthat will call methods onDescribeLoggingStatusRequest.Builderto create a request.- Returns:
- Result of the DescribeLoggingStatus operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.AccessToSnapshotDeniedException- The owner of the specified snapshot has not authorized your account to access the snapshot.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeNodeConfigurationOptionsRequest.builder()- Parameters:
describeNodeConfigurationOptionsRequest- AConsumerthat will call methods onDescribeNodeConfigurationOptionsRequest.Builderto create a request.- Returns:
- Result of the DescribeNodeConfigurationOptions operation returned by the service.
- Throws:
ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.AccessToSnapshotDeniedException- The owner of the specified snapshot has not authorized your account to access the snapshot.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.AccessToSnapshotDeniedException- The owner of the specified snapshot has not authorized your account to access the snapshot.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeNodeConfigurationOptionsRequest.builder()- Parameters:
describeNodeConfigurationOptionsRequest- AConsumerthat will call methods onDescribeNodeConfigurationOptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.AccessToSnapshotDeniedException- The owner of the specified snapshot has not authorized your account to access the snapshot.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeOrderableClusterOptionsRequest.builder()- Parameters:
describeOrderableClusterOptionsRequest- AConsumerthat will call methods onDescribeOrderableClusterOptionsRequest.Builderto create a request.- Returns:
- Result of the DescribeOrderableClusterOptions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeOrderableClusterOptions
default DescribeOrderableClusterOptionsResponse describeOrderableClusterOptions() throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
- Returns:
- Result of the DescribeOrderableClusterOptions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest), AWS API Documentation
-
describeOrderableClusterOptionsPaginator
default DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeOrderableClusterOptionsRequest.builder()- Parameters:
describeOrderableClusterOptionsRequest- AConsumerthat will call methods onDescribeOrderableClusterOptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException- The partner integration is not authorized.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribePartnersRequest.builder()- Parameters:
describePartnersRequest- AConsumerthat will call methods onDescribePartnersRequest.Builderto create a request.- Returns:
- Result of the DescribePartners operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException- The partner integration is not authorized.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeRedshiftIdcApplicationsRequest.builder()- Parameters:
describeRedshiftIdcApplicationsRequest- AConsumerthat will call methods onDescribeRedshiftIdcApplicationsRequest.Builderto create a request.- Returns:
- Result of the DescribeRedshiftIdcApplications operation returned by the service.
- Throws:
RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeRedshiftIdcApplicationsRequest.builder()- Parameters:
describeRedshiftIdcApplicationsRequest- AConsumerthat will call methods onDescribeRedshiftIdcApplicationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.ReservedNodeExchangeNotFoundException- The reserved-node exchange status wasn't found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeReservedNodeExchangeStatusRequest.builder()- Parameters:
describeReservedNodeExchangeStatusRequest- AConsumerthat will call methods onDescribeReservedNodeExchangeStatusRequest.Builderto create a request.- Returns:
- Result of the DescribeReservedNodeExchangeStatus operation returned by the service.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.ReservedNodeExchangeNotFoundException- The reserved-node exchange status wasn't found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.ReservedNodeExchangeNotFoundException- The reserved-node exchange status wasn't found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeReservedNodeExchangeStatusRequest.builder()- Parameters:
describeReservedNodeExchangeStatusRequest- AConsumerthat will call methods onDescribeReservedNodeExchangeStatusRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.ReservedNodeExchangeNotFoundException- The reserved-node exchange status wasn't found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeReservedNodeOfferingsRequest.builder()- Parameters:
describeReservedNodeOfferingsRequest- AConsumerthat will call methods onDescribeReservedNodeOfferingsRequest.Builderto create a request.- Returns:
- Result of the DescribeReservedNodeOfferings operation returned by the service.
- Throws:
ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedNodeOfferings
default DescribeReservedNodeOfferingsResponse describeReservedNodeOfferings() throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
- Returns:
- Result of the DescribeReservedNodeOfferings operation returned by the service.
- Throws:
ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest), AWS API Documentation
-
describeReservedNodeOfferingsPaginator
default DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeReservedNodeOfferingsRequest.builder()- Parameters:
describeReservedNodeOfferingsRequest- AConsumerthat will call methods onDescribeReservedNodeOfferingsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeReservedNodesRequest.builder()- Parameters:
describeReservedNodesRequest- AConsumerthat will call methods onDescribeReservedNodesRequest.Builderto create a request.- Returns:
- Result of the DescribeReservedNodes operation returned by the service.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedNodes
default DescribeReservedNodesResponse describeReservedNodes() throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
- Returns:
- Result of the DescribeReservedNodes operation returned by the service.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeReservedNodes(DescribeReservedNodesRequest), AWS API Documentation
-
describeReservedNodesPaginator
default DescribeReservedNodesIterable describeReservedNodesPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeReservedNodesPaginator(DescribeReservedNodesRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeReservedNodesRequest.builder()- Parameters:
describeReservedNodesRequest- AConsumerthat will call methods onDescribeReservedNodesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 404error is returned. If a resize operation was initiated and completed, the status of the resize remains asSUCCEEDEDuntil 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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ResizeNotFoundException- A resize operation for the specified cluster is not found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 404error is returned. If a resize operation was initiated and completed, the status of the resize remains asSUCCEEDEDuntil 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.Builderavoiding the need to create one manually viaDescribeResizeRequest.builder()- Parameters:
describeResizeRequest- AConsumerthat will call methods onDescribeResizeRequest.Builderto create a request.- Returns:
- Result of the DescribeResize operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ResizeNotFoundException- A resize operation for the specified cluster is not found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ScheduledActionNotFoundException- The scheduled action cannot be found.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()- Parameters:
describeScheduledActionsRequest- AConsumerthat will call methods onDescribeScheduledActionsRequest.Builderto create a request.- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- Throws:
ScheduledActionNotFoundException- The scheduled action cannot be found.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ScheduledActionNotFoundException- The scheduled action cannot be found.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()- Parameters:
describeScheduledActionsRequest- AConsumerthat will call methods onDescribeScheduledActionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ScheduledActionNotFoundException- The scheduled action cannot be found.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 theDescribeSnapshotCopyGrantsaction.- Returns:
- Result of the DescribeSnapshotCopyGrants operation returned by the service.
- Throws:
SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeSnapshotCopyGrantsRequest.builder()- Parameters:
describeSnapshotCopyGrantsRequest- AConsumerthat will call methods onDescribeSnapshotCopyGrantsRequest.Builderto create a request. The result of theDescribeSnapshotCopyGrantsaction.- Returns:
- Result of the DescribeSnapshotCopyGrants operation returned by the service.
- Throws:
SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshotCopyGrants
default DescribeSnapshotCopyGrantsResponse describeSnapshotCopyGrants() throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
- Returns:
- Result of the DescribeSnapshotCopyGrants operation returned by the service.
- Throws:
SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest), AWS API Documentation
-
describeSnapshotCopyGrantsPaginator
default DescribeSnapshotCopyGrantsIterable describeSnapshotCopyGrantsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeSnapshotCopyGrantsPaginator(DescribeSnapshotCopyGrantsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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 theDescribeSnapshotCopyGrantsaction.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeSnapshotCopyGrantsRequest.builder()- Parameters:
describeSnapshotCopyGrantsRequest- AConsumerthat will call methods onDescribeSnapshotCopyGrantsRequest.Builderto create a request. The result of theDescribeSnapshotCopyGrantsaction.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeSnapshotSchedulesRequest.builder()- Parameters:
describeSnapshotSchedulesRequest- AConsumerthat will call methods onDescribeSnapshotSchedulesRequest.Builderto create a request.- Returns:
- Result of the DescribeSnapshotSchedules operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshotSchedules
default DescribeSnapshotSchedulesResponse describeSnapshotSchedules() throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot schedules.
- Returns:
- Result of the DescribeSnapshotSchedules operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeSnapshotSchedules(DescribeSnapshotSchedulesRequest), AWS API Documentation
-
describeSnapshotSchedulesPaginator
default DescribeSnapshotSchedulesIterable describeSnapshotSchedulesPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeSnapshotSchedulesPaginator(DescribeSnapshotSchedulesRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeSnapshotSchedulesRequest.builder()- Parameters:
describeSnapshotSchedulesRequest- AConsumerthat will call methods onDescribeSnapshotSchedulesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeStorageRequest.builder()- Parameters:
describeStorageRequest- AConsumerthat will call methods onDescribeStorageRequest.Builderto create a request.- Returns:
- Result of the DescribeStorage operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeStorage
default DescribeStorageResponse describeStorage() throws AwsServiceException, SdkClientException, RedshiftException
Returns account level backups storage size and provisional storage.
- Returns:
- Result of the DescribeStorage operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeStorage(DescribeStorageRequest), AWS API Documentation
-
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
TableRestoreRequestIdparameter, thenDescribeTableRestoreStatusreturns the status of all table restore requests ordered by the date and time of the request in ascending order. OtherwiseDescribeTableRestoreStatusreturns the status of the table specified byTableRestoreRequestId.- Parameters:
describeTableRestoreStatusRequest-- Returns:
- Result of the DescribeTableRestoreStatus operation returned by the service.
- Throws:
TableRestoreNotFoundException- The specifiedTableRestoreRequestIdvalue was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
TableRestoreRequestIdparameter, thenDescribeTableRestoreStatusreturns the status of all table restore requests ordered by the date and time of the request in ascending order. OtherwiseDescribeTableRestoreStatusreturns the status of the table specified byTableRestoreRequestId.
This is a convenience which creates an instance of the
DescribeTableRestoreStatusRequest.Builderavoiding the need to create one manually viaDescribeTableRestoreStatusRequest.builder()- Parameters:
describeTableRestoreStatusRequest- AConsumerthat will call methods onDescribeTableRestoreStatusRequest.Builderto create a request.- Returns:
- Result of the DescribeTableRestoreStatus operation returned by the service.
- Throws:
TableRestoreNotFoundException- The specifiedTableRestoreRequestIdvalue was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
TableRestoreNotFoundException- The specifiedTableRestoreRequestIdvalue was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeTableRestoreStatusRequest.builder()- Parameters:
describeTableRestoreStatusRequest- AConsumerthat will call methods onDescribeTableRestoreStatusRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
TableRestoreNotFoundException- The specifiedTableRestoreRequestIdvalue was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
MaxRecordsandMarkerparameters together with the ARN parameter. -
The
MaxRecordsparameter 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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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
MaxRecordsandMarkerparameters together with the ARN parameter. -
The
MaxRecordsparameter 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
ownerandenvironmentfor tag keys, andadminandtestfor 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.Builderavoiding the need to create one manually viaDescribeTagsRequest.builder()- Parameters:
describeTagsRequest- AConsumerthat will call methods onDescribeTagsRequest.Builderto create a request.- Returns:
- Result of the DescribeTags operation returned by the service.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTags
default DescribeTagsResponse describeTags() throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for
DescribeTags:-
You cannot specify an ARN and a resource-type value together in the same request.
-
You cannot use the
MaxRecordsandMarkerparameters together with the ARN parameter. -
The
MaxRecordsparameter 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
ownerandenvironmentfor tag keys, andadminandtestfor 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.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeTags(DescribeTagsRequest), AWS API Documentation
-
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeTagsPaginator(DescribeTagsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeTagsRequest.builder()- Parameters:
describeTagsRequest- AConsumerthat will call methods onDescribeTagsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidTagException- The tag is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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.Builderavoiding the need to create one manually viaDescribeUsageLimitsRequest.builder()- Parameters:
describeUsageLimitsRequest- AConsumerthat will call methods onDescribeUsageLimitsRequest.Builderto create a request.- Returns:
- Result of the DescribeUsageLimits operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeUsageLimitsRequest.builder()- Parameters:
describeUsageLimitsRequest- AConsumerthat will call methods onDescribeUsageLimitsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDisableLoggingRequest.builder()- Parameters:
disableLoggingRequest- AConsumerthat will call methods onDisableLoggingRequest.Builderto create a request.- Returns:
- Result of the DisableLogging operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SnapshotCopyAlreadyDisabledException- The cluster already has cross-region snapshot copy disabled.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDisableSnapshotCopyRequest.builder()- Parameters:
disableSnapshotCopyRequest- AConsumerthat will call methods onDisableSnapshotCopyRequest.Builderto create a request.- Returns:
- Result of the DisableSnapshotCopy operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SnapshotCopyAlreadyDisabledException- The cluster already has cross-region snapshot copy disabled.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateDataShareConsumer
default DisassociateDataShareConsumerResponse disassociateDataShareConsumer(DisassociateDataShareConsumerRequest disassociateDataShareConsumerRequest) throws InvalidDataShareException, InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, remove association for the specified datashare.
- Parameters:
disassociateDataShareConsumerRequest-- Returns:
- Result of the DisassociateDataShareConsumer operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateDataShareConsumer
default DisassociateDataShareConsumerResponse disassociateDataShareConsumer(Consumer<DisassociateDataShareConsumerRequest.Builder> disassociateDataShareConsumerRequest) throws InvalidDataShareException, InvalidNamespaceException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, remove association for the specified datashare.
This is a convenience which creates an instance of the
DisassociateDataShareConsumerRequest.Builderavoiding the need to create one manually viaDisassociateDataShareConsumerRequest.builder()- Parameters:
disassociateDataShareConsumerRequest- AConsumerthat will call methods onDisassociateDataShareConsumerRequest.Builderto create a request.- Returns:
- Result of the DisassociateDataShareConsumer operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.InvalidNamespaceException- The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.BucketNotFoundException- Could not find the specified S3 bucket.InsufficientS3BucketPolicyException- The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.InvalidS3KeyPrefixException- The string specified for the logging S3 key prefix does not comply with the documented constraints.InvalidS3BucketNameException- The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaEnableLoggingRequest.builder()- Parameters:
enableLoggingRequest- AConsumerthat will call methods onEnableLoggingRequest.Builderto create a request.- Returns:
- Result of the EnableLogging operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.BucketNotFoundException- Could not find the specified S3 bucket.InsufficientS3BucketPolicyException- The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.InvalidS3KeyPrefixException- The string specified for the logging S3 key prefix does not comply with the documented constraints.InvalidS3BucketNameException- The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
IncompatibleOrderableOptionsException- The specified options are incompatible.InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.CopyToRegionDisabledException- Cross-region snapshot copy was temporarily disabled. Try your request again.SnapshotCopyAlreadyEnabledException- The cluster already has cross-region snapshot copy enabled.UnknownSnapshotCopyRegionException- The specified region is incorrect or does not exist.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaEnableSnapshotCopyRequest.builder()- Parameters:
enableSnapshotCopyRequest- AConsumerthat will call methods onEnableSnapshotCopyRequest.Builderto create a request.- Returns:
- Result of the EnableSnapshotCopy operation returned by the service.
- Throws:
IncompatibleOrderableOptionsException- The specified options are incompatible.InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.CopyToRegionDisabledException- Cross-region snapshot copy was temporarily disabled. Try your request again.SnapshotCopyAlreadyEnabledException- The cluster already has cross-region snapshot copy enabled.UnknownSnapshotCopyRegionException- The specified region is incorrect or does not exist.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SnapshotCopyGrantNotFoundException- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaFailoverPrimaryComputeRequest.builder()- Parameters:
failoverPrimaryComputeRequest- AConsumerthat will call methods onFailoverPrimaryComputeRequest.Builderto create a request.- Returns:
- Result of the FailoverPrimaryCompute operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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:ifAutoCreateisFalseorIAMA:ifAutoCreateisTrue. 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
DbGroupsparameter is specified, the IAM policy must allow theredshift:JoinGroupaction with access to the listeddbgroups.In addition, if the
AutoCreateparameter is set toTrue, then the policy must include theredshift:CreateClusterUserpermission.If the
DbNameparameter is specified, the IAM policy must allow access to the resourcedbnamefor the specified database name.- Parameters:
getClusterCredentialsRequest- The request parameters to get cluster credentials.- Returns:
- Result of the GetClusterCredentials operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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:ifAutoCreateisFalseorIAMA:ifAutoCreateisTrue. 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
DbGroupsparameter is specified, the IAM policy must allow theredshift:JoinGroupaction with access to the listeddbgroups.In addition, if the
AutoCreateparameter is set toTrue, then the policy must include theredshift:CreateClusterUserpermission.If the
DbNameparameter is specified, the IAM policy must allow access to the resourcedbnamefor the specified database name.
This is a convenience which creates an instance of the
GetClusterCredentialsRequest.Builderavoiding the need to create one manually viaGetClusterCredentialsRequest.builder()- Parameters:
getClusterCredentialsRequest- AConsumerthat will call methods onGetClusterCredentialsRequest.Builderto create a request. The request parameters to get cluster credentials.- Returns:
- Result of the GetClusterCredentials operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetClusterCredentialsWithIamRequest.builder()- Parameters:
getClusterCredentialsWithIamRequest- AConsumerthat will call methods onGetClusterCredentialsWithIamRequest.Builderto create a request.- Returns:
- Result of the GetClusterCredentialsWithIAM operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetReservedNodeExchangeConfigurationOptionsRequest.builder()- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest- AConsumerthat will call methods onGetReservedNodeExchangeConfigurationOptionsRequest.Builderto create a request.- Returns:
- Result of the GetReservedNodeExchangeConfigurationOptions operation returned by the service.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetReservedNodeExchangeConfigurationOptionsRequest.builder()- Parameters:
getReservedNodeExchangeConfigurationOptionsRequest- AConsumerthat will call methods onGetReservedNodeExchangeConfigurationOptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetReservedNodeExchangeOfferingsRequest.builder()- Parameters:
getReservedNodeExchangeOfferingsRequest- AConsumerthat will call methods onGetReservedNodeExchangeOfferingsRequest.Builderto create a request.- Returns:
- Result of the GetReservedNodeExchangeOfferings operation returned by the service.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetReservedNodeExchangeOfferingsRequest.builder()- Parameters:
getReservedNodeExchangeOfferingsRequest- AConsumerthat will call methods onGetReservedNodeExchangeOfferingsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.UnsupportedOperationException- The requested operation isn't supported.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidPolicyException- The resource policy isn't valid.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetResourcePolicyRequest.builder()- Parameters:
getResourcePolicyRequest- AConsumerthat will call methods onGetResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the GetResourcePolicy operation returned by the service.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidPolicyException- The resource policy isn't valid.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListRecommendationsRequest.builder()- Parameters:
listRecommendationsRequest- AConsumerthat will call methods onListRecommendationsRequest.Builderto create a request.- Returns:
- Result of the ListRecommendations operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListRecommendationsRequest.builder()- Parameters:
listRecommendationsRequest- AConsumerthat will call methods onListRecommendationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyAquaConfigurationRequest.builder()- Parameters:
modifyAquaConfigurationRequest- AConsumerthat will call methods onModifyAquaConfigurationRequest.Builderto create a request.- Returns:
- Result of the ModifyAquaConfiguration operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
AuthenticationProfileNotFoundException- The authentication profile can't be found.AuthenticationProfileQuotaExceededException- The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.InvalidAuthenticationProfileRequestException- The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyAuthenticationProfileRequest.builder()- Parameters:
modifyAuthenticationProfileRequest- AConsumerthat will call methods onModifyAuthenticationProfileRequest.Builderto create a request.- Returns:
- Result of the ModifyAuthenticationProfile operation returned by the service.
- Throws:
AuthenticationProfileNotFoundException- The authentication profile can't be found.AuthenticationProfileQuotaExceededException- The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.InvalidAuthenticationProfileRequestException- The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterStateException- The specified cluster is not in theavailablestate.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.NumberOfNodesQuotaExceededException- The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException- The operation would exceed the number of nodes allowed for a cluster.ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.UnsupportedOptionException- A request option was specified that is not supported.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.ClusterAlreadyExistsException- The account already has a cluster with the given identifier.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidElasticIpException- The Elastic IP (EIP) is invalid or cannot be found.TableLimitExceededException- The number of tables in the cluster exceeds the limit for the requested new cluster node type.InvalidClusterTrackException- The provided cluster track name is not valid.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
UnsupportedOperationException- The requested operation isn't supported.CustomCnameAssociationException- An error occurred when an attempt was made to change the custom domain association.Ipv6CidrBlockNotFoundException- There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyClusterRequest.builder()- Parameters:
modifyClusterRequest- AConsumerthat will call methods onModifyClusterRequest.Builderto create a request.- Returns:
- Result of the ModifyCluster operation returned by the service.
- Throws:
InvalidClusterStateException- The specified cluster is not in theavailablestate.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.NumberOfNodesQuotaExceededException- The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException- The operation would exceed the number of nodes allowed for a cluster.ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.UnsupportedOptionException- A request option was specified that is not supported.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.ClusterAlreadyExistsException- The account already has a cluster with the given identifier.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidElasticIpException- The Elastic IP (EIP) is invalid or cannot be found.TableLimitExceededException- The number of tables in the cluster exceeds the limit for the requested new cluster node type.InvalidClusterTrackException- The provided cluster track name is not valid.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
UnsupportedOperationException- The requested operation isn't supported.CustomCnameAssociationException- An error occurred when an attempt was made to change the custom domain association.Ipv6CidrBlockNotFoundException- There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterOnLatestRevisionException- Cluster is already on the latest database revision.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyClusterDbRevisionRequest.builder()- Parameters:
modifyClusterDbRevisionRequest- AConsumerthat will call methods onModifyClusterDbRevisionRequest.Builderto create a request.- Returns:
- Result of the ModifyClusterDbRevision operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ClusterOnLatestRevisionException- Cluster is already on the latest database revision.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyClusterIamRolesRequest.builder()- Parameters:
modifyClusterIamRolesRequest- AConsumerthat will call methods onModifyClusterIamRolesRequest.Builderto create a request.- Returns:
- Result of the ModifyClusterIamRoles operation returned by the service.
- Throws:
InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyClusterMaintenanceRequest.builder()- Parameters:
modifyClusterMaintenanceRequest- AConsumerthat will call methods onModifyClusterMaintenanceRequest.Builderto create a request.- Returns:
- Result of the ModifyClusterMaintenance operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InvalidClusterParameterGroupStateException- The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyClusterParameterGroupRequest.builder()- Parameters:
modifyClusterParameterGroupRequest- AConsumerthat will call methods onModifyClusterParameterGroupRequest.Builderto create a request. Describes a modify cluster parameter group operation.- Returns:
- Result of the ModifyClusterParameterGroup operation returned by the service.
- Throws:
ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.InvalidClusterParameterGroupStateException- The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyClusterSnapshotRequest.builder()- Parameters:
modifyClusterSnapshotRequest- AConsumerthat will call methods onModifyClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the ModifyClusterSnapshot operation returned by the service.
- Throws:
InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.InvalidClusterSnapshotScheduleStateException- The cluster snapshot schedule state is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyClusterSnapshotScheduleRequest.builder()- Parameters:
modifyClusterSnapshotScheduleRequest- AConsumerthat will call methods onModifyClusterSnapshotScheduleRequest.Builderto create a request.- Returns:
- Result of the ModifyClusterSnapshotSchedule operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.InvalidClusterSnapshotScheduleStateException- The cluster snapshot schedule state is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.ClusterSubnetQuotaExceededException- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.SubnetAlreadyInUseException- A specified subnet is already in use by another cluster.InvalidSubnetException- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyClusterSubnetGroupRequest.builder()- Parameters:
modifyClusterSubnetGroupRequest- AConsumerthat will call methods onModifyClusterSubnetGroupRequest.Builderto create a request.- Returns:
- Result of the ModifyClusterSubnetGroup operation returned by the service.
- Throws:
ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.ClusterSubnetQuotaExceededException- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.SubnetAlreadyInUseException- A specified subnet is already in use by another cluster.InvalidSubnetException- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
UnsupportedOperationException- The requested operation isn't supported.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.CustomCnameAssociationException- An error occurred when an attempt was made to change the custom domain association.CustomDomainAssociationNotFoundException- An error occurred. The custom domain name couldn't be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyCustomDomainAssociationRequest.builder()- Parameters:
modifyCustomDomainAssociationRequest- AConsumerthat will call methods onModifyCustomDomainAssociationRequest.Builderto create a request.- Returns:
- Result of the ModifyCustomDomainAssociation operation returned by the service.
- Throws:
UnsupportedOperationException- The requested operation isn't supported.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.CustomCnameAssociationException- An error occurred when an attempt was made to change the custom domain association.CustomDomainAssociationNotFoundException- An error occurred. The custom domain name couldn't be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidEndpointStateException- The status of the endpoint is not valid.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyEndpointAccessRequest.builder()- Parameters:
modifyEndpointAccessRequest- AConsumerthat will call methods onModifyEndpointAccessRequest.Builderto create a request.- Returns:
- Result of the ModifyEndpointAccess operation returned by the service.
- Throws:
InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidEndpointStateException- The status of the endpoint is not valid.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.SnsInvalidTopicException- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SnsNoAuthorizationException- You do not have permission to publish to the specified Amazon SNS topic.SnsTopicArnNotFoundException- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException- The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.SubscriptionSeverityNotFoundException- The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException- The specified Amazon Redshift event source could not be found.InvalidSubscriptionStateException- The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyEventSubscriptionRequest.builder()- Parameters:
modifyEventSubscriptionRequest- AConsumerthat will call methods onModifyEventSubscriptionRequest.Builderto create a request.- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- An Amazon Redshift event notification subscription with the specified name does not exist.SnsInvalidTopicException- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SnsNoAuthorizationException- You do not have permission to publish to the specified Amazon SNS topic.SnsTopicArnNotFoundException- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException- The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.SubscriptionSeverityNotFoundException- The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException- The specified Amazon Redshift event source could not be found.InvalidSubscriptionStateException- The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyRedshiftIdcApplicationRequest.builder()- Parameters:
modifyRedshiftIdcApplicationRequest- AConsumerthat will call methods onModifyRedshiftIdcApplicationRequest.Builderto create a request.- Returns:
- Result of the ModifyRedshiftIdcApplication operation returned by the service.
- Throws:
RedshiftIdcApplicationNotExistsException- The application you attempted to find doesn't exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.UnsupportedOperationException- The requested operation isn't supported.DependentServiceAccessDeniedException- A dependent service denied access for the integration.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ScheduledActionNotFoundException- The scheduled action cannot be found.ScheduledActionTypeUnsupportedException- The action type specified for a scheduled action is not supported.InvalidScheduleException- The schedule you submitted isn't valid.InvalidScheduledActionException- The scheduled action is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyScheduledActionRequest.builder()- Parameters:
modifyScheduledActionRequest- AConsumerthat will call methods onModifyScheduledActionRequest.Builderto create a request.- Returns:
- Result of the ModifyScheduledAction operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.ScheduledActionNotFoundException- The scheduled action cannot be found.ScheduledActionTypeUnsupportedException- The action type specified for a scheduled action is not supported.InvalidScheduleException- The schedule you submitted isn't valid.InvalidScheduledActionException- The scheduled action is not valid.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SnapshotCopyDisabledException- Cross-region snapshot copy was temporarily disabled. Try your request again.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.InvalidClusterStateException- The specified cluster is not in theavailablestate.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifySnapshotCopyRetentionPeriodRequest.builder()- Parameters:
modifySnapshotCopyRetentionPeriodRequest- AConsumerthat will call methods onModifySnapshotCopyRetentionPeriodRequest.Builderto create a request.- Returns:
- Result of the ModifySnapshotCopyRetentionPeriod operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SnapshotCopyDisabledException- Cross-region snapshot copy was temporarily disabled. Try your request again.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.InvalidClusterStateException- The specified cluster is not in theavailablestate.InvalidRetentionPeriodException- The retention period specified is either in the past or is not a valid value.The value must be either -1 or an integer between 1 and 3,653.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidScheduleException- The schedule you submitted isn't valid.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.SnapshotScheduleUpdateInProgressException- The specified snapshot schedule is already being updated.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifySnapshotScheduleRequest.builder()- Parameters:
modifySnapshotScheduleRequest- AConsumerthat will call methods onModifySnapshotScheduleRequest.Builderto create a request.- Returns:
- Result of the ModifySnapshotSchedule operation returned by the service.
- Throws:
InvalidScheduleException- The schedule you submitted isn't valid.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.SnapshotScheduleUpdateInProgressException- The specified snapshot schedule is already being updated.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidUsageLimitException- The usage limit is not valid.UsageLimitNotFoundException- The usage limit identifier can't be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyUsageLimitRequest.builder()- Parameters:
modifyUsageLimitRequest- AConsumerthat will call methods onModifyUsageLimitRequest.Builderto create a request.- Returns:
- Result of the ModifyUsageLimit operation returned by the service.
- Throws:
InvalidUsageLimitException- The usage limit is not valid.UsageLimitNotFoundException- The usage limit identifier can't be found.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 thePauseClusterAPI operation.- Returns:
- Result of the PauseCluster operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaPauseClusterRequest.builder()- Parameters:
pauseClusterRequest- AConsumerthat will call methods onPauseClusterRequest.Builderto create a request. Describes a pause cluster operation. For example, a scheduled action to run thePauseClusterAPI operation.- Returns:
- Result of the PauseCluster operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ReservedNodeOfferingNotFoundException- Specified offering does not exist.ReservedNodeAlreadyExistsException- User already has a reservation with the given identifier.ReservedNodeQuotaExceededException- Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaPurchaseReservedNodeOfferingRequest.builder()- Parameters:
purchaseReservedNodeOfferingRequest- AConsumerthat will call methods onPurchaseReservedNodeOfferingRequest.Builderto create a request.- Returns:
- Result of the PurchaseReservedNodeOffering operation returned by the service.
- Throws:
ReservedNodeOfferingNotFoundException- Specified offering does not exist.ReservedNodeAlreadyExistsException- User already has a reservation with the given identifier.ReservedNodeQuotaExceededException- Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidPolicyException- The resource policy isn't valid.ConflictPolicyUpdateException- There is a conflict while updating the resource policy.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaPutResourcePolicyRequest.builder()- Parameters:
putResourcePolicyRequest- AConsumerthat will call methods onPutResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- Throws:
ResourceNotFoundException- The resource could not be found.InvalidPolicyException- The resource policy isn't valid.ConflictPolicyUpdateException- There is a conflict while updating the resource policy.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRebootClusterRequest.builder()- Parameters:
rebootClusterRequest- AConsumerthat will call methods onRebootClusterRequest.Builderto create a request.- Returns:
- Result of the RebootCluster operation returned by the service.
- Throws:
InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
rejectDataShare
default RejectDataShareResponse rejectDataShare(RejectDataShareRequest rejectDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, rejects the specified datashare.
- Parameters:
rejectDataShareRequest-- Returns:
- Result of the RejectDataShare operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
rejectDataShare
default RejectDataShareResponse rejectDataShare(Consumer<RejectDataShareRequest.Builder> rejectDataShareRequest) throws InvalidDataShareException, AwsServiceException, SdkClientException, RedshiftException
From a datashare consumer account, rejects the specified datashare.
This is a convenience which creates an instance of the
RejectDataShareRequest.Builderavoiding the need to create one manually viaRejectDataShareRequest.builder()- Parameters:
rejectDataShareRequest- AConsumerthat will call methods onRejectDataShareRequest.Builderto create a request.- Returns:
- Result of the RejectDataShare operation returned by the service.
- Throws:
InvalidDataShareException- There is an error with the datashare.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidClusterParameterGroupStateException- The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaResetClusterParameterGroupRequest.builder()- Parameters:
resetClusterParameterGroupRequest- AConsumerthat will call methods onResetClusterParameterGroupRequest.Builderto create a request.- Returns:
- Result of the ResetClusterParameterGroup operation returned by the service.
- Throws:
InvalidClusterParameterGroupStateException- The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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:
-
dc2.large
-
dc2.8xlarge
-
ra3.xlplus
-
ra3.4xlarge
-
ra3.16xlarge
-
-
The type of nodes that you add must match the node type for the cluster.
- Parameters:
resizeClusterRequest- Describes a resize cluster operation. For example, a scheduled action to run theResizeClusterAPI operation.- Returns:
- Result of the ResizeCluster operation returned by the service.
- Throws:
InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.NumberOfNodesQuotaExceededException- The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException- The operation would exceed the number of nodes allowed for a cluster.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.UnsupportedOptionException- A request option was specified that is not supported.UnsupportedOperationException- The requested operation isn't supported.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ReservedNodeAlreadyExistsException- User already has a reservation with the given identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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:
-
dc2.large
-
dc2.8xlarge
-
ra3.xlplus
-
ra3.4xlarge
-
ra3.16xlarge
-
-
The type of nodes that you add must match the node type for the cluster.
This is a convenience which creates an instance of the
ResizeClusterRequest.Builderavoiding the need to create one manually viaResizeClusterRequest.builder()- Parameters:
resizeClusterRequest- AConsumerthat will call methods onResizeClusterRequest.Builderto create a request. Describes a resize cluster operation. For example, a scheduled action to run theResizeClusterAPI operation.- Returns:
- Result of the ResizeCluster operation returned by the service.
- Throws:
InvalidClusterStateException- The specified cluster is not in theavailablestate.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.NumberOfNodesQuotaExceededException- The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException- The operation would exceed the number of nodes allowed for a cluster.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.UnsupportedOptionException- A request option was specified that is not supported.UnsupportedOperationException- The requested operation isn't supported.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ReservedNodeAlreadyExistsException- User already has a reservation with the given identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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.
- Throws:
AccessToSnapshotDeniedException- The owner of the specified snapshot has not authorized your account to access the snapshot.ClusterAlreadyExistsException- The account already has a cluster with the given identifier.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.ClusterQuotaExceededException- The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.InvalidRestoreException- The restore is invalid.NumberOfNodesQuotaExceededException- The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException- The operation would exceed the number of nodes allowed for a cluster.InvalidVpcNetworkStateException- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException- The requested subnet is not valid, or not all of the subnets are in the same VPC.ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException- The Elastic IP (EIP) is invalid or cannot be found.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidClusterTrackException- The provided cluster track name is not valid.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ReservedNodeAlreadyExistsException- User already has a reservation with the given identifier.UnsupportedOperationException- The requested operation isn't supported.Ipv6CidrBlockNotFoundException- There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRestoreFromClusterSnapshotRequest.builder()- Parameters:
restoreFromClusterSnapshotRequest- AConsumerthat will call methods onRestoreFromClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the RestoreFromClusterSnapshot operation returned by the service.
- Throws:
AccessToSnapshotDeniedException- The owner of the specified snapshot has not authorized your account to access the snapshot.ClusterAlreadyExistsException- The account already has a cluster with the given identifier.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.ClusterQuotaExceededException- The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.InvalidRestoreException- The restore is invalid.NumberOfNodesQuotaExceededException- The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException- The operation would exceed the number of nodes allowed for a cluster.InvalidVpcNetworkStateException- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException- The requested subnet is not valid, or not all of the subnets are in the same VPC.ClusterSubnetGroupNotFoundException- The cluster subnet group name does not refer to an existing cluster subnet group.UnauthorizedOperationException- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException- The Elastic IP (EIP) is invalid or cannot be found.ClusterParameterGroupNotFoundException- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.LimitExceededException- The encryption key has exceeded its grant limit in Amazon Web Services KMS.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.InvalidClusterTrackException- The provided cluster track name is not valid.SnapshotScheduleNotFoundException- We could not find the specified snapshot schedule.TagLimitExceededException- You have exceeded the number of tags allowed.InvalidTagException- The tag is invalid.ReservedNodeNotFoundException- The specified reserved compute node not found.InvalidReservedNodeStateException- Indicates that the Reserved Node being exchanged is not in an active state.ReservedNodeAlreadyMigratedException- Indicates that the reserved node has already been exchanged.ReservedNodeOfferingNotFoundException- Specified offering does not exist.DependentServiceUnavailableException- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.ReservedNodeAlreadyExistsException- User already has a reservation with the given identifier.UnsupportedOperationException- The requested operation isn't supported.Ipv6CidrBlockNotFoundException- There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
RestoreTableFromClusterSnapshotto 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 theNewTableNameparameter 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.
- Throws:
ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InProgressTableRestoreQuotaExceededException- You have exceeded the allowed number of table restore requests. Wait for your current table restore requests to complete before making a new request.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.InvalidTableRestoreArgumentException- The value specified for thesourceDatabaseName,sourceSchemaName, orsourceTableNameparameter, or a combination of these, doesn't exist in the snapshot.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
RestoreTableFromClusterSnapshotto 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 theNewTableNameparameter 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.Builderavoiding the need to create one manually viaRestoreTableFromClusterSnapshotRequest.builder()- Parameters:
restoreTableFromClusterSnapshotRequest- AConsumerthat will call methods onRestoreTableFromClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the RestoreTableFromClusterSnapshot operation returned by the service.
- Throws:
ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.InProgressTableRestoreQuotaExceededException- You have exceeded the allowed number of table restore requests. Wait for your current table restore requests to complete before making a new request.InvalidClusterSnapshotStateException- The specified cluster snapshot is not in theavailablestate, or other accounts are authorized to access the snapshot.InvalidTableRestoreArgumentException- The value specified for thesourceDatabaseName,sourceSchemaName, orsourceTableNameparameter, or a combination of these, doesn't exist in the snapshot.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 theResumeClusterAPI operation.- Returns:
- Result of the ResumeCluster operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaResumeClusterRequest.builder()- Parameters:
resumeClusterRequest- AConsumerthat will call methods onResumeClusterRequest.Builderto create a request. Describes a resume cluster operation. For example, a scheduled action to run theResumeClusterAPI operation.- Returns:
- Result of the ResumeCluster operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.InsufficientClusterCapacityException- The number of nodes specified exceeds the allotted capacity of the cluster.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.AuthorizationNotFoundException- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRevokeClusterSecurityGroupIngressRequest.builder()- Parameters:
revokeClusterSecurityGroupIngressRequest- AConsumerthat will call methods onRevokeClusterSecurityGroupIngressRequest.Builderto create a request.- Returns:
- Result of the RevokeClusterSecurityGroupIngress operation returned by the service.
- Throws:
ClusterSecurityGroupNotFoundException- The cluster security group name does not refer to an existing cluster security group.AuthorizationNotFoundException- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidEndpointStateException- The status of the endpoint is not valid.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.EndpointAuthorizationNotFoundException- The authorization for this endpoint can't be found.InvalidAuthorizationStateException- The status of the authorization is not valid.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRevokeEndpointAccessRequest.builder()- Parameters:
revokeEndpointAccessRequest- AConsumerthat will call methods onRevokeEndpointAccessRequest.Builderto create a request.- Returns:
- Result of the RevokeEndpointAccess operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidEndpointStateException- The status of the endpoint is not valid.InvalidClusterSecurityGroupStateException- The state of the cluster security group is notavailable.EndpointNotFoundException- The endpoint name doesn't refer to an existing endpoint.EndpointAuthorizationNotFoundException- The authorization for this endpoint can't be found.InvalidAuthorizationStateException- The status of the authorization is not valid.InvalidClusterStateException- The specified cluster is not in theavailablestate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
AccessToSnapshotDeniedException- The owner of the specified snapshot has not authorized your account to access the snapshot.AuthorizationNotFoundException- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRevokeSnapshotAccessRequest.builder()- Parameters:
revokeSnapshotAccessRequest- AConsumerthat will call methods onRevokeSnapshotAccessRequest.Builderto create a request.- Returns:
- Result of the RevokeSnapshotAccess operation returned by the service.
- Throws:
AccessToSnapshotDeniedException- The owner of the specified snapshot has not authorized your account to access the snapshot.AuthorizationNotFoundException- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.ClusterSnapshotNotFoundException- The snapshot identifier does not refer to an existing cluster snapshot.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRotateEncryptionKeyRequest.builder()- Parameters:
rotateEncryptionKeyRequest- AConsumerthat will call methods onRotateEncryptionKeyRequest.Builderto create a request.- Returns:
- Result of the RotateEncryptionKey operation returned by the service.
- Throws:
ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.InvalidClusterStateException- The specified cluster is not in theavailablestate.DependentServiceRequestThrottlingException- The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
PartnerNotFoundException- The name of the partner was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException- The partner integration is not authorized.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdatePartnerStatusRequest.builder()- Parameters:
updatePartnerStatusRequest- AConsumerthat will call methods onUpdatePartnerStatusRequest.Builderto create a request.- Returns:
- Result of the UpdatePartnerStatus operation returned by the service.
- Throws:
PartnerNotFoundException- The name of the partner was not found.ClusterNotFoundException- TheClusterIdentifierparameter does not refer to an existing cluster.UnauthorizedPartnerIntegrationException- The partner integration is not authorized.UnsupportedOperationException- The requested operation isn't supported.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default RedshiftWaiter waiter()
Create an instance ofRedshiftWaiterusing 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
static RedshiftClient create()
Create aRedshiftClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static RedshiftClientBuilder builder()
Create a builder that can be used to configure and create aRedshiftClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default RedshiftServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-