@Generated(value="software.amazon.awssdk:codegen") public interface RedshiftClient extends SdkClient
builder()
method.
Overview
This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.
Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.
If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AuthorizeClusterSecurityGroupIngressResponse |
authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group.
|
default AuthorizeClusterSecurityGroupIngressResponse |
authorizeClusterSecurityGroupIngress(Consumer<AuthorizeClusterSecurityGroupIngressRequest.Builder> authorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group.
|
default AuthorizeSnapshotAccessResponse |
authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest)
Authorizes the specified AWS customer account to restore the specified snapshot.
|
default AuthorizeSnapshotAccessResponse |
authorizeSnapshotAccess(Consumer<AuthorizeSnapshotAccessRequest.Builder> authorizeSnapshotAccessRequest)
Authorizes the specified AWS customer account to restore the specified snapshot.
|
static RedshiftClientBuilder |
builder()
Create a builder that can be used to configure and create a
RedshiftClient . |
default CopyClusterSnapshotResponse |
copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
|
default CopyClusterSnapshotResponse |
copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
|
static RedshiftClient |
create()
Create a
RedshiftClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateClusterResponse |
createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates a new cluster.
|
default CreateClusterResponse |
createCluster(CreateClusterRequest createClusterRequest)
Creates a new cluster.
|
default CreateClusterParameterGroupResponse |
createClusterParameterGroup(Consumer<CreateClusterParameterGroupRequest.Builder> createClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.
|
default CreateClusterParameterGroupResponse |
createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.
|
default CreateClusterSecurityGroupResponse |
createClusterSecurityGroup(Consumer<CreateClusterSecurityGroupRequest.Builder> createClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group.
|
default CreateClusterSecurityGroupResponse |
createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group.
|
default CreateClusterSnapshotResponse |
createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster.
|
default CreateClusterSnapshotResponse |
createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster.
|
default CreateClusterSubnetGroupResponse |
createClusterSubnetGroup(Consumer<CreateClusterSubnetGroupRequest.Builder> createClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group.
|
default CreateClusterSubnetGroupResponse |
createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group.
|
default CreateEventSubscriptionResponse |
createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription.
|
default CreateEventSubscriptionResponse |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription.
|
default CreateHsmClientCertificateResponse |
createHsmClientCertificate(Consumer<CreateHsmClientCertificateRequest.Builder> createHsmClientCertificateRequest)
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in
order to store and retrieve the keys used to encrypt the cluster databases.
|
default CreateHsmClientCertificateResponse |
createHsmClientCertificate(CreateHsmClientCertificateRequest createHsmClientCertificateRequest)
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in
order to store and retrieve the keys used to encrypt the cluster databases.
|
default CreateHsmConfigurationResponse |
createHsmConfiguration(Consumer<CreateHsmConfigurationRequest.Builder> createHsmConfigurationRequest)
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and
use database encryption keys in a Hardware Security Module (HSM).
|
default CreateHsmConfigurationResponse |
createHsmConfiguration(CreateHsmConfigurationRequest createHsmConfigurationRequest)
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and
use database encryption keys in a Hardware Security Module (HSM).
|
default CreateSnapshotCopyGrantResponse |
createSnapshotCopyGrant(Consumer<CreateSnapshotCopyGrantRequest.Builder> createSnapshotCopyGrantRequest)
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key
Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
|
default CreateSnapshotCopyGrantResponse |
createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest createSnapshotCopyGrantRequest)
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key
Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
|
default CreateTagsResponse |
createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Adds one or more tags to a specified resource.
|
default CreateTagsResponse |
createTags(CreateTagsRequest createTagsRequest)
Adds one or more tags to a specified resource.
|
default DeleteClusterResponse |
deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Deletes a previously provisioned cluster.
|
default DeleteClusterResponse |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes a previously provisioned cluster.
|
default DeleteClusterParameterGroupResponse |
deleteClusterParameterGroup(Consumer<DeleteClusterParameterGroupRequest.Builder> deleteClusterParameterGroupRequest)
Deletes a specified Amazon Redshift parameter group.
|
default DeleteClusterParameterGroupResponse |
deleteClusterParameterGroup(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest)
Deletes a specified Amazon Redshift parameter group.
|
default DeleteClusterSecurityGroupResponse |
deleteClusterSecurityGroup(Consumer<DeleteClusterSecurityGroupRequest.Builder> deleteClusterSecurityGroupRequest)
Deletes an Amazon Redshift security group.
|
default DeleteClusterSecurityGroupResponse |
deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest)
Deletes an Amazon Redshift security group.
|
default DeleteClusterSnapshotResponse |
deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest)
Deletes the specified manual snapshot.
|
default DeleteClusterSnapshotResponse |
deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)
Deletes the specified manual snapshot.
|
default DeleteClusterSubnetGroupResponse |
deleteClusterSubnetGroup(Consumer<DeleteClusterSubnetGroupRequest.Builder> deleteClusterSubnetGroupRequest)
Deletes the specified cluster subnet group.
|
default DeleteClusterSubnetGroupResponse |
deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest)
Deletes the specified cluster subnet group.
|
default DeleteEventSubscriptionResponse |
deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest)
Deletes an Amazon Redshift event notification subscription.
|
default DeleteEventSubscriptionResponse |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an Amazon Redshift event notification subscription.
|
default DeleteHsmClientCertificateResponse |
deleteHsmClientCertificate(Consumer<DeleteHsmClientCertificateRequest.Builder> deleteHsmClientCertificateRequest)
Deletes the specified HSM client certificate.
|
default DeleteHsmClientCertificateResponse |
deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest)
Deletes the specified HSM client certificate.
|
default DeleteHsmConfigurationResponse |
deleteHsmConfiguration(Consumer<DeleteHsmConfigurationRequest.Builder> deleteHsmConfigurationRequest)
Deletes the specified Amazon Redshift HSM configuration.
|
default DeleteHsmConfigurationResponse |
deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest)
Deletes the specified Amazon Redshift HSM configuration.
|
default DeleteSnapshotCopyGrantResponse |
deleteSnapshotCopyGrant(Consumer<DeleteSnapshotCopyGrantRequest.Builder> deleteSnapshotCopyGrantRequest)
Deletes the specified snapshot copy grant.
|
default DeleteSnapshotCopyGrantResponse |
deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest)
Deletes the specified snapshot copy grant.
|
default DeleteTagsResponse |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes a tag or tags from a resource.
|
default DeleteTagsResponse |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes a tag or tags from a resource.
|
default DescribeClusterParameterGroupsResponse |
describeClusterParameterGroups()
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsResponse |
describeClusterParameterGroups(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsResponse |
describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsIterable |
describeClusterParameterGroupsPaginator()
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsIterable |
describeClusterParameterGroupsPaginator(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsIterable |
describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParametersResponse |
describeClusterParameters(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default DescribeClusterParametersResponse |
describeClusterParameters(DescribeClusterParametersRequest describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default DescribeClusterParametersIterable |
describeClusterParametersPaginator(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default DescribeClusterParametersIterable |
describeClusterParametersPaginator(DescribeClusterParametersRequest describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default DescribeClustersResponse |
describeClusters()
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default DescribeClustersResponse |
describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default DescribeClustersResponse |
describeClusters(DescribeClustersRequest describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default DescribeClusterSecurityGroupsResponse |
describeClusterSecurityGroups(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default DescribeClusterSecurityGroupsResponse |
describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default DescribeClusterSecurityGroupsIterable |
describeClusterSecurityGroupsPaginator(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default DescribeClusterSecurityGroupsIterable |
describeClusterSecurityGroupsPaginator(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default DescribeClusterSnapshotsResponse |
describeClusterSnapshots()
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsResponse |
describeClusterSnapshots(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsResponse |
describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsIterable |
describeClusterSnapshotsPaginator()
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsIterable |
describeClusterSnapshotsPaginator(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsIterable |
describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClustersIterable |
describeClustersPaginator()
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default DescribeClustersIterable |
describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default DescribeClustersIterable |
describeClustersPaginator(DescribeClustersRequest describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default DescribeClusterSubnetGroupsResponse |
describeClusterSubnetGroups()
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsResponse |
describeClusterSubnetGroups(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsResponse |
describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsIterable |
describeClusterSubnetGroupsPaginator()
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsIterable |
describeClusterSubnetGroupsPaginator(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsIterable |
describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterVersionsResponse |
describeClusterVersions()
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsResponse |
describeClusterVersions(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsResponse |
describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsIterable |
describeClusterVersionsPaginator()
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsIterable |
describeClusterVersionsPaginator(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsIterable |
describeClusterVersionsPaginator(DescribeClusterVersionsRequest describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeDefaultClusterParametersResponse |
describeDefaultClusterParameters(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default DescribeDefaultClusterParametersResponse |
describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default DescribeDefaultClusterParametersIterable |
describeDefaultClusterParametersPaginator(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default DescribeDefaultClusterParametersIterable |
describeDefaultClusterParametersPaginator(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default DescribeEventCategoriesResponse |
describeEventCategories()
Displays a list of event categories for all event source types, or for a specified source type.
|
default DescribeEventCategoriesResponse |
describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest)
Displays a list of event categories for all event source types, or for a specified source type.
|
default DescribeEventCategoriesResponse |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of event categories for all event source types, or for a specified source type.
|
default DescribeEventsResponse |
describeEvents()
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsResponse |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsIterable |
describeEventsPaginator()
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsIterable |
describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsIterable |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions()
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator()
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeHsmClientCertificatesResponse |
describeHsmClientCertificates()
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesResponse |
describeHsmClientCertificates(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesResponse |
describeHsmClientCertificates(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesIterable |
describeHsmClientCertificatesPaginator()
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesIterable |
describeHsmClientCertificatesPaginator(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesIterable |
describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default DescribeHsmConfigurationsResponse |
describeHsmConfigurations()
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsResponse |
describeHsmConfigurations(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsResponse |
describeHsmConfigurations(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsIterable |
describeHsmConfigurationsPaginator()
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsIterable |
describeHsmConfigurationsPaginator(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsIterable |
describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeLoggingStatusResponse |
describeLoggingStatus(Consumer<DescribeLoggingStatusRequest.Builder> describeLoggingStatusRequest)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon
Redshift cluster.
|
default DescribeLoggingStatusResponse |
describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon
Redshift cluster.
|
default DescribeOrderableClusterOptionsResponse |
describeOrderableClusterOptions()
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsResponse |
describeOrderableClusterOptions(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsResponse |
describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsIterable |
describeOrderableClusterOptionsPaginator()
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsIterable |
describeOrderableClusterOptionsPaginator(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsIterable |
describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default DescribeReservedNodeOfferingsResponse |
describeReservedNodeOfferings()
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default DescribeReservedNodeOfferingsResponse |
describeReservedNodeOfferings(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default DescribeReservedNodeOfferingsResponse |
describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default DescribeReservedNodeOfferingsIterable |
describeReservedNodeOfferingsPaginator()
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default DescribeReservedNodeOfferingsIterable |
describeReservedNodeOfferingsPaginator(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default DescribeReservedNodeOfferingsIterable |
describeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default DescribeReservedNodesResponse |
describeReservedNodes()
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesResponse |
describeReservedNodes(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesResponse |
describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesIterable |
describeReservedNodesPaginator()
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesIterable |
describeReservedNodesPaginator(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesIterable |
describeReservedNodesPaginator(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default DescribeResizeResponse |
describeResize(Consumer<DescribeResizeRequest.Builder> describeResizeRequest)
Returns information about the last resize operation for the specified cluster.
|
default DescribeResizeResponse |
describeResize(DescribeResizeRequest describeResizeRequest)
Returns information about the last resize operation for the specified cluster.
|
default DescribeSnapshotCopyGrantsResponse |
describeSnapshotCopyGrants()
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
|
default DescribeSnapshotCopyGrantsResponse |
describeSnapshotCopyGrants(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
|
default DescribeSnapshotCopyGrantsResponse |
describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
|
default DescribeTableRestoreStatusResponse |
describeTableRestoreStatus(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
default DescribeTableRestoreStatusResponse |
describeTableRestoreStatus(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
default DescribeTagsResponse |
describeTags()
Returns a list of tags.
|
default DescribeTagsResponse |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Returns a list of tags.
|
default DescribeTagsResponse |
describeTags(DescribeTagsRequest describeTagsRequest)
Returns a list of tags.
|
default DisableLoggingResponse |
disableLogging(Consumer<DisableLoggingRequest.Builder> disableLoggingRequest)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default DisableLoggingResponse |
disableLogging(DisableLoggingRequest disableLoggingRequest)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default DisableSnapshotCopyResponse |
disableSnapshotCopy(Consumer<DisableSnapshotCopyRequest.Builder> disableSnapshotCopyRequest)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
|
default DisableSnapshotCopyResponse |
disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
|
default EnableLoggingResponse |
enableLogging(Consumer<EnableLoggingRequest.Builder> enableLoggingRequest)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default EnableLoggingResponse |
enableLogging(EnableLoggingRequest enableLoggingRequest)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default EnableSnapshotCopyResponse |
enableSnapshotCopy(Consumer<EnableSnapshotCopyRequest.Builder> enableSnapshotCopyRequest)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
|
default EnableSnapshotCopyResponse |
enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
|
default GetClusterCredentialsResponse |
getClusterCredentials(Consumer<GetClusterCredentialsRequest.Builder> getClusterCredentialsRequest)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database.
|
default GetClusterCredentialsResponse |
getClusterCredentials(GetClusterCredentialsRequest getClusterCredentialsRequest)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database.
|
default ModifyClusterResponse |
modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest)
Modifies the settings for a cluster.
|
default ModifyClusterResponse |
modifyCluster(ModifyClusterRequest modifyClusterRequest)
Modifies the settings for a cluster.
|
default ModifyClusterIamRolesResponse |
modifyClusterIamRoles(Consumer<ModifyClusterIamRolesRequest.Builder> modifyClusterIamRolesRequest)
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access
other AWS services.
|
default ModifyClusterIamRolesResponse |
modifyClusterIamRoles(ModifyClusterIamRolesRequest modifyClusterIamRolesRequest)
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access
other AWS services.
|
default ModifyClusterParameterGroupResponse |
modifyClusterParameterGroup(Consumer<ModifyClusterParameterGroupRequest.Builder> modifyClusterParameterGroupRequest)
Modifies the parameters of a parameter group.
|
default ModifyClusterParameterGroupResponse |
modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest)
Modifies the parameters of a parameter group.
|
default ModifyClusterSubnetGroupResponse |
modifyClusterSubnetGroup(Consumer<ModifyClusterSubnetGroupRequest.Builder> modifyClusterSubnetGroupRequest)
Modifies a cluster subnet group to include the specified list of VPC subnets.
|
default ModifyClusterSubnetGroupResponse |
modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest)
Modifies a cluster subnet group to include the specified list of VPC subnets.
|
default ModifyEventSubscriptionResponse |
modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest)
Modifies an existing Amazon Redshift event notification subscription.
|
default ModifyEventSubscriptionResponse |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing Amazon Redshift event notification subscription.
|
default ModifySnapshotCopyRetentionPeriodResponse |
modifySnapshotCopyRetentionPeriod(Consumer<ModifySnapshotCopyRetentionPeriodRequest.Builder> modifySnapshotCopyRetentionPeriodRequest)
Modifies the number of days to retain automated snapshots in the destination region after they are copied from
the source region.
|
default ModifySnapshotCopyRetentionPeriodResponse |
modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest)
Modifies the number of days to retain automated snapshots in the destination region after they are copied from
the source region.
|
default PurchaseReservedNodeOfferingResponse |
purchaseReservedNodeOffering(Consumer<PurchaseReservedNodeOfferingRequest.Builder> purchaseReservedNodeOfferingRequest)
Allows you to purchase reserved nodes.
|
default PurchaseReservedNodeOfferingResponse |
purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest)
Allows you to purchase reserved nodes.
|
default RebootClusterResponse |
rebootCluster(Consumer<RebootClusterRequest.Builder> rebootClusterRequest)
Reboots a cluster.
|
default RebootClusterResponse |
rebootCluster(RebootClusterRequest rebootClusterRequest)
Reboots a cluster.
|
default ResetClusterParameterGroupResponse |
resetClusterParameterGroup(Consumer<ResetClusterParameterGroupRequest.Builder> resetClusterParameterGroupRequest)
Sets one or more parameters of the specified parameter group to their default values and sets the source values
of the parameters to "engine-default".
|
default ResetClusterParameterGroupResponse |
resetClusterParameterGroup(ResetClusterParameterGroupRequest resetClusterParameterGroupRequest)
Sets one or more parameters of the specified parameter group to their default values and sets the source values
of the parameters to "engine-default".
|
default RestoreFromClusterSnapshotResponse |
restoreFromClusterSnapshot(Consumer<RestoreFromClusterSnapshotRequest.Builder> restoreFromClusterSnapshotRequest)
Creates a new cluster from a snapshot.
|
default RestoreFromClusterSnapshotResponse |
restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest)
Creates a new cluster from a snapshot.
|
default RestoreTableFromClusterSnapshotResponse |
restoreTableFromClusterSnapshot(Consumer<RestoreTableFromClusterSnapshotRequest.Builder> restoreTableFromClusterSnapshotRequest)
Creates a new table from a table in an Amazon Redshift cluster snapshot.
|
default RestoreTableFromClusterSnapshotResponse |
restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest)
Creates a new table from a table in an Amazon Redshift cluster snapshot.
|
default RevokeClusterSecurityGroupIngressResponse |
revokeClusterSecurityGroupIngress(Consumer<RevokeClusterSecurityGroupIngressRequest.Builder> revokeClusterSecurityGroupIngressRequest)
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2
security group.
|
default RevokeClusterSecurityGroupIngressResponse |
revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest)
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2
security group.
|
default RevokeSnapshotAccessResponse |
revokeSnapshotAccess(Consumer<RevokeSnapshotAccessRequest.Builder> revokeSnapshotAccessRequest)
Removes the ability of the specified AWS customer account to restore the specified snapshot.
|
default RevokeSnapshotAccessResponse |
revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest)
Removes the ability of the specified AWS customer account to restore the specified snapshot.
|
default RotateEncryptionKeyResponse |
rotateEncryptionKey(Consumer<RotateEncryptionKeyRequest.Builder> rotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.
|
default RotateEncryptionKeyResponse |
rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static RedshiftClient create()
RedshiftClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static RedshiftClientBuilder builder()
RedshiftClient
.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 AWS region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
authorizeClusterSecurityGroupIngressRequest
- ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.AuthorizationAlreadyExistsException
- The specified CIDR block or EC2 security group is already authorized for the specified cluster security
group.AuthorizationQuotaExceededException
- The authorization quota for the cluster security group has been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the
AuthorizeClusterSecurityGroupIngressRequest.Builder
avoiding the need to create one manually via
AuthorizeClusterSecurityGroupIngressRequest.builder()
authorizeClusterSecurityGroupIngressRequest
- A Consumer
that will call methods on AuthorizeClusterSecurityGroupIngressMessage.Builder
to create a request.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.AuthorizationAlreadyExistsException
- The specified CIDR block or EC2 security group is already authorized for the specified cluster security
group.AuthorizationQuotaExceededException
- The authorization quota for the cluster security group has been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AuthorizeSnapshotAccessResponse authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest) throws ClusterSnapshotNotFoundException, AuthorizationAlreadyExistsException, AuthorizationQuotaExceededException, DependentServiceRequestThrottlingException, InvalidClusterSnapshotStateException, LimitExceededException, AwsServiceException, SdkClientException, RedshiftException
Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
authorizeSnapshotAccessRequest
- ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.AuthorizationAlreadyExistsException
- The specified CIDR block or EC2 security group is already authorized for the specified cluster security
group.AuthorizationQuotaExceededException
- The authorization quota for the cluster security group has been reached.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AuthorizeSnapshotAccessResponse authorizeSnapshotAccess(Consumer<AuthorizeSnapshotAccessRequest.Builder> authorizeSnapshotAccessRequest) throws ClusterSnapshotNotFoundException, AuthorizationAlreadyExistsException, AuthorizationQuotaExceededException, DependentServiceRequestThrottlingException, InvalidClusterSnapshotStateException, LimitExceededException, AwsServiceException, SdkClientException, RedshiftException
Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the AuthorizeSnapshotAccessRequest.Builder
avoiding
the need to create one manually via AuthorizeSnapshotAccessRequest.builder()
authorizeSnapshotAccessRequest
- A Consumer
that will call methods on AuthorizeSnapshotAccessMessage.Builder
to create a
request.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.AuthorizationAlreadyExistsException
- The specified CIDR block or EC2 security group is already authorized for the specified cluster security
group.AuthorizationQuotaExceededException
- The authorization quota for the cluster security group has been reached.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyClusterSnapshotResponse copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest) throws ClusterSnapshotAlreadyExistsException, ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RedshiftException
Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
copyClusterSnapshotRequest
- ClusterSnapshotAlreadyExistsException
- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.ClusterSnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster snapshots.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyClusterSnapshotResponse copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest) throws ClusterSnapshotAlreadyExistsException, ClusterSnapshotNotFoundException, InvalidClusterSnapshotStateException, ClusterSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RedshiftException
Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the CopyClusterSnapshotRequest.Builder
avoiding the
need to create one manually via CopyClusterSnapshotRequest.builder()
copyClusterSnapshotRequest
- A Consumer
that will call methods on CopyClusterSnapshotMessage.Builder
to create a
request.ClusterSnapshotAlreadyExistsException
- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.ClusterSnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster snapshots.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, AwsServiceException, SdkClientException, RedshiftException
Creates a new cluster.
To create the cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
createClusterRequest
- ClusterAlreadyExistsException
- The account already has a cluster with the given identifier.InsufficientClusterCapacityException
- The number of nodes specified exceeds the allotted capacity of the cluster.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.ClusterQuotaExceededException
- The request would exceed the allowed number of cluster instances for this account. For information about
increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesQuotaExceededException
- The operation would exceed the number of nodes allotted to the account. For information about increasing
your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException
- The operation would exceed the number of nodes allowed for a cluster.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidVpcNetworkStateException
- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException
- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException
- The Elastic IP (EIP) is invalid or cannot be found.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.LimitExceededException
- The encryption key has exceeded its grant limit in AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, AwsServiceException, SdkClientException, RedshiftException
Creates a new cluster.
To create the cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the CreateClusterRequest.Builder
avoiding the need to
create one manually via CreateClusterRequest.builder()
createClusterRequest
- A Consumer
that will call methods on CreateClusterMessage.Builder
to create a request.ClusterAlreadyExistsException
- The account already has a cluster with the given identifier.InsufficientClusterCapacityException
- The number of nodes specified exceeds the allotted capacity of the cluster.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.ClusterQuotaExceededException
- The request would exceed the allowed number of cluster instances for this account. For information about
increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesQuotaExceededException
- The operation would exceed the number of nodes allotted to the account. For information about increasing
your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException
- The operation would exceed the number of nodes allowed for a cluster.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidVpcNetworkStateException
- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException
- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException
- The Elastic IP (EIP) is invalid or cannot be found.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.LimitExceededException
- The encryption key has exceeded its grant limit in AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createClusterParameterGroupRequest
- ClusterParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster parameter groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.ClusterParameterGroupAlreadyExistsException
- A cluster parameter group with the same name already exists.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default CreateClusterParameterGroupResponse createClusterParameterGroup(Consumer<CreateClusterParameterGroupRequest.Builder> createClusterParameterGroupRequest) throws ClusterParameterGroupQuotaExceededException, ClusterParameterGroupAlreadyExistsException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the CreateClusterParameterGroupRequest.Builder
avoiding the need to create one manually via CreateClusterParameterGroupRequest.builder()
createClusterParameterGroupRequest
- A Consumer
that will call methods on CreateClusterParameterGroupMessage.Builder
to create
a request.ClusterParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster parameter groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.ClusterParameterGroupAlreadyExistsException
- A cluster parameter group with the same name already exists.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
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.
createClusterSecurityGroupRequest
- ClusterSecurityGroupAlreadyExistsException
- A cluster security group with the same name already exists.ClusterSecurityGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster security groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default CreateClusterSecurityGroupResponse createClusterSecurityGroup(Consumer<CreateClusterSecurityGroupRequest.Builder> createClusterSecurityGroupRequest) throws ClusterSecurityGroupAlreadyExistsException, ClusterSecurityGroupQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the CreateClusterSecurityGroupRequest.Builder
avoiding
the need to create one manually via CreateClusterSecurityGroupRequest.builder()
createClusterSecurityGroupRequest
- A Consumer
that will call methods on CreateClusterSecurityGroupMessage.Builder
to create a
request.ClusterSecurityGroupAlreadyExistsException
- A cluster security group with the same name already exists.ClusterSecurityGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster security groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default CreateClusterSnapshotResponse createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest) throws ClusterSnapshotAlreadyExistsException, InvalidClusterStateException, ClusterNotFoundException, ClusterSnapshotQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Creates a manual snapshot of the specified cluster. The cluster must be in the available
state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
createClusterSnapshotRequest
- ClusterSnapshotAlreadyExistsException
- The value specified as a snapshot identifier is already used by an existing snapshot.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.ClusterSnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster snapshots.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default CreateClusterSnapshotResponse createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest) throws ClusterSnapshotAlreadyExistsException, InvalidClusterStateException, ClusterNotFoundException, ClusterSnapshotQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Creates a manual snapshot of the specified cluster. The cluster must be in the available
state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the CreateClusterSnapshotRequest.Builder
avoiding the
need to create one manually via CreateClusterSnapshotRequest.builder()
createClusterSnapshotRequest
- A Consumer
that will call methods on CreateClusterSnapshotMessage.Builder
to create a
request.ClusterSnapshotAlreadyExistsException
- The value specified as a snapshot identifier is already used by an existing snapshot.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.ClusterSnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster snapshots.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
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.
createClusterSubnetGroupRequest
- ClusterSubnetGroupAlreadyExistsException
- A ClusterSubnetGroupName is already used by an existing cluster subnet group.ClusterSubnetGroupQuotaExceededException
- The request would result in user exceeding the allowed number of cluster subnet groups. For information
about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.ClusterSubnetQuotaExceededException
- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default CreateClusterSubnetGroupResponse createClusterSubnetGroup(Consumer<CreateClusterSubnetGroupRequest.Builder> createClusterSubnetGroupRequest) throws ClusterSubnetGroupAlreadyExistsException, ClusterSubnetGroupQuotaExceededException, ClusterSubnetQuotaExceededException, InvalidSubnetException, UnauthorizedOperationException, TagLimitExceededException, InvalidTagException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the CreateClusterSubnetGroupRequest.Builder
avoiding
the need to create one manually via CreateClusterSubnetGroupRequest.builder()
createClusterSubnetGroupRequest
- A Consumer
that will call methods on CreateClusterSubnetGroupMessage.Builder
to create a
request.ClusterSubnetGroupAlreadyExistsException
- A ClusterSubnetGroupName is already used by an existing cluster subnet group.ClusterSubnetGroupQuotaExceededException
- The request would result in user exceeding the allowed number of cluster subnet groups. For information
about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.ClusterSubnetQuotaExceededException
- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
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 AWS 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 AWS account. You must specify a source type if you specify a source ID.
createEventSubscriptionRequest
- EventSubscriptionQuotaExceededException
- The request would exceed the allowed number of event subscriptions for this account. For information
about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.SubscriptionAlreadyExistException
- There is already an existing event notification subscription with the specified name.SnsInvalidTopicException
- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SnsNoAuthorizationException
- You do not have permission to publish to the specified Amazon SNS topic.SnsTopicArnNotFoundException
- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException
- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException
- The value specified for the event category was not one of the allowed values, or it specified a category
that does not apply to the specified source type. The allowed values are Configuration, Management,
Monitoring, and Security.SubscriptionSeverityNotFoundException
- The value specified for the event severity was not one of the allowed values, or it specified a severity
that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException
- The specified Amazon Redshift event source could not be found.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
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 AWS 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 AWS account. You must specify a source type if you specify a source ID.
This is a convenience which creates an instance of the CreateEventSubscriptionRequest.Builder
avoiding
the need to create one manually via CreateEventSubscriptionRequest.builder()
createEventSubscriptionRequest
- A Consumer
that will call methods on CreateEventSubscriptionMessage.Builder
to create a
request.EventSubscriptionQuotaExceededException
- The request would exceed the allowed number of event subscriptions for this account. For information
about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.SubscriptionAlreadyExistException
- There is already an existing event notification subscription with the specified name.SnsInvalidTopicException
- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SnsNoAuthorizationException
- You do not have permission to publish to the specified Amazon SNS topic.SnsTopicArnNotFoundException
- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException
- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException
- The value specified for the event category was not one of the allowed values, or it specified a category
that does not apply to the specified source type. The allowed values are Configuration, Management,
Monitoring, and Security.SubscriptionSeverityNotFoundException
- The value specified for the event severity was not one of the allowed values, or it specified a severity
that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException
- The specified Amazon Redshift event source could not be found.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
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.
createHsmClientCertificateRequest
- HsmClientCertificateAlreadyExistsException
- There is already an existing Amazon Redshift HSM client certificate with the specified identifier.HsmClientCertificateQuotaExceededException
- The quota for HSM client certificates has been reached. For information about increasing your quota, go
to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default CreateHsmClientCertificateResponse createHsmClientCertificate(Consumer<CreateHsmClientCertificateRequest.Builder> createHsmClientCertificateRequest) throws HsmClientCertificateAlreadyExistsException, HsmClientCertificateQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the CreateHsmClientCertificateRequest.Builder
avoiding
the need to create one manually via CreateHsmClientCertificateRequest.builder()
createHsmClientCertificateRequest
- A Consumer
that will call methods on CreateHsmClientCertificateMessage.Builder
to create a
request.HsmClientCertificateAlreadyExistsException
- There is already an existing Amazon Redshift HSM client certificate with the specified identifier.HsmClientCertificateQuotaExceededException
- The quota for HSM client certificates has been reached. For information about increasing your quota, go
to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
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.
createHsmConfigurationRequest
- HsmConfigurationAlreadyExistsException
- There is already an existing Amazon Redshift HSM configuration with the specified identifier.HsmConfigurationQuotaExceededException
- The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default CreateHsmConfigurationResponse createHsmConfiguration(Consumer<CreateHsmConfigurationRequest.Builder> createHsmConfigurationRequest) throws HsmConfigurationAlreadyExistsException, HsmConfigurationQuotaExceededException, TagLimitExceededException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the CreateHsmConfigurationRequest.Builder
avoiding the
need to create one manually via CreateHsmConfigurationRequest.builder()
createHsmConfigurationRequest
- A Consumer
that will call methods on CreateHsmConfigurationMessage.Builder
to create a
request.HsmConfigurationAlreadyExistsException
- There is already an existing Amazon Redshift HSM configuration with the specified identifier.HsmConfigurationQuotaExceededException
- The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
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 a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
createSnapshotCopyGrantRequest
- The result of the CreateSnapshotCopyGrant
action.SnapshotCopyGrantAlreadyExistsException
- The snapshot copy grant can't be created because a grant with the same name already exists.SnapshotCopyGrantQuotaExceededException
- The AWS account has exceeded the maximum number of snapshot copy grants in this region.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
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 a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the CreateSnapshotCopyGrantRequest.Builder
avoiding
the need to create one manually via CreateSnapshotCopyGrantRequest.builder()
createSnapshotCopyGrantRequest
- A Consumer
that will call methods on CreateSnapshotCopyGrantMessage.Builder
to create a
request. The result of the CreateSnapshotCopyGrant
action.SnapshotCopyGrantAlreadyExistsException
- The snapshot copy grant can't be created because a grant with the same name already exists.SnapshotCopyGrantQuotaExceededException
- The AWS account has exceeded the maximum number of snapshot copy grants in this region.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws TagLimitExceededException, ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Adds one or more tags to a specified resource.
A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
createTagsRequest
- Contains the output from the CreateTags
action.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) throws TagLimitExceededException, ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Adds one or more tags to a specified resource.
A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
This is a convenience which creates an instance of the CreateTagsRequest.Builder
avoiding the need to
create one manually via CreateTagsRequest.builder()
createTagsRequest
- A Consumer
that will call methods on CreateTagsMessage.Builder
to create a request.
Contains the output from the CreateTags
action.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.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
default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, ClusterSnapshotAlreadyExistsException, ClusterSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RedshiftException
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to
false
and specify a name for FinalClusterSnapshotIdentifier. You can later restore this
snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be
"final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the
cluster.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
deleteClusterRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterSnapshotAlreadyExistsException
- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster snapshots.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, ClusterSnapshotAlreadyExistsException, ClusterSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RedshiftException
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to
false
and specify a name for FinalClusterSnapshotIdentifier. You can later restore this
snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be
"final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the
cluster.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the DeleteClusterRequest.Builder
avoiding the need to
create one manually via DeleteClusterRequest.builder()
deleteClusterRequest
- A Consumer
that will call methods on DeleteClusterMessage.Builder
to create a request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterSnapshotAlreadyExistsException
- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster snapshots.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteClusterParameterGroupRequest
- InvalidClusterParameterGroupStateException
- The cluster parameter group action can not be completed because another task is in progress that involves
the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteClusterParameterGroupResponse deleteClusterParameterGroup(Consumer<DeleteClusterParameterGroupRequest.Builder> deleteClusterParameterGroupRequest) throws InvalidClusterParameterGroupStateException, ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
This is a convenience which creates an instance of the DeleteClusterParameterGroupRequest.Builder
avoiding the need to create one manually via DeleteClusterParameterGroupRequest.builder()
deleteClusterParameterGroupRequest
- A Consumer
that will call methods on DeleteClusterParameterGroupMessage.Builder
to create
a request.InvalidClusterParameterGroupStateException
- The cluster parameter group action can not be completed because another task is in progress that involves
the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteClusterSecurityGroupRequest
- InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteClusterSecurityGroupResponse deleteClusterSecurityGroup(Consumer<DeleteClusterSecurityGroupRequest.Builder> deleteClusterSecurityGroupRequest) throws InvalidClusterSecurityGroupStateException, ClusterSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes an Amazon Redshift security group.
You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the DeleteClusterSecurityGroupRequest.Builder
avoiding
the need to create one manually via DeleteClusterSecurityGroupRequest.builder()
deleteClusterSecurityGroupRequest
- A Consumer
that will call methods on DeleteClusterSecurityGroupMessage.Builder
to create a
request.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteClusterSnapshotResponse deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) throws InvalidClusterSnapshotStateException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified manual snapshot. The snapshot must be in the available
state, with no other
users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
deleteClusterSnapshotRequest
- InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteClusterSnapshotResponse deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest) throws InvalidClusterSnapshotStateException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified manual snapshot. The snapshot must be in the available
state, with no other
users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
This is a convenience which creates an instance of the DeleteClusterSnapshotRequest.Builder
avoiding the
need to create one manually via DeleteClusterSnapshotRequest.builder()
deleteClusterSnapshotRequest
- A Consumer
that will call methods on DeleteClusterSnapshotMessage.Builder
to create a
request.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteClusterSubnetGroupResponse deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest) throws InvalidClusterSubnetGroupStateException, InvalidClusterSubnetStateException, ClusterSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified cluster subnet group.
deleteClusterSubnetGroupRequest
- InvalidClusterSubnetGroupStateException
- The cluster subnet group cannot be deleted because it is in use.InvalidClusterSubnetStateException
- The state of the subnet is invalid.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteClusterSubnetGroupResponse deleteClusterSubnetGroup(Consumer<DeleteClusterSubnetGroupRequest.Builder> deleteClusterSubnetGroupRequest) throws InvalidClusterSubnetGroupStateException, InvalidClusterSubnetStateException, ClusterSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified cluster subnet group.
This is a convenience which creates an instance of the DeleteClusterSubnetGroupRequest.Builder
avoiding
the need to create one manually via DeleteClusterSubnetGroupRequest.builder()
deleteClusterSubnetGroupRequest
- A Consumer
that will call methods on DeleteClusterSubnetGroupMessage.Builder
to create a
request.InvalidClusterSubnetGroupStateException
- The cluster subnet group cannot be deleted because it is in use.InvalidClusterSubnetStateException
- The state of the subnet is invalid.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidSubscriptionStateException, AwsServiceException, SdkClientException, RedshiftException
Deletes an Amazon Redshift event notification subscription.
deleteEventSubscriptionRequest
- SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidSubscriptionStateException
- The subscription request is invalid because it is a duplicate request. This subscription request is
already in progress.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEventSubscriptionResponse deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidSubscriptionStateException, AwsServiceException, SdkClientException, RedshiftException
Deletes an Amazon Redshift event notification subscription.
This is a convenience which creates an instance of the DeleteEventSubscriptionRequest.Builder
avoiding
the need to create one manually via DeleteEventSubscriptionRequest.builder()
deleteEventSubscriptionRequest
- A Consumer
that will call methods on DeleteEventSubscriptionMessage.Builder
to create a
request.SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidSubscriptionStateException
- The subscription request is invalid because it is a duplicate request. This subscription request is
already in progress.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteHsmClientCertificateResponse deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest) throws InvalidHsmClientCertificateStateException, HsmClientCertificateNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified HSM client certificate.
deleteHsmClientCertificateRequest
- InvalidHsmClientCertificateStateException
- The specified HSM client certificate is not in the available
state, or it is still in use by
one or more Amazon Redshift clusters.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteHsmClientCertificateResponse deleteHsmClientCertificate(Consumer<DeleteHsmClientCertificateRequest.Builder> deleteHsmClientCertificateRequest) throws InvalidHsmClientCertificateStateException, HsmClientCertificateNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified HSM client certificate.
This is a convenience which creates an instance of the DeleteHsmClientCertificateRequest.Builder
avoiding
the need to create one manually via DeleteHsmClientCertificateRequest.builder()
deleteHsmClientCertificateRequest
- A Consumer
that will call methods on DeleteHsmClientCertificateMessage.Builder
to create a
request.InvalidHsmClientCertificateStateException
- The specified HSM client certificate is not in the available
state, or it is still in use by
one or more Amazon Redshift clusters.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteHsmConfigurationResponse deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest) throws InvalidHsmConfigurationStateException, HsmConfigurationNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified Amazon Redshift HSM configuration.
deleteHsmConfigurationRequest
- InvalidHsmConfigurationStateException
- The specified HSM configuration is not in the available
state, or it is still in use by one
or more Amazon Redshift clusters.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteHsmConfigurationResponse deleteHsmConfiguration(Consumer<DeleteHsmConfigurationRequest.Builder> deleteHsmConfigurationRequest) throws InvalidHsmConfigurationStateException, HsmConfigurationNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified Amazon Redshift HSM configuration.
This is a convenience which creates an instance of the DeleteHsmConfigurationRequest.Builder
avoiding the
need to create one manually via DeleteHsmConfigurationRequest.builder()
deleteHsmConfigurationRequest
- A Consumer
that will call methods on DeleteHsmConfigurationMessage.Builder
to create a
request.InvalidHsmConfigurationStateException
- The specified HSM configuration is not in the available
state, or it is still in use by one
or more Amazon Redshift clusters.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSnapshotCopyGrantResponse deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest) throws InvalidSnapshotCopyGrantStateException, SnapshotCopyGrantNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified snapshot copy grant.
deleteSnapshotCopyGrantRequest
- The result of the DeleteSnapshotCopyGrant
action.InvalidSnapshotCopyGrantStateException
- The snapshot copy grant can't be deleted because it is used by one or more clusters.SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSnapshotCopyGrantResponse deleteSnapshotCopyGrant(Consumer<DeleteSnapshotCopyGrantRequest.Builder> deleteSnapshotCopyGrantRequest) throws InvalidSnapshotCopyGrantStateException, SnapshotCopyGrantNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Deletes the specified snapshot copy grant.
This is a convenience which creates an instance of the DeleteSnapshotCopyGrantRequest.Builder
avoiding
the need to create one manually via DeleteSnapshotCopyGrantRequest.builder()
deleteSnapshotCopyGrantRequest
- A Consumer
that will call methods on DeleteSnapshotCopyGrantMessage.Builder
to create a
request. The result of the DeleteSnapshotCopyGrant
action.InvalidSnapshotCopyGrantStateException
- The snapshot copy grant can't be deleted because it is used by one or more clusters.SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
deleteTagsRequest
- Contains the output from the DeleteTags
action.ResourceNotFoundException
- The resource could not be found.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
This is a convenience which creates an instance of the DeleteTagsRequest.Builder
avoiding the need to
create one manually via DeleteTagsRequest.builder()
deleteTagsRequest
- A Consumer
that will call methods on DeleteTagsMessage.Builder
to create a request.
Contains the output from the DeleteTags
action.ResourceNotFoundException
- The resource could not be found.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeClusterParameterGroups(DescribeClusterParameterGroupsRequest)
,
AWS API Documentationdefault DescribeClusterParameterGroupsResponse describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterParameterGroupsRequest
- ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterParameterGroupsResponse describeClusterParameterGroups(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClusterParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterParameterGroupsRequest.builder()
describeClusterParameterGroupsRequest
- A Consumer
that will call methods on DescribeClusterParameterGroupsMessage.Builder
to
create a request.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator() throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client .describeClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.
ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest)
,
AWS API Documentationdefault DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client .describeClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.
describeClusterParameterGroupsRequest
- ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterParameterGroupsIterable describeClusterParameterGroupsPaginator(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest) throws ClusterParameterGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client .describeClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsIterable responses = client.describeClusterParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeClusterParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterParameterGroupsRequest.builder()
describeClusterParameterGroupsRequest
- A Consumer
that will call methods on DescribeClusterParameterGroupsMessage.Builder
to
create a request.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeClusterParametersRequest
- ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterParametersResponse describeClusterParameters(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) throws ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the DescribeClusterParametersRequest.Builder
avoiding
the need to create one manually via DescribeClusterParametersRequest.builder()
describeClusterParametersRequest
- A Consumer
that will call methods on DescribeClusterParametersMessage.Builder
to create a
request.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterParametersIterable describeClusterParametersPaginator(DescribeClusterParametersRequest describeClusterParametersRequest) throws ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client .describeClusterParametersPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation.
describeClusterParametersRequest
- ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterParametersIterable describeClusterParametersPaginator(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest) throws ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client .describeClusterParametersPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersIterable responses = client.describeClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeClusterParametersRequest.Builder
avoiding
the need to create one manually via DescribeClusterParametersRequest.builder()
describeClusterParametersRequest
- A Consumer
that will call methods on DescribeClusterParametersMessage.Builder
to create a
request.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterSecurityGroupsResponse describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterSecurityGroupsRequest
- ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterSecurityGroupsResponse describeClusterSecurityGroups(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClusterSecurityGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterSecurityGroupsRequest.builder()
describeClusterSecurityGroupsRequest
- A Consumer
that will call methods on DescribeClusterSecurityGroupsMessage.Builder
to
create a request.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterSecurityGroupsIterable describeClusterSecurityGroupsPaginator(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client .describeClusterSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation.
describeClusterSecurityGroupsRequest
- ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterSecurityGroupsIterable describeClusterSecurityGroupsPaginator(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest) throws ClusterSecurityGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client .describeClusterSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsIterable responses = client.describeClusterSecurityGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeClusterSecurityGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterSecurityGroupsRequest.builder()
describeClusterSecurityGroupsRequest
- A Consumer
that will call methods on DescribeClusterSecurityGroupsMessage.Builder
to
create a request.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterSnapshotsResponse describeClusterSnapshots() throws ClusterSnapshotNotFoundException, InvalidTagException, 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 you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.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
describeClusterSnapshots(DescribeClusterSnapshotsRequest)
,
AWS API Documentationdefault DescribeClusterSnapshotsResponse describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) throws ClusterSnapshotNotFoundException, InvalidTagException, 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 you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
describeClusterSnapshotsRequest
- ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.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
default DescribeClusterSnapshotsResponse describeClusterSnapshots(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) throws ClusterSnapshotNotFoundException, InvalidTagException, 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 you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClusterSnapshotsRequest.Builder
avoiding
the need to create one manually via DescribeClusterSnapshotsRequest.builder()
describeClusterSnapshotsRequest
- A Consumer
that will call methods on DescribeClusterSnapshotsMessage.Builder
to create a
request.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.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
default DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator() throws ClusterSnapshotNotFoundException, InvalidTagException, 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 you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client .describeClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.
ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.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
describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest)
,
AWS API Documentationdefault DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) throws ClusterSnapshotNotFoundException, InvalidTagException, 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 you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client .describeClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.
describeClusterSnapshotsRequest
- ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.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
default DescribeClusterSnapshotsIterable describeClusterSnapshotsPaginator(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) throws ClusterSnapshotNotFoundException, InvalidTagException, 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 you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client .describeClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsIterable responses = client.describeClusterSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.
This is a convenience which creates an instance of the DescribeClusterSnapshotsRequest.Builder
avoiding
the need to create one manually via DescribeClusterSnapshotsRequest.builder()
describeClusterSnapshotsRequest
- A Consumer
that will call methods on DescribeClusterSnapshotsMessage.Builder
to create a
request.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.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
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 you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest)
,
AWS API Documentationdefault 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 you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterSubnetGroupsRequest
- ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClusterSubnetGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterSubnetGroupsRequest.builder()
describeClusterSubnetGroupsRequest
- A Consumer
that will call methods on DescribeClusterSubnetGroupsMessage.Builder
to create
a request.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator() throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client .describeClusterSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.
ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest)
,
AWS API Documentationdefault DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client .describeClusterSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.
describeClusterSubnetGroupsRequest
- ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterSubnetGroupsIterable describeClusterSubnetGroupsPaginator(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest) throws ClusterSubnetGroupNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client .describeClusterSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsIterable responses = client.describeClusterSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeClusterSubnetGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterSubnetGroupsRequest.builder()
describeClusterSubnetGroupsRequest
- A Consumer
that will call methods on DescribeClusterSubnetGroupsMessage.Builder
to create
a request.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeClusterVersions(DescribeClusterVersionsRequest)
,
AWS API Documentationdefault DescribeClusterVersionsResponse describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
describeClusterVersionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterVersionsResponse describeClusterVersions(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the DescribeClusterVersionsRequest.Builder
avoiding
the need to create one manually via DescribeClusterVersionsRequest.builder()
describeClusterVersionsRequest
- A Consumer
that will call methods on DescribeClusterVersionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterVersionsIterable describeClusterVersionsPaginator() throws AwsServiceException, SdkClientException, RedshiftException
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client .describeClusterVersionsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeClusterVersionsPaginator(DescribeClusterVersionsRequest)
,
AWS API Documentationdefault DescribeClusterVersionsIterable describeClusterVersionsPaginator(DescribeClusterVersionsRequest describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client .describeClusterVersionsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.
describeClusterVersionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterVersionsIterable describeClusterVersionsPaginator(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client .describeClusterVersionsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.
This is a convenience which creates an instance of the DescribeClusterVersionsRequest.Builder
avoiding
the need to create one manually via DescribeClusterVersionsRequest.builder()
describeClusterVersionsRequest
- A Consumer
that will call methods on DescribeClusterVersionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeClusters(DescribeClustersRequest)
,
AWS API
Documentationdefault DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
describeClustersRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClustersResponse describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeClustersRequest.Builder
avoiding the need
to create one manually via DescribeClustersRequest.builder()
describeClustersRequest
- A Consumer
that will call methods on DescribeClustersMessage.Builder
to create a request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClustersIterable describeClustersPaginator() throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client .describeClustersPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.
ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeClustersPaginator(DescribeClustersRequest)
,
AWS API
Documentationdefault DescribeClustersIterable describeClustersPaginator(DescribeClustersRequest describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client .describeClustersPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.
describeClustersRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClustersIterable describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws ClusterNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client .describeClustersPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.
This is a convenience which creates an instance of the DescribeClustersRequest.Builder
avoiding the need
to create one manually via DescribeClustersRequest.builder()
describeClustersRequest
- A Consumer
that will call methods on DescribeClustersMessage.Builder
to create a request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeDefaultClusterParametersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDefaultClusterParametersResponse describeDefaultClusterParameters(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the DescribeDefaultClusterParametersRequest.Builder
avoiding the need to create one manually via DescribeDefaultClusterParametersRequest.builder()
describeDefaultClusterParametersRequest
- A Consumer
that will call methods on DescribeDefaultClusterParametersMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDefaultClusterParametersIterable describeDefaultClusterParametersPaginator(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client .describeDefaultClusterParametersPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation.
describeDefaultClusterParametersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDefaultClusterParametersIterable describeDefaultClusterParametersPaginator(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client .describeDefaultClusterParametersPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersIterable responses = client.describeDefaultClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeDefaultClusterParametersRequest.Builder
avoiding the need to create one manually via DescribeDefaultClusterParametersRequest.builder()
describeDefaultClusterParametersRequest
- A Consumer
that will call methods on DescribeDefaultClusterParametersMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventCategories(DescribeEventCategoriesRequest)
,
AWS API Documentationdefault DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, RedshiftException
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
describeEventCategoriesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventCategoriesResponse describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, RedshiftException
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
This is a convenience which creates an instance of the DescribeEventCategoriesRequest.Builder
avoiding
the need to create one manually via DescribeEventCategoriesRequest.builder()
describeEventCategoriesRequest
- A Consumer
that will call methods on DescribeEventCategoriesMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventSubscriptions(DescribeEventSubscriptionsRequest)
,
AWS API Documentationdefault DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
describeEventSubscriptionsRequest
- SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventSubscriptionsResponse describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder
avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest
- A Consumer
that will call methods on DescribeEventSubscriptionsMessage.Builder
to create a
request.SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.
SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest)
,
AWS API Documentationdefault DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.
describeEventSubscriptionsRequest
- SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder
avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest
- A Consumer
that will call methods on DescribeEventSubscriptionsMessage.Builder
to create a
request.SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEvents(DescribeEventsRequest)
,
AWS API
Documentationdefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEventsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder
avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest
- A Consumer
that will call methods on DescribeEventsMessage.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, RedshiftException
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventsPaginator(DescribeEventsRequest)
,
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.
describeEventsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder
avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest
- A Consumer
that will call methods on DescribeEventsMessage.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeHsmClientCertificates(DescribeHsmClientCertificatesRequest)
,
AWS API Documentationdefault 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 AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
describeHsmClientCertificatesRequest
- HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeHsmClientCertificatesRequest.Builder
avoiding the need to create one manually via DescribeHsmClientCertificatesRequest.builder()
describeHsmClientCertificatesRequest
- A Consumer
that will call methods on DescribeHsmClientCertificatesMessage.Builder
to
create a request.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator() throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client .describeHsmClientCertificatesPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.
HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest)
,
AWS API Documentationdefault DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client .describeHsmClientCertificatesPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.
describeHsmClientCertificatesRequest
- HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHsmClientCertificatesIterable describeHsmClientCertificatesPaginator(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest) throws HsmClientCertificateNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client .describeHsmClientCertificatesPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesIterable responses = client.describeHsmClientCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.
This is a convenience which creates an instance of the DescribeHsmClientCertificatesRequest.Builder
avoiding the need to create one manually via DescribeHsmClientCertificatesRequest.builder()
describeHsmClientCertificatesRequest
- A Consumer
that will call methods on DescribeHsmClientCertificatesMessage.Builder
to
create a request.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeHsmConfigurations(DescribeHsmConfigurationsRequest)
,
AWS API Documentationdefault 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 AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
describeHsmConfigurationsRequest
- HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeHsmConfigurationsRequest.Builder
avoiding
the need to create one manually via DescribeHsmConfigurationsRequest.builder()
describeHsmConfigurationsRequest
- A Consumer
that will call methods on DescribeHsmConfigurationsMessage.Builder
to create a
request.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator() throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client .describeHsmConfigurationsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.
HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest)
,
AWS API Documentationdefault DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client .describeHsmConfigurationsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.
describeHsmConfigurationsRequest
- HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHsmConfigurationsIterable describeHsmConfigurationsPaginator(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest) throws HsmConfigurationNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client .describeHsmConfigurationsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsIterable responses = client.describeHsmConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.
This is a convenience which creates an instance of the DescribeHsmConfigurationsRequest.Builder
avoiding
the need to create one manually via DescribeHsmConfigurationsRequest.builder()
describeHsmConfigurationsRequest
- A Consumer
that will call methods on DescribeHsmConfigurationsMessage.Builder
to create a
request.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeLoggingStatusResponse describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest) throws ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
describeLoggingStatusRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeLoggingStatusResponse describeLoggingStatus(Consumer<DescribeLoggingStatusRequest.Builder> describeLoggingStatusRequest) throws ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
This is a convenience which creates an instance of the DescribeLoggingStatusRequest.Builder
avoiding the
need to create one manually via DescribeLoggingStatusRequest.builder()
describeLoggingStatusRequest
- A Consumer
that will call methods on DescribeLoggingStatusMessage.Builder
to create a
request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest)
,
AWS API Documentationdefault 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 AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
describeOrderableClusterOptionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the DescribeOrderableClusterOptionsRequest.Builder
avoiding the need to create one manually via DescribeOrderableClusterOptionsRequest.builder()
describeOrderableClusterOptionsRequest
- A Consumer
that will call methods on DescribeOrderableClusterOptionsMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator() throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client .describeOrderableClusterOptionsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest)
,
AWS API Documentationdefault DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client .describeOrderableClusterOptionsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.
describeOrderableClusterOptionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableClusterOptionsIterable describeOrderableClusterOptionsPaginator(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest) throws AwsServiceException, SdkClientException, RedshiftException
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client .describeOrderableClusterOptionsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsIterable responses = client.describeOrderableClusterOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.
This is a convenience which creates an instance of the DescribeOrderableClusterOptionsRequest.Builder
avoiding the need to create one manually via DescribeOrderableClusterOptionsRequest.builder()
describeOrderableClusterOptionsRequest
- A Consumer
that will call methods on DescribeOrderableClusterOptionsMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
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.UnsupportedOperationException
AwsServiceException
describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest)
,
AWS API Documentationdefault DescribeReservedNodeOfferingsResponse describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
describeReservedNodeOfferingsRequest
- ReservedNodeOfferingNotFoundException
- Specified offering does not exist.UnsupportedOperationException
- The requested operation isn't supported.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeReservedNodeOfferingsResponse describeReservedNodeOfferings(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the DescribeReservedNodeOfferingsRequest.Builder
avoiding the need to create one manually via DescribeReservedNodeOfferingsRequest.builder()
describeReservedNodeOfferingsRequest
- A Consumer
that will call methods on DescribeReservedNodeOfferingsMessage.Builder
to
create a request.ReservedNodeOfferingNotFoundException
- Specified offering does not exist.UnsupportedOperationException
- The requested operation isn't supported.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator() throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client .describeReservedNodeOfferingsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.
ReservedNodeOfferingNotFoundException
- Specified offering does not exist.UnsupportedOperationException
- The requested operation isn't supported.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
describeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest)
,
AWS API Documentationdefault DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client .describeReservedNodeOfferingsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.
describeReservedNodeOfferingsRequest
- ReservedNodeOfferingNotFoundException
- Specified offering does not exist.UnsupportedOperationException
- The requested operation isn't supported.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeReservedNodeOfferingsIterable describeReservedNodeOfferingsPaginator(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest) throws ReservedNodeOfferingNotFoundException, UnsupportedOperationException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client .describeReservedNodeOfferingsPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsIterable responses = client.describeReservedNodeOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.
This is a convenience which creates an instance of the DescribeReservedNodeOfferingsRequest.Builder
avoiding the need to create one manually via DescribeReservedNodeOfferingsRequest.builder()
describeReservedNodeOfferingsRequest
- A Consumer
that will call methods on DescribeReservedNodeOfferingsMessage.Builder
to
create a request.ReservedNodeOfferingNotFoundException
- Specified offering does not exist.UnsupportedOperationException
- The requested operation isn't supported.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeReservedNodesResponse describeReservedNodes() throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
ReservedNodeNotFoundException
- The specified reserved compute node not found.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeReservedNodes(DescribeReservedNodesRequest)
,
AWS
API Documentationdefault DescribeReservedNodesResponse describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
describeReservedNodesRequest
- ReservedNodeNotFoundException
- The specified reserved compute node not found.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeReservedNodesResponse describeReservedNodes(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
This is a convenience which creates an instance of the DescribeReservedNodesRequest.Builder
avoiding the
need to create one manually via DescribeReservedNodesRequest.builder()
describeReservedNodesRequest
- A Consumer
that will call methods on DescribeReservedNodesMessage.Builder
to create a
request.ReservedNodeNotFoundException
- The specified reserved compute node not found.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeReservedNodesIterable describeReservedNodesPaginator() throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client .describeReservedNodesPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.
ReservedNodeNotFoundException
- The specified reserved compute node not found.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeReservedNodesPaginator(DescribeReservedNodesRequest)
,
AWS
API Documentationdefault DescribeReservedNodesIterable describeReservedNodesPaginator(DescribeReservedNodesRequest describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client .describeReservedNodesPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.
describeReservedNodesRequest
- ReservedNodeNotFoundException
- The specified reserved compute node not found.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeReservedNodesIterable describeReservedNodesPaginator(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) throws ReservedNodeNotFoundException, DependentServiceUnavailableException, AwsServiceException, SdkClientException, RedshiftException
Returns the descriptions of the reserved nodes.
This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client .describeReservedNodesPaginator(request); for (software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesIterable responses = client.describeReservedNodesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.
This is a convenience which creates an instance of the DescribeReservedNodesRequest.Builder
avoiding the
need to create one manually via DescribeReservedNodesRequest.builder()
describeReservedNodesRequest
- A Consumer
that will call methods on DescribeReservedNodesMessage.Builder
to create a
request.ReservedNodeNotFoundException
- The specified reserved compute node not found.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeResizeResponse describeResize(DescribeResizeRequest describeResizeRequest) throws ClusterNotFoundException, ResizeNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the last resize operation for the specified cluster. If no resize operation has ever
been initiated for the specified cluster, a HTTP 404
error is returned. If a resize operation was
initiated and completed, the status of the resize remains as SUCCEEDED
until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
describeResizeRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.ResizeNotFoundException
- A resize operation for the specified cluster is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeResizeResponse describeResize(Consumer<DescribeResizeRequest.Builder> describeResizeRequest) throws ClusterNotFoundException, ResizeNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Returns information about the last resize operation for the specified cluster. If no resize operation has ever
been initiated for the specified cluster, a HTTP 404
error is returned. If a resize operation was
initiated and completed, the status of the resize remains as SUCCEEDED
until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
This is a convenience which creates an instance of the DescribeResizeRequest.Builder
avoiding the need to
create one manually via DescribeResizeRequest.builder()
describeResizeRequest
- A Consumer
that will call methods on DescribeResizeMessage.Builder
to create a request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.ResizeNotFoundException
- A resize operation for the specified cluster is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSnapshotCopyGrantsResponse describeSnapshotCopyGrants() throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest)
,
AWS API Documentationdefault DescribeSnapshotCopyGrantsResponse describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
describeSnapshotCopyGrantsRequest
- The result of the DescribeSnapshotCopyGrants
action.SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSnapshotCopyGrantsResponse describeSnapshotCopyGrants(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest) throws SnapshotCopyGrantNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the DescribeSnapshotCopyGrantsRequest.Builder
avoiding
the need to create one manually via DescribeSnapshotCopyGrantsRequest.builder()
describeSnapshotCopyGrantsRequest
- A Consumer
that will call methods on DescribeSnapshotCopyGrantsMessage.Builder
to create a
request. The result of the DescribeSnapshotCopyGrants
action.SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTableRestoreStatusResponse describeTableRestoreStatus(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) throws TableRestoreNotFoundException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action. If you don't specify a value for the TableRestoreRequestId
parameter, then
DescribeTableRestoreStatus
returns the status of all table restore requests ordered by the date and
time of the request in ascending order. Otherwise DescribeTableRestoreStatus
returns the status of
the table specified by TableRestoreRequestId
.
describeTableRestoreStatusRequest
- TableRestoreNotFoundException
- The specified TableRestoreRequestId
value was not found.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTableRestoreStatusResponse describeTableRestoreStatus(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest) throws TableRestoreNotFoundException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action. If you don't specify a value for the TableRestoreRequestId
parameter, then
DescribeTableRestoreStatus
returns the status of all table restore requests ordered by the date and
time of the request in ascending order. Otherwise DescribeTableRestoreStatus
returns the status of
the table specified by TableRestoreRequestId
.
This is a convenience which creates an instance of the DescribeTableRestoreStatusRequest.Builder
avoiding
the need to create one manually via DescribeTableRestoreStatusRequest.builder()
describeTableRestoreStatusRequest
- A Consumer
that will call methods on DescribeTableRestoreStatusMessage.Builder
to create a
request.TableRestoreNotFoundException
- The specified TableRestoreRequestId
value was not found.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 MaxRecords
and Marker
parameters together with the ARN parameter.
The MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
ResourceNotFoundException
- The resource could not be found.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeTags(DescribeTagsRequest)
,
AWS API
Documentationdefault DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags
:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords
and Marker
parameters together with the ARN parameter.
The MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
describeTagsRequest
- ResourceNotFoundException
- The resource could not be found.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws ResourceNotFoundException, InvalidTagException, AwsServiceException, SdkClientException, RedshiftException
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags
:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords
and Marker
parameters together with the ARN parameter.
The MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
This is a convenience which creates an instance of the DescribeTagsRequest.Builder
avoiding the need to
create one manually via DescribeTagsRequest.builder()
describeTagsRequest
- A Consumer
that will call methods on DescribeTagsMessage.Builder
to create a request.ResourceNotFoundException
- The resource could not be found.InvalidTagException
- The tag is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableLoggingResponse disableLogging(DisableLoggingRequest disableLoggingRequest) throws ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
disableLoggingRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableLoggingResponse disableLogging(Consumer<DisableLoggingRequest.Builder> disableLoggingRequest) throws ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
This is a convenience which creates an instance of the DisableLoggingRequest.Builder
avoiding the need to
create one manually via DisableLoggingRequest.builder()
disableLoggingRequest
- A Consumer
that will call methods on DisableLoggingMessage.Builder
to create a request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableSnapshotCopyResponse disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest) throws ClusterNotFoundException, SnapshotCopyAlreadyDisabledException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
disableSnapshotCopyRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SnapshotCopyAlreadyDisabledException
- The cluster already has cross-region snapshot copy disabled.InvalidClusterStateException
- The specified cluster is not in the available
state.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableSnapshotCopyResponse disableSnapshotCopy(Consumer<DisableSnapshotCopyRequest.Builder> disableSnapshotCopyRequest) throws ClusterNotFoundException, SnapshotCopyAlreadyDisabledException, InvalidClusterStateException, UnauthorizedOperationException, AwsServiceException, SdkClientException, RedshiftException
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
This is a convenience which creates an instance of the DisableSnapshotCopyRequest.Builder
avoiding the
need to create one manually via DisableSnapshotCopyRequest.builder()
disableSnapshotCopyRequest
- A Consumer
that will call methods on DisableSnapshotCopyMessage.Builder
to create a
request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SnapshotCopyAlreadyDisabledException
- The cluster already has cross-region snapshot copy disabled.InvalidClusterStateException
- The specified cluster is not in the available
state.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableLoggingResponse enableLogging(EnableLoggingRequest enableLoggingRequest) throws ClusterNotFoundException, BucketNotFoundException, InsufficientS3BucketPolicyException, InvalidS3KeyPrefixException, InvalidS3BucketNameException, AwsServiceException, SdkClientException, RedshiftException
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
enableLoggingRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.BucketNotFoundException
- Could not find the specified S3 bucket.InsufficientS3BucketPolicyException
- The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling
logging.InvalidS3KeyPrefixException
- The string specified for the logging S3 key prefix does not comply with the documented constraints.InvalidS3BucketNameException
- The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and
Limitations in the Amazon Simple Storage Service (S3) Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableLoggingResponse enableLogging(Consumer<EnableLoggingRequest.Builder> enableLoggingRequest) throws ClusterNotFoundException, BucketNotFoundException, InsufficientS3BucketPolicyException, InvalidS3KeyPrefixException, InvalidS3BucketNameException, AwsServiceException, SdkClientException, RedshiftException
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
This is a convenience which creates an instance of the EnableLoggingRequest.Builder
avoiding the need to
create one manually via EnableLoggingRequest.builder()
enableLoggingRequest
- A Consumer
that will call methods on EnableLoggingMessage.Builder
to create a request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.BucketNotFoundException
- Could not find the specified S3 bucket.InsufficientS3BucketPolicyException
- The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling
logging.InvalidS3KeyPrefixException
- The string specified for the logging S3 key prefix does not comply with the documented constraints.InvalidS3BucketNameException
- The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and
Limitations in the Amazon Simple Storage Service (S3) Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableSnapshotCopyResponse enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest) throws IncompatibleOrderableOptionsException, InvalidClusterStateException, ClusterNotFoundException, CopyToRegionDisabledException, SnapshotCopyAlreadyEnabledException, UnknownSnapshotCopyRegionException, UnauthorizedOperationException, SnapshotCopyGrantNotFoundException, LimitExceededException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
enableSnapshotCopyRequest
- IncompatibleOrderableOptionsException
- The specified options are incompatible.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.CopyToRegionDisabledException
- Cross-region snapshot copy was temporarily disabled. Try your request again.SnapshotCopyAlreadyEnabledException
- The cluster already has cross-region snapshot copy enabled.UnknownSnapshotCopyRegionException
- The specified region is incorrect or does not exist.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.LimitExceededException
- The encryption key has exceeded its grant limit in AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableSnapshotCopyResponse enableSnapshotCopy(Consumer<EnableSnapshotCopyRequest.Builder> enableSnapshotCopyRequest) throws IncompatibleOrderableOptionsException, InvalidClusterStateException, ClusterNotFoundException, CopyToRegionDisabledException, SnapshotCopyAlreadyEnabledException, UnknownSnapshotCopyRegionException, UnauthorizedOperationException, SnapshotCopyGrantNotFoundException, LimitExceededException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
This is a convenience which creates an instance of the EnableSnapshotCopyRequest.Builder
avoiding the
need to create one manually via EnableSnapshotCopyRequest.builder()
enableSnapshotCopyRequest
- A Consumer
that will call methods on EnableSnapshotCopyMessage.Builder
to create a
request.IncompatibleOrderableOptionsException
- The specified options are incompatible.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.CopyToRegionDisabledException
- Cross-region snapshot copy was temporarily disabled. Try your request again.SnapshotCopyAlreadyEnabledException
- The cluster already has cross-region snapshot copy enabled.UnknownSnapshotCopyRegionException
- The specified region is incorrect or does not exist.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.LimitExceededException
- The encryption key has exceeded its grant limit in AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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:
if AutoCreate
is
False
or IAMA:
if AutoCreate
is True
. You can optionally
specify one or more database user groups that the user will join at log on. By default, the temporary credentials
expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds
(60 minutes). For more information, see Using IAM Authentication
to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups
parameter is specified, the IAM policy must allow the
redshift:JoinGroup
action with access to the listed dbgroups
.
In addition, if the AutoCreate
parameter is set to True
, then the policy must include
the redshift:CreateClusterUser
privilege.
If the DbName
parameter is specified, the IAM policy must allow access to the resource
dbname
for the specified database name.
getClusterCredentialsRequest
- The request parameters to get cluster credentials.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.UnsupportedOperationException
- The requested operation isn't supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
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:
if AutoCreate
is
False
or IAMA:
if AutoCreate
is True
. You can optionally
specify one or more database user groups that the user will join at log on. By default, the temporary credentials
expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds
(60 minutes). For more information, see Using IAM Authentication
to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups
parameter is specified, the IAM policy must allow the
redshift:JoinGroup
action with access to the listed dbgroups
.
In addition, if the AutoCreate
parameter is set to True
, then the policy must include
the redshift:CreateClusterUser
privilege.
If the DbName
parameter is specified, the IAM policy must allow access to the resource
dbname
for the specified database name.
This is a convenience which creates an instance of the GetClusterCredentialsRequest.Builder
avoiding the
need to create one manually via GetClusterCredentialsRequest.builder()
getClusterCredentialsRequest
- A Consumer
that will call methods on GetClusterCredentialsMessage.Builder
to create a
request. The request parameters to get cluster credentials.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.UnsupportedOperationException
- The requested operation isn't supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default ModifyClusterResponse modifyCluster(ModifyClusterRequest modifyClusterRequest) throws InvalidClusterStateException, InvalidClusterSecurityGroupStateException, ClusterNotFoundException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, ClusterSecurityGroupNotFoundException, ClusterParameterGroupNotFoundException, InsufficientClusterCapacityException, UnsupportedOptionException, UnauthorizedOperationException, HsmClientCertificateNotFoundException, HsmConfigurationNotFoundException, ClusterAlreadyExistsException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidElasticIpException, AwsServiceException, SdkClientException, RedshiftException
Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master 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.
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.
modifyClusterRequest
- InvalidClusterStateException
- The specified cluster is not in the available
state.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.NumberOfNodesQuotaExceededException
- The operation would exceed the number of nodes allotted to the account. For information about increasing
your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException
- The operation would exceed the number of nodes allowed for a cluster.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InsufficientClusterCapacityException
- The number of nodes specified exceeds the allotted capacity of the cluster.UnsupportedOptionException
- A request option was specified that is not supported.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.ClusterAlreadyExistsException
- The account already has a cluster with the given identifier.LimitExceededException
- The encryption key has exceeded its grant limit in AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyClusterResponse modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest) throws InvalidClusterStateException, InvalidClusterSecurityGroupStateException, ClusterNotFoundException, NumberOfNodesQuotaExceededException, NumberOfNodesPerClusterLimitExceededException, ClusterSecurityGroupNotFoundException, ClusterParameterGroupNotFoundException, InsufficientClusterCapacityException, UnsupportedOptionException, UnauthorizedOperationException, HsmClientCertificateNotFoundException, HsmConfigurationNotFoundException, ClusterAlreadyExistsException, LimitExceededException, DependentServiceRequestThrottlingException, InvalidElasticIpException, AwsServiceException, SdkClientException, RedshiftException
Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master 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.
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.
This is a convenience which creates an instance of the ModifyClusterRequest.Builder
avoiding the need to
create one manually via ModifyClusterRequest.builder()
modifyClusterRequest
- A Consumer
that will call methods on ModifyClusterMessage.Builder
to create a request.InvalidClusterStateException
- The specified cluster is not in the available
state.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.NumberOfNodesQuotaExceededException
- The operation would exceed the number of nodes allotted to the account. For information about increasing
your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException
- The operation would exceed the number of nodes allowed for a cluster.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InsufficientClusterCapacityException
- The number of nodes specified exceeds the allotted capacity of the cluster.UnsupportedOptionException
- A request option was specified that is not supported.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.ClusterAlreadyExistsException
- The account already has a cluster with the given identifier.LimitExceededException
- The encryption key has exceeded its grant limit in AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyClusterIamRolesResponse modifyClusterIamRoles(ModifyClusterIamRolesRequest modifyClusterIamRolesRequest) throws InvalidClusterStateException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
A cluster can have up to 10 IAM roles associated at any time.
modifyClusterIamRolesRequest
- InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyClusterIamRolesResponse modifyClusterIamRoles(Consumer<ModifyClusterIamRolesRequest.Builder> modifyClusterIamRolesRequest) throws InvalidClusterStateException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
A cluster can have up to 10 IAM roles associated at any time.
This is a convenience which creates an instance of the ModifyClusterIamRolesRequest.Builder
avoiding the
need to create one manually via ModifyClusterIamRolesRequest.builder()
modifyClusterIamRolesRequest
- A Consumer
that will call methods on ModifyClusterIamRolesMessage.Builder
to create a
request.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyClusterParameterGroupResponse modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest) throws ClusterParameterGroupNotFoundException, InvalidClusterParameterGroupStateException, AwsServiceException, SdkClientException, RedshiftException
Modifies the parameters of a parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
modifyClusterParameterGroupRequest
- 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
default ModifyClusterParameterGroupResponse modifyClusterParameterGroup(Consumer<ModifyClusterParameterGroupRequest.Builder> modifyClusterParameterGroupRequest) throws ClusterParameterGroupNotFoundException, InvalidClusterParameterGroupStateException, AwsServiceException, SdkClientException, RedshiftException
Modifies the parameters of a parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the ModifyClusterParameterGroupRequest.Builder
avoiding the need to create one manually via ModifyClusterParameterGroupRequest.builder()
modifyClusterParameterGroupRequest
- A Consumer
that will call methods on ModifyClusterParameterGroupMessage.Builder
to create
a request.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
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.
modifyClusterSubnetGroupRequest
- ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.ClusterSubnetQuotaExceededException
- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.SubnetAlreadyInUseException
- A specified subnet is already in use by another cluster.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyClusterSubnetGroupResponse modifyClusterSubnetGroup(Consumer<ModifyClusterSubnetGroupRequest.Builder> modifyClusterSubnetGroupRequest) throws ClusterSubnetGroupNotFoundException, ClusterSubnetQuotaExceededException, SubnetAlreadyInUseException, InvalidSubnetException, UnauthorizedOperationException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
This is a convenience which creates an instance of the ModifyClusterSubnetGroupRequest.Builder
avoiding
the need to create one manually via ModifyClusterSubnetGroupRequest.builder()
modifyClusterSubnetGroupRequest
- A Consumer
that will call methods on ModifyClusterSubnetGroupMessage.Builder
to create a
request.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.ClusterSubnetQuotaExceededException
- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.SubnetAlreadyInUseException
- A specified subnet is already in use by another cluster.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
modifyEventSubscriptionRequest
- SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.SnsInvalidTopicException
- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SnsNoAuthorizationException
- You do not have permission to publish to the specified Amazon SNS topic.SnsTopicArnNotFoundException
- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException
- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException
- The value specified for the event category was not one of the allowed values, or it specified a category
that does not apply to the specified source type. The allowed values are Configuration, Management,
Monitoring, and Security.SubscriptionSeverityNotFoundException
- The value specified for the event severity was not one of the allowed values, or it specified a severity
that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException
- The specified Amazon Redshift event source could not be found.InvalidSubscriptionStateException
- The subscription request is invalid because it is a duplicate request. This subscription request is
already in progress.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyEventSubscriptionResponse modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) throws SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionEventIdNotFoundException, SubscriptionCategoryNotFoundException, SubscriptionSeverityNotFoundException, SourceNotFoundException, InvalidSubscriptionStateException, AwsServiceException, SdkClientException, RedshiftException
Modifies an existing Amazon Redshift event notification subscription.
This is a convenience which creates an instance of the ModifyEventSubscriptionRequest.Builder
avoiding
the need to create one manually via ModifyEventSubscriptionRequest.builder()
modifyEventSubscriptionRequest
- A Consumer
that will call methods on ModifyEventSubscriptionMessage.Builder
to create a
request.SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.SnsInvalidTopicException
- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SnsNoAuthorizationException
- You do not have permission to publish to the specified Amazon SNS topic.SnsTopicArnNotFoundException
- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException
- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException
- The value specified for the event category was not one of the allowed values, or it specified a category
that does not apply to the specified source type. The allowed values are Configuration, Management,
Monitoring, and Security.SubscriptionSeverityNotFoundException
- The value specified for the event severity was not one of the allowed values, or it specified a severity
that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException
- The specified Amazon Redshift event source could not be found.InvalidSubscriptionStateException
- The subscription request is invalid because it is a duplicate request. This subscription request is
already in progress.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifySnapshotCopyRetentionPeriodResponse modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest) throws ClusterNotFoundException, SnapshotCopyDisabledException, UnauthorizedOperationException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
modifySnapshotCopyRetentionPeriodRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SnapshotCopyDisabledException
- Cross-region snapshot copy was temporarily disabled. Try your request again.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.InvalidClusterStateException
- The specified cluster is not in the available
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifySnapshotCopyRetentionPeriodResponse modifySnapshotCopyRetentionPeriod(Consumer<ModifySnapshotCopyRetentionPeriodRequest.Builder> modifySnapshotCopyRetentionPeriodRequest) throws ClusterNotFoundException, SnapshotCopyDisabledException, UnauthorizedOperationException, InvalidClusterStateException, AwsServiceException, SdkClientException, RedshiftException
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
This is a convenience which creates an instance of the ModifySnapshotCopyRetentionPeriodRequest.Builder
avoiding the need to create one manually via ModifySnapshotCopyRetentionPeriodRequest.builder()
modifySnapshotCopyRetentionPeriodRequest
- A Consumer
that will call methods on ModifySnapshotCopyRetentionPeriodMessage.Builder
to
create a request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SnapshotCopyDisabledException
- Cross-region snapshot copy was temporarily disabled. Try your request again.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.InvalidClusterStateException
- The specified cluster is not in the available
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
purchaseReservedNodeOfferingRequest
- ReservedNodeOfferingNotFoundException
- Specified offering does not exist.ReservedNodeAlreadyExistsException
- User already has a reservation with the given identifier.ReservedNodeQuotaExceededException
- Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.UnsupportedOperationException
- The requested operation isn't supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default PurchaseReservedNodeOfferingResponse purchaseReservedNodeOffering(Consumer<PurchaseReservedNodeOfferingRequest.Builder> purchaseReservedNodeOfferingRequest) throws ReservedNodeOfferingNotFoundException, ReservedNodeAlreadyExistsException, ReservedNodeQuotaExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the PurchaseReservedNodeOfferingRequest.Builder
avoiding the need to create one manually via PurchaseReservedNodeOfferingRequest.builder()
purchaseReservedNodeOfferingRequest
- A Consumer
that will call methods on PurchaseReservedNodeOfferingMessage.Builder
to create
a request.ReservedNodeOfferingNotFoundException
- Specified offering does not exist.ReservedNodeAlreadyExistsException
- User already has a reservation with the given identifier.ReservedNodeQuotaExceededException
- Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.UnsupportedOperationException
- The requested operation isn't supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
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.
rebootClusterRequest
- InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RebootClusterResponse rebootCluster(Consumer<RebootClusterRequest.Builder> rebootClusterRequest) throws InvalidClusterStateException, ClusterNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster,
during which the cluster status is set to rebooting
. A cluster event is created when the reboot is
completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more
information about managing clusters, go to Amazon Redshift Clusters in
the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the RebootClusterRequest.Builder
avoiding the need to
create one manually via RebootClusterRequest.builder()
rebootClusterRequest
- A Consumer
that will call methods on RebootClusterMessage.Builder
to create a request.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
resetClusterParameterGroupRequest
- InvalidClusterParameterGroupStateException
- The cluster parameter group action can not be completed because another task is in progress that involves
the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResetClusterParameterGroupResponse resetClusterParameterGroup(Consumer<ResetClusterParameterGroupRequest.Builder> resetClusterParameterGroupRequest) throws InvalidClusterParameterGroupStateException, ClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.
This is a convenience which creates an instance of the ResetClusterParameterGroupRequest.Builder
avoiding
the need to create one manually via ResetClusterParameterGroupRequest.builder()
resetClusterParameterGroupRequest
- A Consumer
that will call methods on ResetClusterParameterGroupMessage.Builder
to create a
request.InvalidClusterParameterGroupStateException
- The cluster parameter group action can not be completed because another task is in progress that involves
the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, AwsServiceException, SdkClientException, RedshiftException
Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.
If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
restoreFromClusterSnapshotRequest
- AccessToSnapshotDeniedException
- The owner of the specified snapshot has not authorized your account to access the snapshot.ClusterAlreadyExistsException
- The account already has a cluster with the given identifier.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.ClusterQuotaExceededException
- The request would exceed the allowed number of cluster instances for this account. For information about
increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.InsufficientClusterCapacityException
- The number of nodes specified exceeds the allotted capacity of the cluster.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.InvalidRestoreException
- The restore is invalid.NumberOfNodesQuotaExceededException
- The operation would exceed the number of nodes allotted to the account. For information about increasing
your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException
- The operation would exceed the number of nodes allowed for a cluster.InvalidVpcNetworkStateException
- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException
- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException
- The Elastic IP (EIP) is invalid or cannot be found.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.LimitExceededException
- The encryption key has exceeded its grant limit in AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, AwsServiceException, SdkClientException, RedshiftException
Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.
If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the RestoreFromClusterSnapshotRequest.Builder
avoiding
the need to create one manually via RestoreFromClusterSnapshotRequest.builder()
restoreFromClusterSnapshotRequest
- A Consumer
that will call methods on RestoreFromClusterSnapshotMessage.Builder
to create a
request.AccessToSnapshotDeniedException
- The owner of the specified snapshot has not authorized your account to access the snapshot.ClusterAlreadyExistsException
- The account already has a cluster with the given identifier.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.ClusterQuotaExceededException
- The request would exceed the allowed number of cluster instances for this account. For information about
increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.InsufficientClusterCapacityException
- The number of nodes specified exceeds the allotted capacity of the cluster.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.InvalidRestoreException
- The restore is invalid.NumberOfNodesQuotaExceededException
- The operation would exceed the number of nodes allotted to the account. For information about increasing
your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException
- The operation would exceed the number of nodes allowed for a cluster.InvalidVpcNetworkStateException
- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException
- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException
- The Elastic IP (EIP) is invalid or cannot be found.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.LimitExceededException
- The encryption key has exceeded its grant limit in AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreTableFromClusterSnapshotResponse restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest) throws ClusterSnapshotNotFoundException, InProgressTableRestoreQuotaExceededException, InvalidClusterSnapshotStateException, InvalidTableRestoreArgumentException, ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.
You cannot use RestoreTableFromClusterSnapshot
to restore a table with the same name as an existing
table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored
table. If you want to replace your original table with a new, restored table, then rename or drop your original
table before you call RestoreTableFromClusterSnapshot
. When you have renamed your original table,
then you can pass the original name of the table as the NewTableName
parameter value in the call to
RestoreTableFromClusterSnapshot
. This way, you can replace the original table with the table created
from the snapshot.
restoreTableFromClusterSnapshotRequest
- ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.InProgressTableRestoreQuotaExceededException
- You have exceeded the allowed number of table restore requests. Wait for your current table restore
requests to complete before making a new request.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.InvalidTableRestoreArgumentException
- The value specified for the sourceDatabaseName
, sourceSchemaName
, or
sourceTableName
parameter, or a combination of these, doesn't exist in the snapshot.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidClusterStateException
- The specified cluster is not in the available
state.UnsupportedOperationException
- The requested operation isn't supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default RestoreTableFromClusterSnapshotResponse restoreTableFromClusterSnapshot(Consumer<RestoreTableFromClusterSnapshotRequest.Builder> restoreTableFromClusterSnapshotRequest) throws ClusterSnapshotNotFoundException, InProgressTableRestoreQuotaExceededException, InvalidClusterSnapshotStateException, InvalidTableRestoreArgumentException, ClusterNotFoundException, InvalidClusterStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, RedshiftException
Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.
You cannot use RestoreTableFromClusterSnapshot
to restore a table with the same name as an existing
table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored
table. If you want to replace your original table with a new, restored table, then rename or drop your original
table before you call RestoreTableFromClusterSnapshot
. When you have renamed your original table,
then you can pass the original name of the table as the NewTableName
parameter value in the call to
RestoreTableFromClusterSnapshot
. This way, you can replace the original table with the table created
from the snapshot.
This is a convenience which creates an instance of the RestoreTableFromClusterSnapshotRequest.Builder
avoiding the need to create one manually via RestoreTableFromClusterSnapshotRequest.builder()
restoreTableFromClusterSnapshotRequest
- A Consumer
that will call methods on RestoreTableFromClusterSnapshotMessage.Builder
to
create a request.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.InProgressTableRestoreQuotaExceededException
- You have exceeded the allowed number of table restore requests. Wait for your current table restore
requests to complete before making a new request.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.InvalidTableRestoreArgumentException
- The value specified for the sourceDatabaseName
, sourceSchemaName
, or
sourceTableName
parameter, or a combination of these, doesn't exist in the snapshot.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidClusterStateException
- The specified cluster is not in the available
state.UnsupportedOperationException
- The requested operation isn't supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
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.
revokeClusterSecurityGroupIngressRequest
- ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.AuthorizationNotFoundException
- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security
group.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RevokeClusterSecurityGroupIngressResponse revokeClusterSecurityGroupIngress(Consumer<RevokeClusterSecurityGroupIngressRequest.Builder> revokeClusterSecurityGroupIngressRequest) throws ClusterSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidClusterSecurityGroupStateException, AwsServiceException, SdkClientException, RedshiftException
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the RevokeClusterSecurityGroupIngressRequest.Builder
avoiding the need to create one manually via RevokeClusterSecurityGroupIngressRequest.builder()
revokeClusterSecurityGroupIngressRequest
- A Consumer
that will call methods on RevokeClusterSecurityGroupIngressMessage.Builder
to
create a request.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.AuthorizationNotFoundException
- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security
group.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RevokeSnapshotAccessResponse revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest) throws AccessToSnapshotDeniedException, AuthorizationNotFoundException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
revokeSnapshotAccessRequest
- AccessToSnapshotDeniedException
- The owner of the specified snapshot has not authorized your account to access the snapshot.AuthorizationNotFoundException
- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security
group.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RevokeSnapshotAccessResponse revokeSnapshotAccess(Consumer<RevokeSnapshotAccessRequest.Builder> revokeSnapshotAccessRequest) throws AccessToSnapshotDeniedException, AuthorizationNotFoundException, ClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RedshiftException
Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
This is a convenience which creates an instance of the RevokeSnapshotAccessRequest.Builder
avoiding the
need to create one manually via RevokeSnapshotAccessRequest.builder()
revokeSnapshotAccessRequest
- A Consumer
that will call methods on RevokeSnapshotAccessMessage.Builder
to create a
request.AccessToSnapshotDeniedException
- The owner of the specified snapshot has not authorized your account to access the snapshot.AuthorizationNotFoundException
- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security
group.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RotateEncryptionKeyResponse rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest) throws ClusterNotFoundException, InvalidClusterStateException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
Rotates the encryption keys for a cluster.
rotateEncryptionKeyRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidClusterStateException
- The specified cluster is not in the available
state.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RotateEncryptionKeyResponse rotateEncryptionKey(Consumer<RotateEncryptionKeyRequest.Builder> rotateEncryptionKeyRequest) throws ClusterNotFoundException, InvalidClusterStateException, DependentServiceRequestThrottlingException, AwsServiceException, SdkClientException, RedshiftException
Rotates the encryption keys for a cluster.
This is a convenience which creates an instance of the RotateEncryptionKeyRequest.Builder
avoiding the
need to create one manually via RotateEncryptionKeyRequest.builder()
rotateEncryptionKeyRequest
- A Consumer
that will call methods on RotateEncryptionKeyMessage.Builder
to create a
request.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidClusterStateException
- The specified cluster is not in the available
state.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RedshiftException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.