@aws-sdk/client-opensearch 3.777.0 → 3.787.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -27,7 +27,7 @@ declare const CreateApplicationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an OpenSearch Application.</p>
30
+ * <p>Creates an OpenSearch UI application. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Using the OpenSearch user interface in Amazon OpenSearch Service</a>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const DeleteApplicationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes an existing OpenSearch Application.</p>
30
+ * <p>Deletes a specified OpenSearch application.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const GetApplicationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Check the configuration and status of an existing OpenSearch Application.</p>
30
+ * <p>Retrieves the configuration and status of an existing OpenSearch application.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const ListApplicationsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>List all OpenSearch Applications under your account.</p>
30
+ * <p>Lists all OpenSearch applications under your account.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const UpdateApplicationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Update the OpenSearch Application. </p>
30
+ * <p>Updates the configuration and settings of an existing OpenSearch application.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -1253,7 +1253,7 @@ export interface PackageDetailsForAssociation {
1253
1253
  */
1254
1254
  PackageID: string | undefined;
1255
1255
  /**
1256
- * <p>List of package IDs that must be associated with the domain with or before the package can be associated.</p>
1256
+ * <p>List of package IDs that must be linked to the domain before or simultaneously with the package association.</p>
1257
1257
  * @public
1258
1258
  */
1259
1259
  PrerequisitePackageIDList?: string[] | undefined;
@@ -1521,17 +1521,18 @@ export declare const AppConfigType: {
1521
1521
  */
1522
1522
  export type AppConfigType = (typeof AppConfigType)[keyof typeof AppConfigType];
1523
1523
  /**
1524
- * <p>Configurations of the OpenSearch Application.</p>
1524
+ * <p>Configuration settings for an OpenSearch application. For more information, see
1525
+ * see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Using the OpenSearch user interface in Amazon OpenSearch Service</a>.</p>
1525
1526
  * @public
1526
1527
  */
1527
1528
  export interface AppConfig {
1528
1529
  /**
1529
- * <p>Specify the item to configure, such as admin role for the OpenSearch Application.</p>
1530
+ * <p>The configuration item to set, such as the admin role for the OpenSearch application.</p>
1530
1531
  * @public
1531
1532
  */
1532
1533
  key?: AppConfigType | undefined;
1533
1534
  /**
1534
- * <p>Specifies the value to configure for the key, such as an IAM user ARN.</p>
1535
+ * <p>The value assigned to the configuration key, such as an IAM user ARN.</p>
1535
1536
  * @public
1536
1537
  */
1537
1538
  value?: string | undefined;
@@ -1555,12 +1556,12 @@ export interface DataSource {
1555
1556
  dataSourceDescription?: string | undefined;
1556
1557
  }
1557
1558
  /**
1558
- * <p>Settings for IAM Identity Center.</p>
1559
+ * <p>Configuration settings for enabling and managing IAM Identity Center.</p>
1559
1560
  * @public
1560
1561
  */
1561
1562
  export interface IamIdentityCenterOptionsInput {
1562
1563
  /**
1563
- * <p>Enable/disable settings for IAM Identity Center.</p>
1564
+ * <p>Specifies whether IAM Identity Center is enabled or disabled.</p>
1564
1565
  * @public
1565
1566
  */
1566
1567
  enabled?: boolean | undefined;
@@ -1572,7 +1573,7 @@ export interface IamIdentityCenterOptionsInput {
1572
1573
  */
1573
1574
  iamIdentityCenterInstanceArn?: string | undefined;
1574
1575
  /**
1575
- * <p>Amazon Resource Name of IAM Identity Center's application.</p>
1576
+ * <p>The ARN of the IAM role associated with the IAM Identity Center application.</p>
1576
1577
  * @public
1577
1578
  */
1578
1579
  iamRoleForIdentityCenterApplicationArn?: string | undefined;
@@ -1582,28 +1583,27 @@ export interface IamIdentityCenterOptionsInput {
1582
1583
  */
1583
1584
  export interface CreateApplicationRequest {
1584
1585
  /**
1585
- * <p>A unique client idempotency token. It will be auto generated if not provided.</p>
1586
+ * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
1586
1587
  * @public
1587
1588
  */
1588
1589
  clientToken?: string | undefined;
1589
1590
  /**
1590
- * <p>Name of the OpenSearch Appication to create. Application names are unique across the applications
1591
- * owned by an account within an Amazon Web Services Region.</p>
1591
+ * <p>The unique name of the OpenSearch application. Names must be unique within an Amazon Web Services Region for each account.</p>
1592
1592
  * @public
1593
1593
  */
1594
1594
  name: string | undefined;
1595
1595
  /**
1596
- * <p>Data sources to be associated with the OpenSearch Application.</p>
1596
+ * <p>The data sources to link to the OpenSearch application.</p>
1597
1597
  * @public
1598
1598
  */
1599
1599
  dataSources?: DataSource[] | undefined;
1600
1600
  /**
1601
- * <p>Settings of IAM Identity Center for the OpenSearch Application.</p>
1601
+ * <p>Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.</p>
1602
1602
  * @public
1603
1603
  */
1604
1604
  iamIdentityCenterOptions?: IamIdentityCenterOptionsInput | undefined;
1605
1605
  /**
1606
- * <p>Configurations of the OpenSearch Application, inlcuding admin configuration.</p>
1606
+ * <p>Configuration settings for the OpenSearch application, including administrative options.</p>
1607
1607
  * @public
1608
1608
  */
1609
1609
  appConfigs?: AppConfig[] | undefined;
@@ -1614,12 +1614,12 @@ export interface CreateApplicationRequest {
1614
1614
  tagList?: Tag[] | undefined;
1615
1615
  }
1616
1616
  /**
1617
- * <p>Settings for IAM Identity Center for an OpenSearch Application.</p>
1617
+ * <p>Configuration settings for IAM Identity Center in an OpenSearch Application.</p>
1618
1618
  * @public
1619
1619
  */
1620
1620
  export interface IamIdentityCenterOptions {
1621
1621
  /**
1622
- * <p>IAM Identity Center is enabled for the OpenSearch Application.</p>
1622
+ * <p>Indicates whether IAM Identity Center is enabled for the OpenSearch Application.</p>
1623
1623
  * @public
1624
1624
  */
1625
1625
  enabled?: boolean | undefined;
@@ -1631,7 +1631,7 @@ export interface IamIdentityCenterOptions {
1631
1631
  */
1632
1632
  iamIdentityCenterInstanceArn?: string | undefined;
1633
1633
  /**
1634
- * <p>Amazon Resource Name of the IAM Identity Center's Application created for the OpenSearch Application after enabling IAM Identity Center.</p>
1634
+ * <p>The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch Application.</p>
1635
1635
  * @public
1636
1636
  */
1637
1637
  iamRoleForIdentityCenterApplicationArn?: string | undefined;
@@ -1648,12 +1648,12 @@ export interface IamIdentityCenterOptions {
1648
1648
  */
1649
1649
  export interface CreateApplicationResponse {
1650
1650
  /**
1651
- * <p>Unique identifier for the created OpenSearch Application.</p>
1651
+ * <p>The unique identifier assigned to the OpenSearch application.</p>
1652
1652
  * @public
1653
1653
  */
1654
1654
  id?: string | undefined;
1655
1655
  /**
1656
- * <p>Name of the created OpenSearch Application.</p>
1656
+ * <p>The name of the OpenSearch application.</p>
1657
1657
  * @public
1658
1658
  */
1659
1659
  name?: string | undefined;
@@ -1665,17 +1665,17 @@ export interface CreateApplicationResponse {
1665
1665
  */
1666
1666
  arn?: string | undefined;
1667
1667
  /**
1668
- * <p>Data sources associated with the created OpenSearch Application.</p>
1668
+ * <p>The data sources linked to the OpenSearch application.</p>
1669
1669
  * @public
1670
1670
  */
1671
1671
  dataSources?: DataSource[] | undefined;
1672
1672
  /**
1673
- * <p>Settings of IAM Identity Center for the created OpenSearch Application.</p>
1673
+ * <p>The IAM Identity Center settings configured for the OpenSearch application.</p>
1674
1674
  * @public
1675
1675
  */
1676
1676
  iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
1677
1677
  /**
1678
- * <p>Configurations of the OpenSearch Application, inlcuding admin configuration.</p>
1678
+ * <p>Configuration settings for the OpenSearch application, including administrative options.</p>
1679
1679
  * @public
1680
1680
  */
1681
1681
  appConfigs?: AppConfig[] | undefined;
@@ -1685,7 +1685,7 @@ export interface CreateApplicationResponse {
1685
1685
  */
1686
1686
  tagList?: Tag[] | undefined;
1687
1687
  /**
1688
- * <p>Timestamp when the OpenSearch Application was created.</p>
1688
+ * <p>The timestamp indicating when the OpenSearch application was created.</p>
1689
1689
  * @public
1690
1690
  */
1691
1691
  createdAt?: Date | undefined;
@@ -1910,22 +1910,22 @@ export declare const OpenSearchPartitionInstanceType: {
1910
1910
  */
1911
1911
  export type OpenSearchPartitionInstanceType = (typeof OpenSearchPartitionInstanceType)[keyof typeof OpenSearchPartitionInstanceType];
1912
1912
  /**
1913
- * <p>Container for specifying configuration of any node type.</p>
1913
+ * <p>Configuration options for defining the setup of any node type within the cluster.</p>
1914
1914
  * @public
1915
1915
  */
1916
1916
  export interface NodeConfig {
1917
1917
  /**
1918
- * <p>A boolean that indicates whether a particular node type is enabled or not.</p>
1918
+ * <p>A boolean value indicating whether a specific node type is active or inactive.</p>
1919
1919
  * @public
1920
1920
  */
1921
1921
  Enabled?: boolean | undefined;
1922
1922
  /**
1923
- * <p>The instance type of a particular node type in the cluster.</p>
1923
+ * <p>The instance type of a particular node within the cluster.</p>
1924
1924
  * @public
1925
1925
  */
1926
1926
  Type?: OpenSearchPartitionInstanceType | undefined;
1927
1927
  /**
1928
- * <p>The number of nodes of a particular node type in the cluster.</p>
1928
+ * <p>The number of nodes of a specific type within the cluster.</p>
1929
1929
  * @public
1930
1930
  */
1931
1931
  Count?: number | undefined;
@@ -1942,17 +1942,17 @@ export declare const NodeOptionsNodeType: {
1942
1942
  */
1943
1943
  export type NodeOptionsNodeType = (typeof NodeOptionsNodeType)[keyof typeof NodeOptionsNodeType];
1944
1944
  /**
1945
- * <p>Container for specifying node type.</p>
1945
+ * <p>Configuration settings for defining the node type within a cluster.</p>
1946
1946
  * @public
1947
1947
  */
1948
1948
  export interface NodeOption {
1949
1949
  /**
1950
- * <p>Container for node type like coordinating.</p>
1950
+ * <p>Defines the type of node, such as coordinating nodes.</p>
1951
1951
  * @public
1952
1952
  */
1953
1953
  NodeType?: NodeOptionsNodeType | undefined;
1954
1954
  /**
1955
- * <p>Container for specifying configuration of any node type.</p>
1955
+ * <p>Configuration options for defining the setup of any node type.</p>
1956
1956
  * @public
1957
1957
  */
1958
1958
  NodeConfig?: NodeConfig | undefined;
@@ -2247,27 +2247,27 @@ export declare const SubjectKeyIdCOption: {
2247
2247
  */
2248
2248
  export type SubjectKeyIdCOption = (typeof SubjectKeyIdCOption)[keyof typeof SubjectKeyIdCOption];
2249
2249
  /**
2250
- * <p>Container for IAM Identity Center Options settings.</p>
2250
+ * <p>Configuration settings for enabling and managing IAM Identity Center.</p>
2251
2251
  * @public
2252
2252
  */
2253
2253
  export interface IdentityCenterOptionsInput {
2254
2254
  /**
2255
- * <p>True to enable IAM Identity Center for API access in Amazon OpenSearch Service.</p>
2255
+ * <p>Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service.</p>
2256
2256
  * @public
2257
2257
  */
2258
2258
  EnabledAPIAccess?: boolean | undefined;
2259
2259
  /**
2260
- * <p>The ARN for IAM Identity Center Instance which will be used for IAM Identity Center Application creation.</p>
2260
+ * <p>The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.</p>
2261
2261
  * @public
2262
2262
  */
2263
2263
  IdentityCenterInstanceARN?: string | undefined;
2264
2264
  /**
2265
- * <p>Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.</p>
2265
+ * <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.</p>
2266
2266
  * @public
2267
2267
  */
2268
2268
  SubjectKey?: SubjectKeyIdCOption | undefined;
2269
2269
  /**
2270
- * <p>Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center</p>
2270
+ * <p>Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.</p>
2271
2271
  * @public
2272
2272
  */
2273
2273
  RolesKey?: RolesKeyIdCOption | undefined;
@@ -2557,7 +2557,7 @@ export interface CreateDomainRequest {
2557
2557
  */
2558
2558
  AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
2559
2559
  /**
2560
- * <p>Options for IAM Identity Center Option control for the domain.</p>
2560
+ * <p>Configuration options for enabling and managing IAM Identity Center integration within a domain.</p>
2561
2561
  * @public
2562
2562
  */
2563
2563
  IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
@@ -2715,37 +2715,39 @@ export declare const DomainProcessingStatusType: {
2715
2715
  */
2716
2716
  export type DomainProcessingStatusType = (typeof DomainProcessingStatusType)[keyof typeof DomainProcessingStatusType];
2717
2717
  /**
2718
- * <p>Container for IAM Identity Center Options settings.</p>
2718
+ * <p>Settings container for integrating IAM Identity Center with OpenSearch UI applications,
2719
+ * which enables enabling secure user authentication and access control across multiple data sources.
2720
+ * This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.</p>
2719
2721
  * @public
2720
2722
  */
2721
2723
  export interface IdentityCenterOptions {
2722
2724
  /**
2723
- * <p>True to enable IAM Identity Center for API access in Amazon OpenSearch Service.</p>
2725
+ * <p>Indicates whether IAM Identity Center is enabled for the application.</p>
2724
2726
  * @public
2725
2727
  */
2726
2728
  EnabledAPIAccess?: boolean | undefined;
2727
2729
  /**
2728
- * <p>The ARN for IAM Identity Center Instance.</p>
2730
+ * <p>The Amazon Resource Name (ARN) of the IAM Identity Center instance.</p>
2729
2731
  * @public
2730
2732
  */
2731
2733
  IdentityCenterInstanceARN?: string | undefined;
2732
2734
  /**
2733
- * <p>Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.</p>
2735
+ * <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.</p>
2734
2736
  * @public
2735
2737
  */
2736
2738
  SubjectKey?: SubjectKeyIdCOption | undefined;
2737
2739
  /**
2738
- * <p>Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center</p>
2740
+ * <p>Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.</p>
2739
2741
  * @public
2740
2742
  */
2741
2743
  RolesKey?: RolesKeyIdCOption | undefined;
2742
2744
  /**
2743
- * <p>The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.</p>
2745
+ * <p>The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.</p>
2744
2746
  * @public
2745
2747
  */
2746
2748
  IdentityCenterApplicationARN?: string | undefined;
2747
2749
  /**
2748
- * <p>The ID of IAM Identity Store.</p>
2750
+ * <p>The identifier of the IAM Identity Store.</p>
2749
2751
  * @public
2750
2752
  */
2751
2753
  IdentityStoreId?: string | undefined;
@@ -2993,7 +2995,7 @@ export interface DomainStatus {
2993
2995
  */
2994
2996
  AdvancedSecurityOptions?: AdvancedSecurityOptions | undefined;
2995
2997
  /**
2996
- * <p>Container for IAM Identity Center Option control for the domain.</p>
2998
+ * <p>Configuration options for controlling IAM Identity Center integration within a domain.</p>
2997
2999
  * @public
2998
3000
  */
2999
3001
  IdentityCenterOptions?: IdentityCenterOptions | undefined;
@@ -3318,12 +3320,12 @@ export interface PackageConfiguration {
3318
3320
  */
3319
3321
  export interface PackageEncryptionOptions {
3320
3322
  /**
3321
- * <p> KMS key ID for encrypting the package.</p>
3323
+ * <p>KMS key ID for encrypting the package.</p>
3322
3324
  * @public
3323
3325
  */
3324
3326
  KmsKeyIdentifier?: string | undefined;
3325
3327
  /**
3326
- * <p>This indicates whether encryption is enabled for the package.</p>
3328
+ * <p>Whether encryption is enabled for the package.</p>
3327
3329
  * @public
3328
3330
  */
3329
3331
  EncryptionEnabled: boolean | undefined;
@@ -3345,14 +3347,12 @@ export interface PackageSource {
3345
3347
  S3Key?: string | undefined;
3346
3348
  }
3347
3349
  /**
3348
- * <p>The vending options for a package to determine if the package can be used by other users.
3349
- * </p>
3350
+ * <p>Configuration options for determining whether a package can be made available for use by other users.</p>
3350
3351
  * @public
3351
3352
  */
3352
3353
  export interface PackageVendingOptions {
3353
3354
  /**
3354
- * <p>This indicates whether vending is enabled for the package to determine if package can be used by other users.
3355
- * </p>
3355
+ * <p>Indicates whether the package vending feature is enabled, allowing the package to be used by other users.</p>
3356
3356
  * @public
3357
3357
  */
3358
3358
  VendingEnabled: boolean | undefined;
@@ -3525,7 +3525,7 @@ export interface PackageDetails {
3525
3525
  */
3526
3526
  AllowListedUserList?: string[] | undefined;
3527
3527
  /**
3528
- * <p>The owner of the package who is allowed to create/update a package and add users to the package scope.</p>
3528
+ * <p>The owner of the package who is allowed to create and update a package and add users to the package scope.</p>
3529
3529
  * @public
3530
3530
  */
3531
3531
  PackageOwner?: string | undefined;
@@ -3535,7 +3535,7 @@ export interface PackageDetails {
3535
3535
  */
3536
3536
  PackageVendingOptions?: PackageVendingOptions | undefined;
3537
3537
  /**
3538
- * <p>Package Encryption Options for a package.</p>
3538
+ * <p>Encryption options for a package.</p>
3539
3539
  * @public
3540
3540
  */
3541
3541
  PackageEncryptionOptions?: PackageEncryptionOptions | undefined;
@@ -3641,7 +3641,7 @@ export interface CreateVpcEndpointResponse {
3641
3641
  */
3642
3642
  export interface DeleteApplicationRequest {
3643
3643
  /**
3644
- * <p>Unique identifier for the OpenSearch Application that you want to delete.</p>
3644
+ * <p>The unique identifier of the OpenSearch application to delete.</p>
3645
3645
  * @public
3646
3646
  */
3647
3647
  id: string | undefined;
@@ -4361,17 +4361,17 @@ export interface VersionStatus {
4361
4361
  Status: OptionStatus | undefined;
4362
4362
  }
4363
4363
  /**
4364
- * <p>The status of IAM Identity Center Options settings for a domain.</p>
4364
+ * <p>The status of IAM Identity Center configuration settings for a domain.</p>
4365
4365
  * @public
4366
4366
  */
4367
4367
  export interface IdentityCenterOptionsStatus {
4368
4368
  /**
4369
- * <p>Container for IAM Identity Center Options settings.</p>
4369
+ * <p>Configuration settings for IAM Identity Center integration.</p>
4370
4370
  * @public
4371
4371
  */
4372
4372
  Options: IdentityCenterOptions | undefined;
4373
4373
  /**
4374
- * <p>The status of IAM Identity Center Options settings for a domain.</p>
4374
+ * <p>The status of IAM Identity Center configuration settings for a domain.</p>
4375
4375
  * @public
4376
4376
  */
4377
4377
  Status: OptionStatus | undefined;
@@ -4571,7 +4571,7 @@ export interface DomainConfig {
4571
4571
  */
4572
4572
  AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus | undefined;
4573
4573
  /**
4574
- * <p>Container for IAM Identity Center Option control for the domain.</p>
4574
+ * <p>Configuration options for enabling and managing IAM Identity Center integration within a domain.</p>
4575
4575
  * @public
4576
4576
  */
4577
4577
  IdentityCenterOptions?: IdentityCenterOptionsStatus | undefined;
@@ -4900,7 +4900,7 @@ export interface DomainNodesStatus {
4900
4900
  */
4901
4901
  NodeId?: string | undefined;
4902
4902
  /**
4903
- * <p>Indicates whether the nodes is a data, master, or ultrawarm node.</p>
4903
+ * <p>Indicates whether the nodes is a data, master, or UltraWarm node.</p>
4904
4904
  * @public
4905
4905
  */
4906
4906
  NodeType?: NodeType | undefined;
@@ -4925,7 +4925,7 @@ export interface DomainNodesStatus {
4925
4925
  */
4926
4926
  StorageType?: string | undefined;
4927
4927
  /**
4928
- * <p>If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable
4928
+ * <p>If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable
4929
4929
  * for data nodes. </p>
4930
4930
  * @public
4931
4931
  */
@@ -5809,7 +5809,7 @@ export interface DissociatePackagesResponse {
5809
5809
  */
5810
5810
  export interface GetApplicationRequest {
5811
5811
  /**
5812
- * <p>Unique identifier of the checked OpenSearch Application.</p>
5812
+ * <p>The unique identifier of the OpenSearch application to retrieve.</p>
5813
5813
  * @public
5814
5814
  */
5815
5815
  id: string | undefined;
@@ -5834,7 +5834,7 @@ export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof Applicat
5834
5834
  */
5835
5835
  export interface GetApplicationResponse {
5836
5836
  /**
5837
- * <p>Unique identifier of the checked OpenSearch Application.</p>
5837
+ * <p>The unique identifier of the OpenSearch application.</p>
5838
5838
  * @public
5839
5839
  */
5840
5840
  id?: string | undefined;
@@ -5846,42 +5846,42 @@ export interface GetApplicationResponse {
5846
5846
  */
5847
5847
  arn?: string | undefined;
5848
5848
  /**
5849
- * <p>Name of the checked OpenSearch Application.</p>
5849
+ * <p>The name of the OpenSearch application.</p>
5850
5850
  * @public
5851
5851
  */
5852
5852
  name?: string | undefined;
5853
5853
  /**
5854
- * <p>Endpoint URL of the checked OpenSearch Application.</p>
5854
+ * <p>The endpoint URL of the OpenSearch application.</p>
5855
5855
  * @public
5856
5856
  */
5857
5857
  endpoint?: string | undefined;
5858
5858
  /**
5859
- * <p>Current status of the checked OpenSearch Application. Possible values are <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
5859
+ * <p>The current status of the OpenSearch application. Possible values: <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
5860
5860
  * @public
5861
5861
  */
5862
5862
  status?: ApplicationStatus | undefined;
5863
5863
  /**
5864
- * <p>IAM Identity Center settings for the checked OpenSearch Application.</p>
5864
+ * <p>The IAM Identity Center settings configured for the OpenSearch application.</p>
5865
5865
  * @public
5866
5866
  */
5867
5867
  iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
5868
5868
  /**
5869
- * <p>Associated data sources to the checked OpenSearch Application.</p>
5869
+ * <p>The data sources associated with the OpenSearch application.</p>
5870
5870
  * @public
5871
5871
  */
5872
5872
  dataSources?: DataSource[] | undefined;
5873
5873
  /**
5874
- * <p>App configurations of the checked OpenSearch Application.</p>
5874
+ * <p>The configuration settings of the OpenSearch application.</p>
5875
5875
  * @public
5876
5876
  */
5877
5877
  appConfigs?: AppConfig[] | undefined;
5878
5878
  /**
5879
- * <p>Timestamp at which the checked OpenSearch Application was created.</p>
5879
+ * <p>The timestamp when the OpenSearch application was created.</p>
5880
5880
  * @public
5881
5881
  */
5882
5882
  createdAt?: Date | undefined;
5883
5883
  /**
5884
- * <p>Timestamp at which the checked OpenSearch Application was last updated.</p>
5884
+ * <p>The timestamp of the last update to the OpenSearch application.</p>
5885
5885
  * @public
5886
5886
  */
5887
5887
  lastUpdatedAt?: Date | undefined;
@@ -6405,7 +6405,7 @@ export interface ListApplicationsRequest {
6405
6405
  */
6406
6406
  nextToken?: string | undefined;
6407
6407
  /**
6408
- * <p>OpenSearch Application Status can be used as filters for the listing request. Possible values are <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
6408
+ * <p>Filters the list of OpenSearch applications by status. Possible values: <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
6409
6409
  * @public
6410
6410
  */
6411
6411
  statuses?: ApplicationStatus[] | undefined;
@@ -6417,12 +6417,12 @@ export interface ListApplicationsRequest {
6417
6417
  maxResults?: number | undefined;
6418
6418
  }
6419
6419
  /**
6420
- * <p>Basic information of the OpenSearch Application.</p>
6420
+ * <p>Basic details of an OpenSearch application.</p>
6421
6421
  * @public
6422
6422
  */
6423
6423
  export interface ApplicationSummary {
6424
6424
  /**
6425
- * <p>Unique identifier for an OpenSearch application.</p>
6425
+ * <p>The unique identifier of an OpenSearch application.</p>
6426
6426
  * @public
6427
6427
  */
6428
6428
  id?: string | undefined;
@@ -6434,27 +6434,27 @@ export interface ApplicationSummary {
6434
6434
  */
6435
6435
  arn?: string | undefined;
6436
6436
  /**
6437
- * <p>Name of an OpenSearch Application.</p>
6437
+ * <p>The name of an OpenSearch application.</p>
6438
6438
  * @public
6439
6439
  */
6440
6440
  name?: string | undefined;
6441
6441
  /**
6442
- * <p>Endpoint URL of an OpenSearch Application.</p>
6442
+ * <p>The endpoint URL of an OpenSearch application.</p>
6443
6443
  * @public
6444
6444
  */
6445
6445
  endpoint?: string | undefined;
6446
6446
  /**
6447
- * <p>Status of an OpenSearch Application. Possible values are <code>CREATING</code>, <code>UPDATING</code>,<code> DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
6447
+ * <p>The current status of an OpenSearch application. Possible values: <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
6448
6448
  * @public
6449
6449
  */
6450
6450
  status?: ApplicationStatus | undefined;
6451
6451
  /**
6452
- * <p>Timestamp at which an OpenSearch Application was created.</p>
6452
+ * <p>The timestamp when an OpenSearch application was created.</p>
6453
6453
  * @public
6454
6454
  */
6455
6455
  createdAt?: Date | undefined;
6456
6456
  /**
6457
- * <p>Timestamp at which an OpenSearch Application was last updated.</p>
6457
+ * <p>The timestamp of the last update to an OpenSearch application.</p>
6458
6458
  * @public
6459
6459
  */
6460
6460
  lastUpdatedAt?: Date | undefined;
@@ -6464,7 +6464,7 @@ export interface ApplicationSummary {
6464
6464
  */
6465
6465
  export interface ListApplicationsResponse {
6466
6466
  /**
6467
- * <p>Summary of the OpenSearch Applications, including ID, ARN, name, endpoint, status, create time and last update time.</p>
6467
+ * <p>Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation time, and last update time.</p>
6468
6468
  * @public
6469
6469
  */
6470
6470
  ApplicationSummaries?: ApplicationSummary[] | undefined;
@@ -624,17 +624,17 @@ export interface StartServiceSoftwareUpdateResponse {
624
624
  */
625
625
  export interface UpdateApplicationRequest {
626
626
  /**
627
- * <p>Unique identifier of the OpenSearch Application to be updated.</p>
627
+ * <p>The unique identifier for the OpenSearch application to be updated.</p>
628
628
  * @public
629
629
  */
630
630
  id: string | undefined;
631
631
  /**
632
- * <p>Data sources to be associated with the OpenSearch Application.</p>
632
+ * <p>The data sources to associate with the OpenSearch application.</p>
633
633
  * @public
634
634
  */
635
635
  dataSources?: DataSource[] | undefined;
636
636
  /**
637
- * <p>Configurations to be changed for the OpenSearch Application.</p>
637
+ * <p>The configuration settings to modify for the OpenSearch application.</p>
638
638
  * @public
639
639
  */
640
640
  appConfigs?: AppConfig[] | undefined;
@@ -644,12 +644,12 @@ export interface UpdateApplicationRequest {
644
644
  */
645
645
  export interface UpdateApplicationResponse {
646
646
  /**
647
- * <p>Unique identifier of the updated OpenSearch Application.</p>
647
+ * <p>The unique identifier of the updated OpenSearch application.</p>
648
648
  * @public
649
649
  */
650
650
  id?: string | undefined;
651
651
  /**
652
- * <p>Name of the updated OpenSearch Application.</p>
652
+ * <p>The name of the updated OpenSearch application.</p>
653
653
  * @public
654
654
  */
655
655
  name?: string | undefined;
@@ -661,27 +661,27 @@ export interface UpdateApplicationResponse {
661
661
  */
662
662
  arn?: string | undefined;
663
663
  /**
664
- * <p>Data sources associated with the updated OpenSearch Application.</p>
664
+ * <p>The data sources associated with the updated OpenSearch application.</p>
665
665
  * @public
666
666
  */
667
667
  dataSources?: DataSource[] | undefined;
668
668
  /**
669
- * <p>IAM Identity Center settings for the updated OpenSearch Application.</p>
669
+ * <p>The IAM Identity Center configuration for the updated OpenSearch application.</p>
670
670
  * @public
671
671
  */
672
672
  iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
673
673
  /**
674
- * <p>Configurations for the updated OpenSearch Application.</p>
674
+ * <p>The configuration settings for the updated OpenSearch application.</p>
675
675
  * @public
676
676
  */
677
677
  appConfigs?: AppConfig[] | undefined;
678
678
  /**
679
- * <p>Timestamp at which the OpenSearch Application was created.</p>
679
+ * <p>The timestamp when the OpenSearch application was originally created.</p>
680
680
  * @public
681
681
  */
682
682
  createdAt?: Date | undefined;
683
683
  /**
684
- * <p>Timestamp at which the OpenSearch Application was last updated.</p>
684
+ * <p>The timestamp when the OpenSearch application was last updated.</p>
685
685
  * @public
686
686
  */
687
687
  lastUpdatedAt?: Date | undefined;
@@ -899,7 +899,7 @@ export interface UpdateDomainConfigRequest {
899
899
  */
900
900
  AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
901
901
  /**
902
- * <p>Container for IAM Identity Center Options settings.</p>
902
+ * <p>Configuration settings for enabling and managing IAM Identity Center.</p>
903
903
  * @public
904
904
  */
905
905
  IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-opensearch",
3
3
  "description": "AWS SDK for JavaScript Opensearch Client for Node.js, Browser and React Native",
4
- "version": "3.777.0",
4
+ "version": "3.787.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-opensearch",
@@ -21,16 +21,16 @@
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
23
  "@aws-sdk/core": "3.775.0",
24
- "@aws-sdk/credential-provider-node": "3.777.0",
24
+ "@aws-sdk/credential-provider-node": "3.787.0",
25
25
  "@aws-sdk/middleware-host-header": "3.775.0",
26
26
  "@aws-sdk/middleware-logger": "3.775.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.775.0",
28
- "@aws-sdk/middleware-user-agent": "3.775.0",
28
+ "@aws-sdk/middleware-user-agent": "3.787.0",
29
29
  "@aws-sdk/region-config-resolver": "3.775.0",
30
30
  "@aws-sdk/types": "3.775.0",
31
- "@aws-sdk/util-endpoints": "3.775.0",
31
+ "@aws-sdk/util-endpoints": "3.787.0",
32
32
  "@aws-sdk/util-user-agent-browser": "3.775.0",
33
- "@aws-sdk/util-user-agent-node": "3.775.0",
33
+ "@aws-sdk/util-user-agent-node": "3.787.0",
34
34
  "@smithy/config-resolver": "^4.1.0",
35
35
  "@smithy/core": "^3.2.0",
36
36
  "@smithy/fetch-http-handler": "^5.0.2",