@aws-sdk/client-opensearch 3.689.0 → 3.691.0

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

@@ -11,14 +11,14 @@ export interface ListVersionsRequest {
      *     <code>nextToken</code> to get the next page of results.</p>
      * @public
      */
-    MaxResults?: number;
+    MaxResults?: number | undefined;
     /**
      * <p>If your initial <code>ListVersions</code> operation returns a <code>nextToken</code>, you
      *    can include the returned <code>nextToken</code> in subsequent <code>ListVersions</code>
      *    operations, which returns results in the next page.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * <p>Container for the parameters for response received from the <code>ListVersions</code>
@@ -31,14 +31,14 @@ export interface ListVersionsResponse {
      *    supports.</p>
      * @public
      */
-    Versions?: string[];
+    Versions?: string[] | undefined;
     /**
      * <p>When <code>nextToken</code> is returned, there are more results available. The value of
      *     <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
      *    returned token to retrieve the next page.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -55,7 +55,7 @@ export interface ListVpcEndpointAccessRequest {
      *     <code>ListVpcEndpointAccess</code> operations, which returns results in the next page.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -85,7 +85,7 @@ export interface ListVpcEndpointsRequest {
      *    operations, which returns results in the next page.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -119,7 +119,7 @@ export interface ListVpcEndpointsForDomainRequest {
      *     <code>ListEndpointsForDomain</code> operations, which returns results in the next page.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -158,7 +158,7 @@ export interface PurchaseReservedInstanceOfferingRequest {
      * <p>The number of OpenSearch instances to reserve.</p>
      * @public
      */
-    InstanceCount?: number;
+    InstanceCount?: number | undefined;
 }
 /**
  * <p>Represents the output of a <code>PurchaseReservedInstanceOffering</code> operation.</p>
@@ -169,12 +169,12 @@ export interface PurchaseReservedInstanceOfferingResponse {
      * <p>The ID of the Reserved Instance offering that was purchased.</p>
      * @public
      */
-    ReservedInstanceId?: string;
+    ReservedInstanceId?: string | undefined;
     /**
      * <p>The customer-specified identifier used to track this reservation.</p>
      * @public
      */
-    ReservationName?: string;
+    ReservationName?: string | undefined;
 }
 /**
  * <p>Container for the request parameters to the <code>RejectInboundConnection</code> operation.</p>
@@ -196,7 +196,7 @@ export interface RejectInboundConnectionResponse {
      * <p>Contains details about the rejected inbound connection.</p>
      * @public
      */
-    Connection?: InboundConnection;
+    Connection?: InboundConnection | undefined;
 }
 /**
  * <p>Container for the request parameters to the <code>RemoveTags</code> operation.</p>
@@ -228,12 +228,12 @@ export interface RevokeVpcEndpointAccessRequest {
      * <p>The account ID to revoke access from.</p>
      * @public
      */
-    Account?: string;
+    Account?: string | undefined;
     /**
      * <p>The service SP to revoke access from.</p>
      * @public
      */
-    Service?: AWSServicePrincipal;
+    Service?: AWSServicePrincipal | undefined;
 }
 /**
  * @public
@@ -260,7 +260,7 @@ export interface StartDomainMaintenanceRequest {
      * <p>The ID of the data node.</p>
      * @public
      */
-    NodeId?: string;
+    NodeId?: string | undefined;
 }
 /**
  * <p>The result of a <code>StartDomainMaintenance</code> request that information about the requested action. </p>
@@ -271,7 +271,7 @@ export interface StartDomainMaintenanceResponse {
      * <p>The request ID of requested action.</p>
      * @public
      */
-    MaintenanceId?: string;
+    MaintenanceId?: string | undefined;
 }
 /**
  * @public
@@ -321,13 +321,13 @@ export interface StartServiceSoftwareUpdateRequest {
      *    and <code>TIMESTAMP</code> if you do.</p>
      * @public
      */
-    ScheduleAt?: ScheduleAt;
+    ScheduleAt?: ScheduleAt | undefined;
     /**
      * <p>The Epoch timestamp when you want the service software update to start. You only need to
      *    specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
      * @public
      */
-    DesiredStartTime?: number;
+    DesiredStartTime?: number | undefined;
 }
 /**
  * <p>Represents the output of a <code>StartServiceSoftwareUpdate</code> operation. Contains the
@@ -339,7 +339,7 @@ export interface StartServiceSoftwareUpdateResponse {
      * <p>The current status of the OpenSearch Service software update.</p>
      * @public
      */
-    ServiceSoftwareOptions?: ServiceSoftwareOptions;
+    ServiceSoftwareOptions?: ServiceSoftwareOptions | undefined;
 }
 /**
  * @public
@@ -354,12 +354,12 @@ export interface UpdateApplicationRequest {
      * <p>Data sources to be associated with the OpenSearch Application.</p>
      * @public
      */
-    dataSources?: DataSource[];
+    dataSources?: DataSource[] | undefined;
     /**
      * <p>Configurations to be changed for the OpenSearch Application.</p>
      * @public
      */
-    appConfigs?: AppConfig[];
+    appConfigs?: AppConfig[] | undefined;
 }
 /**
  * @public
@@ -369,44 +369,44 @@ export interface UpdateApplicationResponse {
      * <p>Unique identifier of the updated OpenSearch Application.</p>
      * @public
      */
-    id?: string;
+    id?: string | undefined;
     /**
      * <p>Name of the updated OpenSearch Application.</p>
      * @public
      */
-    name?: string;
+    name?: string | undefined;
     /**
      * <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
      *   </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
      *   </p>
      * @public
      */
-    arn?: string;
+    arn?: string | undefined;
     /**
      * <p>Data sources associated with the updated OpenSearch Application.</p>
      * @public
      */
-    dataSources?: DataSource[];
+    dataSources?: DataSource[] | undefined;
     /**
      * <p>IAM Identity Center settings for the updated OpenSearch Application.</p>
      * @public
      */
-    iamIdentityCenterOptions?: IamIdentityCenterOptions;
+    iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
     /**
      * <p>Configurations for the updated OpenSearch Application.</p>
      * @public
      */
-    appConfigs?: AppConfig[];
+    appConfigs?: AppConfig[] | undefined;
     /**
      * <p>Timestamp at which the OpenSearch Application was created.</p>
      * @public
      */
-    createdAt?: Date;
+    createdAt?: Date | undefined;
     /**
      * <p>Timestamp at which the OpenSearch Application was last updated.</p>
      * @public
      */
-    lastUpdatedAt?: Date;
+    lastUpdatedAt?: Date | undefined;
 }
 /**
  * <p>Container for the parameters to the <code>UpdateDataSource</code>
@@ -433,12 +433,12 @@ export interface UpdateDataSourceRequest {
      * <p>A new description of the data source.</p>
      * @public
      */
-    Description?: string;
+    Description?: string | undefined;
     /**
      * <p>The status of the data source update.</p>
      * @public
      */
-    Status?: DataSourceStatus;
+    Status?: DataSourceStatus | undefined;
 }
 /**
  * <p>The result of an <code>UpdateDataSource</code> operation.</p>
@@ -449,7 +449,7 @@ export interface UpdateDataSourceResponse {
      * <p>A message associated with the updated data source.</p>
      * @public
      */
-    Message?: string;
+    Message?: string | undefined;
 }
 /**
  * @public
@@ -478,30 +478,30 @@ export interface UpdateDomainConfigRequest {
      *    number of EC2 instances.</p>
      * @public
      */
-    ClusterConfig?: ClusterConfig;
+    ClusterConfig?: ClusterConfig | undefined;
     /**
      * <p>The type and size of the EBS volume to attach to instances in the domain.</p>
      * @public
      */
-    EBSOptions?: EBSOptions;
+    EBSOptions?: EBSOptions | undefined;
     /**
      * <p>Option to set the time, in UTC format, for the daily automated snapshot. Default value is <code>0</code> hours.
      *   </p>
      * @public
      */
-    SnapshotOptions?: SnapshotOptions;
+    SnapshotOptions?: SnapshotOptions | undefined;
     /**
      * <p>Options to specify the subnets and security groups for a VPC endpoint. For more information,
      *    see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching
      *     your Amazon OpenSearch Service domains using a VPC</a>.</p>
      * @public
      */
-    VPCOptions?: VPCOptions;
+    VPCOptions?: VPCOptions | undefined;
     /**
      * <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.</p>
      * @public
      */
-    CognitoOptions?: CognitoOptions;
+    CognitoOptions?: CognitoOptions | undefined;
     /**
      * <p>Key-value pairs to specify advanced configuration options. The following key-value pairs are
      *    supported:</p>
@@ -531,12 +531,12 @@ export interface UpdateDomainConfigRequest {
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced cluster parameters</a>.</p>
      * @public
      */
-    AdvancedOptions?: Record<string, string>;
+    AdvancedOptions?: Record<string, string> | undefined;
     /**
      * <p>Identity and Access Management (IAM) access policy as a JSON-formatted string.</p>
      * @public
      */
-    AccessPolicies?: string;
+    AccessPolicies?: string | undefined;
     /**
      * <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across
      *    IPv4 and IPv6 address types, and is the recommended option.
@@ -544,50 +544,50 @@ export interface UpdateDomainConfigRequest {
      *   </p>
      * @public
      */
-    IPAddressType?: IPAddressType;
+    IPAddressType?: IPAddressType | undefined;
     /**
      * <p>Options to publish OpenSearch logs to Amazon CloudWatch Logs.</p>
      * @public
      */
-    LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption>>;
+    LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption>> | undefined;
     /**
      * <p>Encryption at rest options for the domain.</p>
      * @public
      */
-    EncryptionAtRestOptions?: EncryptionAtRestOptions;
+    EncryptionAtRestOptions?: EncryptionAtRestOptions | undefined;
     /**
      * <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
      *    traffic.</p>
      * @public
      */
-    DomainEndpointOptions?: DomainEndpointOptions;
+    DomainEndpointOptions?: DomainEndpointOptions | undefined;
     /**
      * <p>Node-to-node encryption options for the domain.</p>
      * @public
      */
-    NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
+    NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | undefined;
     /**
      * <p>Options for fine-grained access control.</p>
      * @public
      */
-    AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
+    AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
     /**
      * <p>Container for IAM Identity Center Options settings.</p>
      * @public
      */
-    IdentityCenterOptions?: IdentityCenterOptionsInput;
+    IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
     /**
      * <p>Options for Auto-Tune.</p>
      * @public
      */
-    AutoTuneOptions?: AutoTuneOptions;
+    AutoTuneOptions?: AutoTuneOptions | undefined;
     /**
      * <p>This flag, when set to True, specifies whether the <code>UpdateDomain</code> request should
      *    return the results of a dry run analysis without actually applying the change. A dry run
      *    determines what type of deployment the update will cause.</p>
      * @public
      */
-    DryRun?: boolean;
+    DryRun?: boolean | undefined;
     /**
      * <p>The type of dry run to perform.</p>
      *          <ul>
@@ -604,22 +604,22 @@ export interface UpdateDomainConfigRequest {
      *          </ul>
      * @public
      */
-    DryRunMode?: DryRunMode;
+    DryRunMode?: DryRunMode | undefined;
     /**
      * <p>Off-peak window options for the domain.</p>
      * @public
      */
-    OffPeakWindowOptions?: OffPeakWindowOptions;
+    OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
     /**
      * <p>Service software update options for the domain.</p>
      * @public
      */
-    SoftwareUpdateOptions?: SoftwareUpdateOptions;
+    SoftwareUpdateOptions?: SoftwareUpdateOptions | undefined;
     /**
      * <p>Options for all machine learning features for the specified domain.</p>
      * @public
      */
-    AIMLOptions?: AIMLOptionsInput;
+    AIMLOptions?: AIMLOptionsInput | undefined;
 }
 /**
  * <p>The results of an <code>UpdateDomain</code> request. Contains the status of the domain being
@@ -636,12 +636,12 @@ export interface UpdateDomainConfigResponse {
      * <p>Results of the dry run performed in the update domain request.</p>
      * @public
      */
-    DryRunResults?: DryRunResults;
+    DryRunResults?: DryRunResults | undefined;
     /**
      * <p>The status of the dry run being performed on the domain, if any.</p>
      * @public
      */
-    DryRunProgressStatus?: DryRunProgressStatus;
+    DryRunProgressStatus?: DryRunProgressStatus | undefined;
 }
 /**
  * <p>Container for request parameters to the <code>UpdatePackage</code> operation.</p>
@@ -662,23 +662,23 @@ export interface UpdatePackageRequest {
      * <p>A new description of the package.</p>
      * @public
      */
-    PackageDescription?: string;
+    PackageDescription?: string | undefined;
     /**
      * <p>Commit message for the updated file, which is shown as part of
      *     <code>GetPackageVersionHistoryResponse</code>.</p>
      * @public
      */
-    CommitMessage?: string;
+    CommitMessage?: string | undefined;
     /**
      * <p>The updated configuration details for a package.</p>
      * @public
      */
-    PackageConfiguration?: PackageConfiguration;
+    PackageConfiguration?: PackageConfiguration | undefined;
     /**
      * <p>Encryption options for a package.</p>
      * @public
      */
-    PackageEncryptionOptions?: PackageEncryptionOptions;
+    PackageEncryptionOptions?: PackageEncryptionOptions | undefined;
 }
 /**
  * <p>Container for the response returned by the <code>UpdatePackage</code> operation.</p>
@@ -689,7 +689,7 @@ export interface UpdatePackageResponse {
      * <p>Information about a package.</p>
      * @public
      */
-    PackageDetails?: PackageDetails;
+    PackageDetails?: PackageDetails | undefined;
 }
 /**
  * @public
@@ -732,17 +732,17 @@ export interface UpdatePackageScopeResponse {
      * <p> ID of the package whose scope was updated.</p>
      * @public
      */
-    PackageID?: string;
+    PackageID?: string | undefined;
     /**
      * <p>The operation that was performed on the package scope.</p>
      * @public
      */
-    Operation?: PackageScopeOperationEnum;
+    Operation?: PackageScopeOperationEnum | undefined;
     /**
      * <p> List of users who have access to the package after the scope update.</p>
      * @public
      */
-    PackageUserList?: string[];
+    PackageUserList?: string[] | undefined;
 }
 /**
  * <p>An exception for attempting to schedule a domain action during an unavailable time slot.</p>
@@ -755,7 +755,7 @@ export declare class SlotNotAvailableException extends __BaseException {
      * <p>Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.</p>
      * @public
      */
-    SlotSuggestions?: number[];
+    SlotSuggestions?: number[] | undefined;
     /**
      * @internal
      */
@@ -809,7 +809,7 @@ export interface UpdateScheduledActionRequest {
      *    parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
      * @public
      */
-    DesiredStartTime?: number;
+    DesiredStartTime?: number | undefined;
 }
 /**
  * @public
@@ -819,7 +819,7 @@ export interface UpdateScheduledActionResponse {
      * <p>Information about the rescheduled action.</p>
      * @public
      */
-    ScheduledAction?: ScheduledAction;
+    ScheduledAction?: ScheduledAction | undefined;
 }
 /**
  * @public
@@ -867,7 +867,7 @@ export interface UpgradeDomainRequest {
      *    actually perform the upgrade.</p>
      * @public
      */
-    PerformCheckOnly?: boolean;
+    PerformCheckOnly?: boolean | undefined;
     /**
      * <p>Only supports the <code>override_main_response_version</code> parameter and not other
      *    advanced options. You can only include this option when upgrading to an OpenSearch version.
@@ -875,7 +875,7 @@ export interface UpgradeDomainRequest {
      *    Elasticsearch OSS clients and plugins.</p>
      * @public
      */
-    AdvancedOptions?: Record<string, string>;
+    AdvancedOptions?: Record<string, string> | undefined;
 }
 /**
  * <p>Container for the response returned by <code>UpgradeDomain</code> operation.</p>
@@ -886,32 +886,32 @@ export interface UpgradeDomainResponse {
      * <p>The unique identifier of the domain upgrade.</p>
      * @public
      */
-    UpgradeId?: string;
+    UpgradeId?: string | undefined;
     /**
      * <p>The name of the domain that was upgraded.</p>
      * @public
      */
-    DomainName?: string;
+    DomainName?: string | undefined;
     /**
      * <p>OpenSearch or Elasticsearch version that the domain was upgraded to.</p>
      * @public
      */
-    TargetVersion?: string;
+    TargetVersion?: string | undefined;
     /**
      * <p>When true, indicates that an upgrade eligibility check was performed.</p>
      * @public
      */
-    PerformCheckOnly?: boolean;
+    PerformCheckOnly?: boolean | undefined;
     /**
      * <p>The advanced options configuration for the domain.</p>
      * @public
      */
-    AdvancedOptions?: Record<string, string>;
+    AdvancedOptions?: Record<string, string> | undefined;
     /**
      * <p>Container for information about a configuration change happening on a domain.</p>
      * @public
      */
-    ChangeProgressDetails?: ChangeProgressDetails;
+    ChangeProgressDetails?: ChangeProgressDetails | undefined;
 }
 /**
  * @internal