@aws-sdk/client-redshift 3.670.0 → 3.672.0

package/dist-types/models/models_1.d.ts

@@ -1,6 +1,411 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { ActionType, AquaConfiguration, AquaConfigurationStatus, AuthorizedTokenIssuer, AvailabilityZone, Cluster, ClusterSecurityGroup, ClusterSubnetGroup, DataShare, DataShareStatusForConsumer, DataShareStatusForProducer, DefaultClusterParameters, EndpointAccess, EndpointAuthorization, EventSubscription, HsmClientCertificate, HsmConfiguration, Parameter, RecurringCharge, RedshiftIdcApplication, ReservedNode, ReservedNodeExchangeStatus, ReservedNodeOfferingType, ScheduledAction, ScheduledActionType, ServiceIntegrationsUnion, Snapshot, SnapshotCopyGrant, SnapshotSchedule, Tag, UsageLimit, UsageLimitBreachAction, UsageLimitFeatureType } from "./models_0";
+import { ActionType, AquaConfiguration, AquaConfigurationStatus, AuthorizedTokenIssuer, AvailabilityZone, Cluster, ClusterSecurityGroup, ClusterSubnetGroup, DataShare, DataShareStatusForConsumer, DataShareStatusForProducer, DefaultClusterParameters, EndpointAccess, EndpointAuthorization, EventSubscription, HsmClientCertificate, HsmConfiguration, Integration, IntegrationError, Parameter, RecurringCharge, RedshiftIdcApplication, ReservedNode, ReservedNodeExchangeStatus, ReservedNodeOfferingType, ScheduledAction, ScheduledActionType, ServiceIntegrationsUnion, Snapshot, SnapshotCopyGrant, SnapshotSchedule, Tag, UsageLimit, UsageLimitBreachAction, UsageLimitFeatureType, ZeroETLIntegrationStatus } from "./models_0";
 import { RedshiftServiceException as __BaseException } from "./RedshiftServiceException";
+/**
+ * <p></p>
+ * @public
+ */
+export interface DescribeClusterSecurityGroupsMessage {
+    /**
+     * <p>The name of a cluster security group for which you are requesting details. You must
+     *             specify either the <b>Marker</b> parameter or a <b>ClusterSecurityGroupName</b> parameter, but not both. </p>
+     *          <p> Example: <code>securitygroup1</code>
+     *          </p>
+     * @public
+     */
+    ClusterSecurityGroupName?: string;
+    /**
+     * <p>The maximum number of response records to return in each call. If the number of
+     *             remaining response records exceeds the specified <code>MaxRecords</code> value, a value
+     *             is returned in a <code>marker</code> field of the response. You can retrieve the next
+     *             set of records by retrying the command with the returned marker value. </p>
+     *          <p>Default: <code>100</code>
+     *          </p>
+     *          <p>Constraints: minimum 20, maximum 100.</p>
+     * @public
+     */
+    MaxRecords?: number;
+    /**
+     * <p>An optional parameter that specifies the starting point to return a set of response
+     *             records. When the results of a <a>DescribeClusterSecurityGroups</a> request
+     *             exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
+     *                 <code>Marker</code> field of the response. You can retrieve the next set of response
+     *             records by providing the returned marker value in the <code>Marker</code> parameter and
+     *             retrying the request. </p>
+     *          <p>Constraints: You must specify either the <b>ClusterSecurityGroupName</b> parameter or the <b>Marker</b> parameter, but not both. </p>
+     * @public
+     */
+    Marker?: string;
+    /**
+     * <p>A tag key or keys for which you want to return all matching cluster security groups
+     *             that are associated with the specified key or keys. For example, suppose that you have
+     *             security groups that are tagged with keys called <code>owner</code> and
+     *                 <code>environment</code>. If you specify both of these tag keys in the request,
+     *             Amazon Redshift returns a response with the security groups that have either or both of these
+     *             tag keys associated with them.</p>
+     * @public
+     */
+    TagKeys?: string[];
+    /**
+     * <p>A tag value or values for which you want to return all matching cluster security
+     *             groups that are associated with the specified tag value or values. For example, suppose
+     *             that you have security groups that are tagged with values called <code>admin</code> and
+     *                 <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift
+     *             returns a response with the security groups that have either or both of these tag values
+     *             associated with them.</p>
+     * @public
+     */
+    TagValues?: string[];
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SnapshotAttributeToSortBy: {
+    readonly CREATE_TIME: "CREATE_TIME";
+    readonly SOURCE_TYPE: "SOURCE_TYPE";
+    readonly TOTAL_SIZE: "TOTAL_SIZE";
+};
+/**
+ * @public
+ */
+export type SnapshotAttributeToSortBy = (typeof SnapshotAttributeToSortBy)[keyof typeof SnapshotAttributeToSortBy];
+/**
+ * @public
+ * @enum
+ */
+export declare const SortByOrder: {
+    readonly ASCENDING: "ASC";
+    readonly DESCENDING: "DESC";
+};
+/**
+ * @public
+ */
+export type SortByOrder = (typeof SortByOrder)[keyof typeof SortByOrder];
+/**
+ * <p>Describes a sorting entity</p>
+ * @public
+ */
+export interface SnapshotSortingEntity {
+    /**
+     * <p>The category for sorting the snapshots.</p>
+     * @public
+     */
+    Attribute: SnapshotAttributeToSortBy | undefined;
+    /**
+     * <p>The order for listing the attributes.</p>
+     * @public
+     */
+    SortOrder?: SortByOrder;
+}
+/**
+ * <p></p>
+ * @public
+ */
+export interface DescribeClusterSnapshotsMessage {
+    /**
+     * <p>The identifier of the cluster which generated the requested snapshots.</p>
+     * @public
+     */
+    ClusterIdentifier?: string;
+    /**
+     * <p>The snapshot identifier of the snapshot about which to return
+     *             information.</p>
+     * @public
+     */
+    SnapshotIdentifier?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.</p>
+     * @public
+     */
+    SnapshotArn?: string;
+    /**
+     * <p>The type of snapshots for which you are requesting information. By default,
+     *             snapshots of all types are returned.</p>
+     *          <p>Valid Values: <code>automated</code> | <code>manual</code>
+     *          </p>
+     * @public
+     */
+    SnapshotType?: string;
+    /**
+     * <p>A value that requests only snapshots created at or after the specified time. The
+     *             time value is specified in ISO 8601 format. For more information about ISO 8601, go to
+     *             the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a>
+     *          </p>
+     *          <p>Example: <code>2012-07-16T18:00:00Z</code>
+     *          </p>
+     * @public
+     */
+    StartTime?: Date;
+    /**
+     * <p>A time value that requests only snapshots created at or before the specified time.
+     *             The time value is specified in ISO 8601 format. For more information about ISO 8601, go
+     *             to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia
+     *                 page.</a>
+     *          </p>
+     *          <p>Example: <code>2012-07-16T18:00:00Z</code>
+     *          </p>
+     * @public
+     */
+    EndTime?: Date;
+    /**
+     * <p>The maximum number of response records to return in each call. If the number of
+     *             remaining response records exceeds the specified <code>MaxRecords</code> value, a value
+     *             is returned in a <code>marker</code> field of the response. You can retrieve the next
+     *             set of records by retrying the command with the returned marker value. </p>
+     *          <p>Default: <code>100</code>
+     *          </p>
+     *          <p>Constraints: minimum 20, maximum 100.</p>
+     * @public
+     */
+    MaxRecords?: number;
+    /**
+     * <p>An optional parameter that specifies the starting point to return a set of response
+     *             records. When the results of a <a>DescribeClusterSnapshots</a> request exceed
+     *             the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
+     *                 <code>Marker</code> field of the response. You can retrieve the next set of response
+     *             records by providing the returned marker value in the <code>Marker</code> parameter and
+     *             retrying the request. </p>
+     * @public
+     */
+    Marker?: string;
+    /**
+     * <p>The Amazon Web Services account used to create or copy the snapshot. Use this field to
+     *             filter the results to snapshots owned by a particular account. To describe snapshots you
+     *             own, either specify your Amazon Web Services account, or do not specify the
+     *             parameter.</p>
+     * @public
+     */
+    OwnerAccount?: string;
+    /**
+     * <p>A tag key or keys for which you want to return all matching cluster snapshots that
+     *             are associated with the specified key or keys. For example, suppose that you have
+     *             snapshots that are tagged with keys called <code>owner</code> and
+     *                 <code>environment</code>. If you specify both of these tag keys in the request,
+     *             Amazon Redshift returns a response with the snapshots that have either or both of these tag
+     *             keys associated with them.</p>
+     * @public
+     */
+    TagKeys?: string[];
+    /**
+     * <p>A tag value or values for which you want to return all matching cluster snapshots
+     *             that are associated with the specified tag value or values. For example, suppose that
+     *             you have snapshots that are tagged with values called <code>admin</code> and
+     *                 <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift
+     *             returns a response with the snapshots that have either or both of these tag values
+     *             associated with them.</p>
+     * @public
+     */
+    TagValues?: string[];
+    /**
+     * <p>A value that indicates whether to return snapshots only for an existing cluster.
+     *             You can perform table-level restore only by using a snapshot of an existing cluster,
+     *             that is, a cluster that has not been deleted. Values for this parameter work as follows: </p>
+     *          <ul>
+     *             <li>
+     *                <p>If <code>ClusterExists</code> is set to <code>true</code>,
+     *                         <code>ClusterIdentifier</code> is required.</p>
+     *             </li>
+     *             <li>
+     *                <p>If <code>ClusterExists</code> is set to <code>false</code> and
+     *                         <code>ClusterIdentifier</code> isn't specified, all snapshots
+     *                     associated with deleted clusters (orphaned snapshots) are returned. </p>
+     *             </li>
+     *             <li>
+     *                <p>If <code>ClusterExists</code> is set to <code>false</code> and
+     *                         <code>ClusterIdentifier</code> is specified for a deleted cluster, snapshots
+     *                     associated with that cluster are returned.</p>
+     *             </li>
+     *             <li>
+     *                <p>If <code>ClusterExists</code> is set to <code>false</code> and
+     *                         <code>ClusterIdentifier</code> is specified for an existing cluster, no
+     *                     snapshots are returned. </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    ClusterExists?: boolean;
+    /**
+     * <p></p>
+     * @public
+     */
+    SortingEntities?: SnapshotSortingEntity[];
+}
+/**
+ * <p>Contains the output from the <a>DescribeClusterSnapshots</a> action.
+ *         </p>
+ * @public
+ */
+export interface SnapshotMessage {
+    /**
+     * <p>A value that indicates the starting point for the next set of response records in a
+     *             subsequent request. If a value is returned in a response, you can retrieve the next set
+     *             of records by providing this returned marker value in the <code>Marker</code> parameter
+     *             and retrying the command. If the <code>Marker</code> field is empty, all response
+     *             records have been retrieved for the request. </p>
+     * @public
+     */
+    Marker?: string;
+    /**
+     * <p>A list of <a>Snapshot</a> instances. </p>
+     * @public
+     */
+    Snapshots?: Snapshot[];
+}
+/**
+ * <p></p>
+ * @public
+ */
+export interface DescribeClusterSubnetGroupsMessage {
+    /**
+     * <p>The name of the cluster subnet group for which information is requested.</p>
+     * @public
+     */
+    ClusterSubnetGroupName?: string;
+    /**
+     * <p>The maximum number of response records to return in each call. If the number of
+     *             remaining response records exceeds the specified <code>MaxRecords</code> value, a value
+     *             is returned in a <code>marker</code> field of the response. You can retrieve the next
+     *             set of records by retrying the command with the returned marker value. </p>
+     *          <p>Default: <code>100</code>
+     *          </p>
+     *          <p>Constraints: minimum 20, maximum 100.</p>
+     * @public
+     */
+    MaxRecords?: number;
+    /**
+     * <p>An optional parameter that specifies the starting point to return a set of response
+     *             records. When the results of a <a>DescribeClusterSubnetGroups</a> request
+     *             exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
+     *                 <code>Marker</code> field of the response. You can retrieve the next set of response
+     *             records by providing the returned marker value in the <code>Marker</code> parameter and
+     *             retrying the request. </p>
+     * @public
+     */
+    Marker?: string;
+    /**
+     * <p>A tag key or keys for which you want to return all matching cluster subnet groups
+     *             that are associated with the specified key or keys. For example, suppose that you have
+     *             subnet groups that are tagged with keys called <code>owner</code> and
+     *                 <code>environment</code>. If you specify both of these tag keys in the request,
+     *             Amazon Redshift returns a response with the subnet groups that have either or both of these
+     *             tag keys associated with them.</p>
+     * @public
+     */
+    TagKeys?: string[];
+    /**
+     * <p>A tag value or values for which you want to return all matching cluster subnet
+     *             groups that are associated with the specified tag value or values. For example, suppose
+     *             that you have subnet groups that are tagged with values called <code>admin</code> and
+     *                 <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift
+     *             returns a response with the subnet groups that have either or both of these tag values
+     *             associated with them.</p>
+     * @public
+     */
+    TagValues?: string[];
+}
+/**
+ * @public
+ */
+export interface DescribeClusterTracksMessage {
+    /**
+     * <p>The name of the maintenance track. </p>
+     * @public
+     */
+    MaintenanceTrackName?: string;
+    /**
+     * <p>An integer value for the maximum number of maintenance tracks to return.</p>
+     * @public
+     */
+    MaxRecords?: number;
+    /**
+     * <p>An optional parameter that specifies the starting point to return a set of response
+     *             records. When the results of a <code>DescribeClusterTracks</code> request exceed the
+     *             value specified in <code>MaxRecords</code>, Amazon Redshift returns a value in the
+     *                 <code>Marker</code> field of the response. You can retrieve the next set of response
+     *             records by providing the returned marker value in the <code>Marker</code> parameter and
+     *             retrying the request. </p>
+     * @public
+     */
+    Marker?: string;
+}
+/**
+ * <p>Describes the operations that are allowed on a maintenance track.</p>
+ * @public
+ */
+export interface SupportedOperation {
+    /**
+     * <p>A list of the supported operations.</p>
+     * @public
+     */
+    OperationName?: string;
+}
+/**
+ * <p>A maintenance track that you can switch the current track to.</p>
+ * @public
+ */
+export interface UpdateTarget {
+    /**
+     * <p>The name of the new maintenance track.</p>
+     * @public
+     */
+    MaintenanceTrackName?: string;
+    /**
+     * <p>The cluster version for the new maintenance track.</p>
+     * @public
+     */
+    DatabaseVersion?: string;
+    /**
+     * <p>A list of operations supported by the maintenance track.</p>
+     * @public
+     */
+    SupportedOperations?: SupportedOperation[];
+}
+/**
+ * <p>Defines a maintenance track that determines which Amazon Redshift version to apply
+ *             during a maintenance window. If the value for <code>MaintenanceTrack</code> is
+ *                 <code>current</code>, the cluster is updated to the most recently certified
+ *             maintenance release. If the value is <code>trailing</code>, the cluster is updated to
+ *             the previously certified maintenance release. </p>
+ * @public
+ */
+export interface MaintenanceTrack {
+    /**
+     * <p>The name of the maintenance track. Possible values are <code>current</code> and
+     *                 <code>trailing</code>.</p>
+     * @public
+     */
+    MaintenanceTrackName?: string;
+    /**
+     * <p>The version number for the cluster release.</p>
+     * @public
+     */
+    DatabaseVersion?: string;
+    /**
+     * <p>An array of <a>UpdateTarget</a> objects to update with the maintenance
+     *             track. </p>
+     * @public
+     */
+    UpdateTargets?: UpdateTarget[];
+}
+/**
+ * @public
+ */
+export interface TrackListMessage {
+    /**
+     * <p>A list of maintenance tracks output by the <code>DescribeClusterTracks</code>
+     *             operation. </p>
+     * @public
+     */
+    MaintenanceTracks?: MaintenanceTrack[];
+    /**
+     * <p>The starting point to return a set of response tracklist records. You can retrieve the
+     *             next set of response records by providing the returned marker value in the
+     *                 <code>Marker</code> parameter and retrying the request.</p>
+     * @public
+     */
+    Marker?: string;
+}
 /**
  * <p></p>
  * @public
@@ -895,39 +1300,6 @@ export interface DescribeInboundIntegrationsMessage {
      */
     Marker?: string;
 }
-/**
- * <p>The error of an inbound integration.</p>
- * @public
- */
-export interface IntegrationError {
-    /**
-     * <p>The error code of an inbound integration error.</p>
-     * @public
-     */
-    ErrorCode: string | undefined;
-    /**
-     * <p>The error message of an inbound integration error.</p>
-     * @public
-     */
-    ErrorMessage?: string;
-}
-/**
- * @public
- * @enum
- */
-export declare const ZeroETLIntegrationStatus: {
-    readonly ACTIVE: "active";
-    readonly CREATING: "creating";
-    readonly DELETING: "deleting";
-    readonly FAILED: "failed";
-    readonly MODIFYING: "modifying";
-    readonly NEEDS_ATTENTION: "needs_attention";
-    readonly SYNCING: "syncing";
-};
-/**
- * @public
- */
-export type ZeroETLIntegrationStatus = (typeof ZeroETLIntegrationStatus)[keyof typeof ZeroETLIntegrationStatus];
 /**
  * <p>The content of an inbound integration.</p>
  * @public
@@ -984,16 +1356,84 @@ export interface InboundIntegrationsMessage {
     InboundIntegrations?: InboundIntegration[];
 }
 /**
- * <p>The integration can't be found.</p>
  * @public
+ * @enum
  */
-export declare class IntegrationNotFoundFault extends __BaseException {
-    readonly name: "IntegrationNotFoundFault";
-    readonly $fault: "client";
+export declare const DescribeIntegrationsFilterName: {
+    readonly INTEGRATION_ARN: "integration-arn";
+    readonly SOURCE_ARN: "source-arn";
+    readonly SOURCE_TYPES: "source-types";
+    readonly STATUS: "status";
+};
+/**
+ * @public
+ */
+export type DescribeIntegrationsFilterName = (typeof DescribeIntegrationsFilterName)[keyof typeof DescribeIntegrationsFilterName];
+/**
+ * <p>A set of elements to filter the returned integrations.</p>
+ * @public
+ */
+export interface DescribeIntegrationsFilter {
     /**
-     * @internal
+     * <p>Specifies the type of integration filter.</p>
+     * @public
+     */
+    Name: DescribeIntegrationsFilterName | undefined;
+    /**
+     * <p>Specifies the values to filter on.</p>
+     * @public
+     */
+    Values: string[] | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeIntegrationsMessage {
+    /**
+     * <p>The unique identifier of the integration.</p>
+     * @public
+     */
+    IntegrationArn?: string;
+    /**
+     * <p>The maximum number of response records to return in each call. If the number of
+     *             remaining response records exceeds the specified <code>MaxRecords</code> value, a value
+     *             is returned in a <code>marker</code> field of the response. You can retrieve the next
+     *             set of records by retrying the command with the returned marker value. </p>
+     *          <p>Default: <code>100</code>
+     *          </p>
+     *          <p>Constraints: minimum 20, maximum 100.</p>
+     * @public
      */
-    constructor(opts: __ExceptionOptionType<IntegrationNotFoundFault, __BaseException>);
+    MaxRecords?: number;
+    /**
+     * <p>An optional pagination token provided by a previous <code>DescribeIntegrations</code>
+     *             request. If this parameter is specified, the response includes only records beyond the
+     *             marker, up to the value specified by <code>MaxRecords</code>.</p>
+     * @public
+     */
+    Marker?: string;
+    /**
+     * <p>A filter that specifies one or more resources to return.</p>
+     * @public
+     */
+    Filters?: DescribeIntegrationsFilter[];
+}
+/**
+ * @public
+ */
+export interface IntegrationsMessage {
+    /**
+     * <p>A value that indicates the starting point for the next set of response records in a subsequent request.
+     *             If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the <code>Marker</code> parameter and retrying the command.
+     *             If the <code>Marker</code> field is empty, all response records have been retrieved for the request.</p>
+     * @public
+     */
+    Marker?: string;
+    /**
+     * <p>List of integrations that are described.</p>
+     * @public
+     */
+    Integrations?: Integration[];
 }
 /**
  * <p></p>
@@ -2162,6 +2602,13 @@ export interface DescribeTagsMessage {
      *             <li>
      *                <p>Snapshot copy grant</p>
      *             </li>
+     *             <li>
+     *                <p>Integration (zero-ETL integration)</p>
+     *                <note>
+     *                   <p>To describe the tags associated with an <code>integration</code>, don't specify <code>ResourceType</code>,
+     *                     instead specify the <code>ResourceName</code> of the integration.</p>
+     *                </note>
+     *             </li>
      *          </ul>
      *          <p>For more information about Amazon Redshift resource types and constructing ARNs, go to
      *                 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions">Specifying Policy Elements: Actions, Effects, Resources, and Principals</a> in
@@ -3289,7 +3736,7 @@ export interface ModifyClusterMessage {
      * in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
      *          <p>Valid Values:
      *             <code>dc2.large</code> | <code>dc2.8xlarge</code> |
-     *             <code>ra3.xlplus</code> |  <code>ra3.4xlarge</code> | <code>ra3.16xlarge</code>
+     *             <code>ra3.large</code> |  <code>ra3.xlplus</code> |  <code>ra3.4xlarge</code> | <code>ra3.16xlarge</code>
      *          </p>
      * @public
      */
@@ -3970,6 +4417,26 @@ export interface ModifyEventSubscriptionResult {
      */
     EventSubscription?: EventSubscription;
 }
+/**
+ * @public
+ */
+export interface ModifyIntegrationMessage {
+    /**
+     * <p>The unique identifier of the integration to modify.</p>
+     * @public
+     */
+    IntegrationArn: string | undefined;
+    /**
+     * <p>A new description for the integration.</p>
+     * @public
+     */
+    Description?: string;
+    /**
+     * <p>A new name for the integration.</p>
+     * @public
+     */
+    IntegrationName?: string;
+}
 /**
  * @public
  */

package/dist-types/pagination/DescribeIntegrationsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { DescribeIntegrationsCommandInput, DescribeIntegrationsCommandOutput } from "../commands/DescribeIntegrationsCommand";
+import { RedshiftPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateDescribeIntegrations: (config: RedshiftPaginationConfiguration, input: DescribeIntegrationsCommandInput, ...rest: any[]) => Paginator<DescribeIntegrationsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -20,6 +20,7 @@ export * from "./DescribeEventsPaginator";
 export * from "./DescribeHsmClientCertificatesPaginator";
 export * from "./DescribeHsmConfigurationsPaginator";
 export * from "./DescribeInboundIntegrationsPaginator";
+export * from "./DescribeIntegrationsPaginator";
 export * from "./DescribeNodeConfigurationOptionsPaginator";
 export * from "./DescribeOrderableClusterOptionsPaginator";
 export * from "./DescribeRedshiftIdcApplicationsPaginator";