redshift/aws.sdk.kotlin.services.redshift

Package-level declarations

Types

Link copied to clipboard
interface RedshiftClient : SdkClient

Overview

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun RedshiftClient.acceptReservedNodeExchange(crossinline block: AcceptReservedNodeExchangeRequest.Builder.() -> Unit): AcceptReservedNodeExchangeResponse

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.

Link copied to clipboard
inline suspend fun RedshiftClient.addPartner(crossinline block: AddPartnerRequest.Builder.() -> Unit): AddPartnerResponse

Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website.

Link copied to clipboard
inline suspend fun RedshiftClient.associateDataShareConsumer(crossinline block: AssociateDataShareConsumerRequest.Builder.() -> Unit): AssociateDataShareConsumerResponse

From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.

Link copied to clipboard
inline suspend fun RedshiftClient.authorizeClusterSecurityGroupIngress(crossinline block: AuthorizeClusterSecurityGroupIngressRequest.Builder.() -> Unit): AuthorizeClusterSecurityGroupIngressResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.authorizeDataShare(crossinline block: AuthorizeDataShareRequest.Builder.() -> Unit): AuthorizeDataShareResponse

From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access permissions.

Link copied to clipboard
inline suspend fun RedshiftClient.authorizeEndpointAccess(crossinline block: AuthorizeEndpointAccessRequest.Builder.() -> Unit): AuthorizeEndpointAccessResponse

Grants access to a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.authorizeSnapshotAccess(crossinline block: AuthorizeSnapshotAccessRequest.Builder.() -> Unit): AuthorizeSnapshotAccessResponse

Authorizes the specified Amazon Web Services account to restore the specified snapshot.

Link copied to clipboard
inline suspend fun RedshiftClient.batchDeleteClusterSnapshots(crossinline block: BatchDeleteClusterSnapshotsRequest.Builder.() -> Unit): BatchDeleteClusterSnapshotsResponse

Deletes a set of cluster snapshots.

Link copied to clipboard
inline suspend fun RedshiftClient.batchModifyClusterSnapshots(crossinline block: BatchModifyClusterSnapshotsRequest.Builder.() -> Unit): BatchModifyClusterSnapshotsResponse

Modifies the settings for a set of cluster snapshots.

Link copied to clipboard
inline suspend fun RedshiftClient.cancelResize(crossinline block: CancelResizeRequest.Builder.() -> Unit): CancelResizeResponse

Cancels a resize operation for a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.copyClusterSnapshot(crossinline block: CopyClusterSnapshotRequest.Builder.() -> Unit): CopyClusterSnapshotResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.createAuthenticationProfile(crossinline block: CreateAuthenticationProfileRequest.Builder.() -> Unit): CreateAuthenticationProfileResponse

Creates an authentication profile with the specified parameters.

Link copied to clipboard
inline suspend fun RedshiftClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse

Creates a new cluster with the specified parameters.

Link copied to clipboard
inline suspend fun RedshiftClient.createClusterParameterGroup(crossinline block: CreateClusterParameterGroupRequest.Builder.() -> Unit): CreateClusterParameterGroupResponse

Creates an Amazon Redshift parameter group.

Link copied to clipboard
inline suspend fun RedshiftClient.createClusterSecurityGroup(crossinline block: CreateClusterSecurityGroupRequest.Builder.() -> Unit): CreateClusterSecurityGroupResponse

Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.

Link copied to clipboard
inline suspend fun RedshiftClient.createClusterSnapshot(crossinline block: CreateClusterSnapshotRequest.Builder.() -> Unit): CreateClusterSnapshotResponse

Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

Link copied to clipboard
inline suspend fun RedshiftClient.createClusterSubnetGroup(crossinline block: CreateClusterSubnetGroupRequest.Builder.() -> Unit): CreateClusterSubnetGroupResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.createCustomDomainAssociation(crossinline block: CreateCustomDomainAssociationRequest.Builder.() -> Unit): CreateCustomDomainAssociationResponse

Used to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the certificate Amazon Resource Name (ARN).

Link copied to clipboard
inline suspend fun RedshiftClient.createEndpointAccess(crossinline block: CreateEndpointAccessRequest.Builder.() -> Unit): CreateEndpointAccessResponse

Creates a Redshift-managed VPC endpoint.

Link copied to clipboard
inline suspend fun RedshiftClient.createEventSubscription(crossinline block: CreateEventSubscriptionRequest.Builder.() -> Unit): CreateEventSubscriptionResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.createHsmClientCertificate(crossinline block: CreateHsmClientCertificateRequest.Builder.() -> Unit): CreateHsmClientCertificateResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.createHsmConfiguration(crossinline block: CreateHsmConfigurationRequest.Builder.() -> Unit): CreateHsmConfigurationResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.createIntegration(crossinline block: CreateIntegrationRequest.Builder.() -> Unit): CreateIntegrationResponse

Creates a zero-ETL integration or S3 event integration with Amazon Redshift.

Link copied to clipboard
inline suspend fun RedshiftClient.createRedshiftIdcApplication(crossinline block: CreateRedshiftIdcApplicationRequest.Builder.() -> Unit): CreateRedshiftIdcApplicationResponse

Creates an Amazon Redshift application for use with IAM Identity Center.

Link copied to clipboard
inline suspend fun RedshiftClient.createScheduledAction(crossinline block: CreateScheduledActionRequest.Builder.() -> Unit): CreateScheduledActionResponse

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.

Link copied to clipboard
inline suspend fun RedshiftClient.createSnapshotCopyGrant(crossinline block: CreateSnapshotCopyGrantRequest.Builder.() -> Unit): CreateSnapshotCopyGrantResponse

Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region.

Link copied to clipboard
inline suspend fun RedshiftClient.createSnapshotSchedule(crossinline block: CreateSnapshotScheduleRequest.Builder.() -> Unit): CreateSnapshotScheduleResponse

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.

Link copied to clipboard
inline suspend fun RedshiftClient.createTags(crossinline block: CreateTagsRequest.Builder.() -> Unit): CreateTagsResponse

Adds tags to a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.createUsageLimit(crossinline block: CreateUsageLimitRequest.Builder.() -> Unit): CreateUsageLimitResponse

Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.

Link copied to clipboard
inline suspend fun RedshiftClient.deauthorizeDataShare(crossinline block: DeauthorizeDataShareRequest.Builder.() -> Unit): DeauthorizeDataShareResponse

From a datashare producer account, removes authorization from the specified datashare.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteAuthenticationProfile(crossinline block: DeleteAuthenticationProfileRequest.Builder.() -> Unit): DeleteAuthenticationProfileResponse

Deletes an authentication profile.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): DeleteClusterResponse

Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteClusterParameterGroup(crossinline block: DeleteClusterParameterGroupRequest.Builder.() -> Unit): DeleteClusterParameterGroupResponse

Deletes a specified Amazon Redshift parameter group.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteClusterSecurityGroup(crossinline block: DeleteClusterSecurityGroupRequest.Builder.() -> Unit): DeleteClusterSecurityGroupResponse

Deletes an Amazon Redshift security group.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteClusterSnapshot(crossinline block: DeleteClusterSnapshotRequest.Builder.() -> Unit): DeleteClusterSnapshotResponse

Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteClusterSubnetGroup(crossinline block: DeleteClusterSubnetGroupRequest.Builder.() -> Unit): DeleteClusterSubnetGroupResponse

Deletes the specified cluster subnet group.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteCustomDomainAssociation(crossinline block: DeleteCustomDomainAssociationRequest.Builder.() -> Unit): DeleteCustomDomainAssociationResponse

Contains information about deleting a custom domain association for a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteEndpointAccess(crossinline block: DeleteEndpointAccessRequest.Builder.() -> Unit): DeleteEndpointAccessResponse

Deletes a Redshift-managed VPC endpoint.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteEventSubscription(crossinline block: DeleteEventSubscriptionRequest.Builder.() -> Unit): DeleteEventSubscriptionResponse

Deletes an Amazon Redshift event notification subscription.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteHsmClientCertificate(crossinline block: DeleteHsmClientCertificateRequest.Builder.() -> Unit): DeleteHsmClientCertificateResponse

Deletes the specified HSM client certificate.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteHsmConfiguration(crossinline block: DeleteHsmConfigurationRequest.Builder.() -> Unit): DeleteHsmConfigurationResponse

Deletes the specified Amazon Redshift HSM configuration.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteIntegration(crossinline block: DeleteIntegrationRequest.Builder.() -> Unit): DeleteIntegrationResponse

Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.

Link copied to clipboard
inline suspend fun RedshiftClient.deletePartner(crossinline block: DeletePartnerRequest.Builder.() -> Unit): DeletePartnerResponse

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteRedshiftIdcApplication(crossinline block: DeleteRedshiftIdcApplicationRequest.Builder.() -> Unit): DeleteRedshiftIdcApplicationResponse

Deletes an Amazon Redshift IAM Identity Center application.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteResourcePolicy(crossinline block: DeleteResourcePolicyRequest.Builder.() -> Unit): DeleteResourcePolicyResponse

Deletes the resource policy for a specified resource.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteScheduledAction(crossinline block: DeleteScheduledActionRequest.Builder.() -> Unit): DeleteScheduledActionResponse

Deletes a scheduled action.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteSnapshotCopyGrant(crossinline block: DeleteSnapshotCopyGrantRequest.Builder.() -> Unit): DeleteSnapshotCopyGrantResponse

Deletes the specified snapshot copy grant.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteSnapshotSchedule(crossinline block: DeleteSnapshotScheduleRequest.Builder.() -> Unit): DeleteSnapshotScheduleResponse

Deletes a snapshot schedule.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteTags(crossinline block: DeleteTagsRequest.Builder.() -> Unit): DeleteTagsResponse

Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.

Link copied to clipboard
inline suspend fun RedshiftClient.deleteUsageLimit(crossinline block: DeleteUsageLimitRequest.Builder.() -> Unit): DeleteUsageLimitResponse

Deletes a usage limit from a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.deregisterNamespace(crossinline block: DeregisterNamespaceRequest.Builder.() -> Unit): DeregisterNamespaceResponse

Deregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog.

Link copied to clipboard
inline suspend fun RedshiftClient.describeAccountAttributes(crossinline block: DescribeAccountAttributesRequest.Builder.() -> Unit): DescribeAccountAttributesResponse

Returns a list of attributes attached to an account

Link copied to clipboard
inline suspend fun RedshiftClient.describeAuthenticationProfiles(crossinline block: DescribeAuthenticationProfilesRequest.Builder.() -> Unit): DescribeAuthenticationProfilesResponse

Describes an authentication profile.

Link copied to clipboard
inline suspend fun RedshiftClient.describeClusterDbRevisions(crossinline block: DescribeClusterDbRevisionsRequest.Builder.() -> Unit): DescribeClusterDbRevisionsResponse

Returns an array of ClusterDbRevision objects.

Link copied to clipboard
inline suspend fun RedshiftClient.describeClusterParameterGroups(crossinline block: DescribeClusterParameterGroupsRequest.Builder.() -> Unit): DescribeClusterParameterGroupsResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeClusterParameters(crossinline block: DescribeClusterParametersRequest.Builder.() -> Unit): DescribeClusterParametersResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeClusters(crossinline block: DescribeClustersRequest.Builder.() -> Unit): DescribeClustersResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeClusterSecurityGroups(crossinline block: DescribeClusterSecurityGroupsRequest.Builder.() -> Unit): DescribeClusterSecurityGroupsResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeClusterSnapshots(crossinline block: DescribeClusterSnapshotsRequest.Builder.() -> Unit): DescribeClusterSnapshotsResponse

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.

Link copied to clipboard
inline suspend fun RedshiftClient.describeClusterSubnetGroups(crossinline block: DescribeClusterSubnetGroupsRequest.Builder.() -> Unit): DescribeClusterSubnetGroupsResponse

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.

Link copied to clipboard
inline suspend fun RedshiftClient.describeClusterTracks(crossinline block: DescribeClusterTracksRequest.Builder.() -> Unit): DescribeClusterTracksResponse

Returns a list of all the available maintenance tracks.

Link copied to clipboard
inline suspend fun RedshiftClient.describeClusterVersions(crossinline block: DescribeClusterVersionsRequest.Builder.() -> Unit): DescribeClusterVersionsResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeCustomDomainAssociations(crossinline block: DescribeCustomDomainAssociationsRequest.Builder.() -> Unit): DescribeCustomDomainAssociationsResponse

Contains information about custom domain associations for a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.describeDataShares(crossinline block: DescribeDataSharesRequest.Builder.() -> Unit): DescribeDataSharesResponse

Shows the status of any inbound or outbound datashares available in the specified account.

Link copied to clipboard
inline suspend fun RedshiftClient.describeDataSharesForConsumer(crossinline block: DescribeDataSharesForConsumerRequest.Builder.() -> Unit): DescribeDataSharesForConsumerResponse

Returns a list of datashares where the account identifier being called is a consumer account identifier.

Link copied to clipboard
inline suspend fun RedshiftClient.describeDataSharesForProducer(crossinline block: DescribeDataSharesForProducerRequest.Builder.() -> Unit): DescribeDataSharesForProducerResponse

Returns a list of datashares when the account identifier being called is a producer account identifier.

Link copied to clipboard
inline suspend fun RedshiftClient.describeDefaultClusterParameters(crossinline block: DescribeDefaultClusterParametersRequest.Builder.() -> Unit): DescribeDefaultClusterParametersResponse

Returns a list of parameter settings for the specified parameter group family.

Link copied to clipboard
inline suspend fun RedshiftClient.describeEndpointAccess(crossinline block: DescribeEndpointAccessRequest.Builder.() -> Unit): DescribeEndpointAccessResponse

Describes a Redshift-managed VPC endpoint.

Link copied to clipboard
inline suspend fun RedshiftClient.describeEndpointAuthorization(crossinline block: DescribeEndpointAuthorizationRequest.Builder.() -> Unit): DescribeEndpointAuthorizationResponse

Describes an endpoint authorization.

Link copied to clipboard
inline suspend fun RedshiftClient.describeEventCategories(crossinline block: DescribeEventCategoriesRequest.Builder.() -> Unit): DescribeEventCategoriesResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeEvents(crossinline block: DescribeEventsRequest.Builder.() -> Unit): DescribeEventsResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeEventSubscriptions(crossinline block: DescribeEventSubscriptionsRequest.Builder.() -> Unit): DescribeEventSubscriptionsResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeHsmClientCertificates(crossinline block: DescribeHsmClientCertificatesRequest.Builder.() -> Unit): DescribeHsmClientCertificatesResponse

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.

Link copied to clipboard
inline suspend fun RedshiftClient.describeHsmConfigurations(crossinline block: DescribeHsmConfigurationsRequest.Builder.() -> Unit): DescribeHsmConfigurationsResponse

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.

Link copied to clipboard
inline suspend fun RedshiftClient.describeInboundIntegrations(crossinline block: DescribeInboundIntegrationsRequest.Builder.() -> Unit): DescribeInboundIntegrationsResponse

Returns a list of inbound integrations.

Link copied to clipboard
inline suspend fun RedshiftClient.describeIntegrations(crossinline block: DescribeIntegrationsRequest.Builder.() -> Unit): DescribeIntegrationsResponse

Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.

Link copied to clipboard
inline suspend fun RedshiftClient.describeLoggingStatus(crossinline block: DescribeLoggingStatusRequest.Builder.() -> Unit): DescribeLoggingStatusResponse

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.describeNodeConfigurationOptions(crossinline block: DescribeNodeConfigurationOptionsRequest.Builder.() -> Unit): DescribeNodeConfigurationOptionsResponse

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

Link copied to clipboard
inline suspend fun RedshiftClient.describeOrderableClusterOptions(crossinline block: DescribeOrderableClusterOptionsRequest.Builder.() -> Unit): DescribeOrderableClusterOptionsResponse

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Link copied to clipboard
inline suspend fun RedshiftClient.describePartners(crossinline block: DescribePartnersRequest.Builder.() -> Unit): DescribePartnersResponse

Returns information about the partner integrations defined for a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.describeRedshiftIdcApplications(crossinline block: DescribeRedshiftIdcApplicationsRequest.Builder.() -> Unit): DescribeRedshiftIdcApplicationsResponse

Lists the Amazon Redshift IAM Identity Center applications.

Link copied to clipboard
inline suspend fun RedshiftClient.describeReservedNodeExchangeStatus(crossinline block: DescribeReservedNodeExchangeStatusRequest.Builder.() -> Unit): DescribeReservedNodeExchangeStatusResponse

Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.

Link copied to clipboard
inline suspend fun RedshiftClient.describeReservedNodeOfferings(crossinline block: DescribeReservedNodeOfferingsRequest.Builder.() -> Unit): DescribeReservedNodeOfferingsResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeReservedNodes(crossinline block: DescribeReservedNodesRequest.Builder.() -> Unit): DescribeReservedNodesResponse

Returns the descriptions of the reserved nodes.

Link copied to clipboard
inline suspend fun RedshiftClient.describeResize(crossinline block: DescribeResizeRequest.Builder.() -> Unit): DescribeResizeResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeScheduledActions(crossinline block: DescribeScheduledActionsRequest.Builder.() -> Unit): DescribeScheduledActionsResponse

Describes properties of scheduled actions.

Link copied to clipboard
inline suspend fun RedshiftClient.describeSnapshotCopyGrants(crossinline block: DescribeSnapshotCopyGrantsRequest.Builder.() -> Unit): DescribeSnapshotCopyGrantsResponse

Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.

Link copied to clipboard
inline suspend fun RedshiftClient.describeSnapshotSchedules(crossinline block: DescribeSnapshotSchedulesRequest.Builder.() -> Unit): DescribeSnapshotSchedulesResponse

Returns a list of snapshot schedules.

Link copied to clipboard
inline suspend fun RedshiftClient.describeStorage(crossinline block: DescribeStorageRequest.Builder.() -> Unit): DescribeStorageResponse

Returns account level backups storage size and provisional storage.

Link copied to clipboard
inline suspend fun RedshiftClient.describeTableRestoreStatus(crossinline block: DescribeTableRestoreStatusRequest.Builder.() -> Unit): DescribeTableRestoreStatusResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeTags(crossinline block: DescribeTagsRequest.Builder.() -> Unit): DescribeTagsResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.describeUsageLimits(crossinline block: DescribeUsageLimitsRequest.Builder.() -> Unit): DescribeUsageLimitsResponse

Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:

Link copied to clipboard
inline suspend fun RedshiftClient.disableLogging(crossinline block: DisableLoggingRequest.Builder.() -> Unit): DisableLoggingResponse

Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.disableSnapshotCopy(crossinline block: DisableSnapshotCopyRequest.Builder.() -> Unit): DisableSnapshotCopyResponse

Disables the automatic copying of snapshots from one region to another region for a specified cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.disassociateDataShareConsumer(crossinline block: DisassociateDataShareConsumerRequest.Builder.() -> Unit): DisassociateDataShareConsumerResponse

From a datashare consumer account, remove association for the specified datashare.

Link copied to clipboard
inline suspend fun RedshiftClient.enableLogging(crossinline block: EnableLoggingRequest.Builder.() -> Unit): EnableLoggingResponse

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.enableSnapshotCopy(crossinline block: EnableSnapshotCopyRequest.Builder.() -> Unit): EnableSnapshotCopyResponse

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.failoverPrimaryCompute(crossinline block: FailoverPrimaryComputeRequest.Builder.() -> Unit): FailoverPrimaryComputeResponse

Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.

Link copied to clipboard
inline suspend fun RedshiftClient.getClusterCredentials(crossinline block: GetClusterCredentialsRequest.Builder.() -> Unit): GetClusterCredentialsResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.getClusterCredentialsWithIam(crossinline block: GetClusterCredentialsWithIamRequest.Builder.() -> Unit): GetClusterCredentialsWithIamResponse

Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity. For more information about IAM identities, see IAM Identities (users, user groups, and roles) in the Amazon Web Services Identity and Access Management User Guide.

inline suspend fun RedshiftClient.getReservedNodeExchangeConfigurationOptions(crossinline block: GetReservedNodeExchangeConfigurationOptionsRequest.Builder.() -> Unit): GetReservedNodeExchangeConfigurationOptionsResponse

Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type.

Link copied to clipboard
inline suspend fun RedshiftClient.getReservedNodeExchangeOfferings(crossinline block: GetReservedNodeExchangeOfferingsRequest.Builder.() -> Unit): GetReservedNodeExchangeOfferingsResponse

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.

Link copied to clipboard
inline suspend fun RedshiftClient.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

Get the resource policy for a specified resource.

Link copied to clipboard
inline suspend fun RedshiftClient.listRecommendations(crossinline block: ListRecommendationsRequest.Builder.() -> Unit): ListRecommendationsResponse

List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyAquaConfiguration(crossinline block: ModifyAquaConfigurationRequest.Builder.() -> Unit): ModifyAquaConfigurationResponse

This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Link copied to clipboard
inline suspend fun RedshiftClient.modifyAuthenticationProfile(crossinline block: ModifyAuthenticationProfileRequest.Builder.() -> Unit): ModifyAuthenticationProfileResponse

Modifies an authentication profile.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyCluster(crossinline block: ModifyClusterRequest.Builder.() -> Unit): ModifyClusterResponse

Modifies the settings for a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyClusterDbRevision(crossinline block: ModifyClusterDbRevisionRequest.Builder.() -> Unit): ModifyClusterDbRevisionResponse

Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyClusterIamRoles(crossinline block: ModifyClusterIamRolesRequest.Builder.() -> Unit): ModifyClusterIamRolesResponse

Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyClusterMaintenance(crossinline block: ModifyClusterMaintenanceRequest.Builder.() -> Unit): ModifyClusterMaintenanceResponse

Modifies the maintenance settings of a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyClusterParameterGroup(crossinline block: ModifyClusterParameterGroupRequest.Builder.() -> Unit): ModifyClusterParameterGroupResponse

Modifies the parameters of a parameter group. For the parameters parameter, it can't contain ASCII characters.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyClusterSnapshot(crossinline block: ModifyClusterSnapshotRequest.Builder.() -> Unit): ModifyClusterSnapshotResponse

Modifies the settings for a snapshot.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyClusterSnapshotSchedule(crossinline block: ModifyClusterSnapshotScheduleRequest.Builder.() -> Unit): ModifyClusterSnapshotScheduleResponse

Modifies a snapshot schedule for a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyClusterSubnetGroup(crossinline block: ModifyClusterSubnetGroupRequest.Builder.() -> Unit): ModifyClusterSubnetGroupResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyCustomDomainAssociation(crossinline block: ModifyCustomDomainAssociationRequest.Builder.() -> Unit): ModifyCustomDomainAssociationResponse

Contains information for changing a custom domain association.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyEndpointAccess(crossinline block: ModifyEndpointAccessRequest.Builder.() -> Unit): ModifyEndpointAccessResponse

Modifies a Redshift-managed VPC endpoint.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyEventSubscription(crossinline block: ModifyEventSubscriptionRequest.Builder.() -> Unit): ModifyEventSubscriptionResponse

Modifies an existing Amazon Redshift event notification subscription.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyIntegration(crossinline block: ModifyIntegrationRequest.Builder.() -> Unit): ModifyIntegrationResponse

Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyRedshiftIdcApplication(crossinline block: ModifyRedshiftIdcApplicationRequest.Builder.() -> Unit): ModifyRedshiftIdcApplicationResponse

Changes an existing Amazon Redshift IAM Identity Center application.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyScheduledAction(crossinline block: ModifyScheduledActionRequest.Builder.() -> Unit): ModifyScheduledActionResponse

Modifies a scheduled action.

Link copied to clipboard
inline suspend fun RedshiftClient.modifySnapshotCopyRetentionPeriod(crossinline block: ModifySnapshotCopyRetentionPeriodRequest.Builder.() -> Unit): ModifySnapshotCopyRetentionPeriodResponse

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

Link copied to clipboard
inline suspend fun RedshiftClient.modifySnapshotSchedule(crossinline block: ModifySnapshotScheduleRequest.Builder.() -> Unit): ModifySnapshotScheduleResponse

Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.

Link copied to clipboard
inline suspend fun RedshiftClient.modifyUsageLimit(crossinline block: ModifyUsageLimitRequest.Builder.() -> Unit): ModifyUsageLimitResponse

Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.

Link copied to clipboard
inline suspend fun RedshiftClient.pauseCluster(crossinline block: PauseClusterRequest.Builder.() -> Unit): PauseClusterResponse

Pauses a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.purchaseReservedNodeOffering(crossinline block: PurchaseReservedNodeOfferingRequest.Builder.() -> Unit): PurchaseReservedNodeOfferingResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.putResourcePolicy(crossinline block: PutResourcePolicyRequest.Builder.() -> Unit): PutResourcePolicyResponse

Updates the resource policy for a specified resource.

Link copied to clipboard
inline suspend fun RedshiftClient.rebootCluster(crossinline block: RebootClusterRequest.Builder.() -> Unit): RebootClusterResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.registerNamespace(crossinline block: RegisterNamespaceRequest.Builder.() -> Unit): RegisterNamespaceResponse

Registers a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.

Link copied to clipboard
inline suspend fun RedshiftClient.rejectDataShare(crossinline block: RejectDataShareRequest.Builder.() -> Unit): RejectDataShareResponse

From a datashare consumer account, rejects the specified datashare.

Link copied to clipboard
inline suspend fun RedshiftClient.resetClusterParameterGroup(crossinline block: ResetClusterParameterGroupRequest.Builder.() -> Unit): ResetClusterParameterGroupResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.resizeCluster(crossinline block: ResizeClusterRequest.Builder.() -> Unit): ResizeClusterResponse

Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.

Link copied to clipboard
inline suspend fun RedshiftClient.restoreFromClusterSnapshot(crossinline block: RestoreFromClusterSnapshotRequest.Builder.() -> Unit): RestoreFromClusterSnapshotResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.restoreTableFromClusterSnapshot(crossinline block: RestoreTableFromClusterSnapshotRequest.Builder.() -> Unit): RestoreTableFromClusterSnapshotResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.resumeCluster(crossinline block: ResumeClusterRequest.Builder.() -> Unit): ResumeClusterResponse

Resumes a paused cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.revokeClusterSecurityGroupIngress(crossinline block: RevokeClusterSecurityGroupIngressRequest.Builder.() -> Unit): RevokeClusterSecurityGroupIngressResponse

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.

Link copied to clipboard
inline suspend fun RedshiftClient.revokeEndpointAccess(crossinline block: RevokeEndpointAccessRequest.Builder.() -> Unit): RevokeEndpointAccessResponse

Revokes access to a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.revokeSnapshotAccess(crossinline block: RevokeSnapshotAccessRequest.Builder.() -> Unit): RevokeSnapshotAccessResponse

Removes the ability of the specified Amazon Web Services account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.

Link copied to clipboard
inline suspend fun RedshiftClient.rotateEncryptionKey(crossinline block: RotateEncryptionKeyRequest.Builder.() -> Unit): RotateEncryptionKeyResponse

Rotates the encryption keys for a cluster.

Link copied to clipboard
inline suspend fun RedshiftClient.updatePartnerStatus(crossinline block: UpdatePartnerStatusRequest.Builder.() -> Unit): UpdatePartnerStatusResponse

Updates the status of a partner integration.

Link copied to clipboard
fun RedshiftClient.withConfig(block: RedshiftClient.Config.Builder.() -> Unit): RedshiftClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.