@aws-sdk/client-opensearchserverless 3.968.0 → 3.970.0

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

@@ -417,6 +417,11 @@ export interface CollectionDetail {
      * @public
      */
     failureMessage?: string | undefined;
+    /**
+     * <p>The name of the collection group that contains this collection.</p>
+     * @public
+     */
+    collectionGroupName?: string | undefined;
 }
 /**
  * <p>Error information for an OpenSearch Serverless request.</p>
@@ -459,6 +464,155 @@ export interface BatchGetCollectionResponse {
      */
     collectionErrorDetails?: CollectionErrorDetail[] | undefined;
 }
+/**
+ * @public
+ */
+export interface BatchGetCollectionGroupRequest {
+    /**
+     * <p>A list of collection group IDs. You can't provide names and IDs in the same request.</p>
+     * @public
+     */
+    ids?: string[] | undefined;
+    /**
+     * <p>A list of collection group names. You can't provide names and IDs in the same request.</p>
+     * @public
+     */
+    names?: string[] | undefined;
+}
+/**
+ * <p>Capacity limits for a collection group. These limits define the minimum and maximum OpenSearch Compute Units (OCUs) for indexing and search operations that can be used by collections in the group.</p>
+ * @public
+ */
+export interface CollectionGroupCapacityLimits {
+    /**
+     * <p>The maximum indexing capacity for collections in the group.</p>
+     * @public
+     */
+    maxIndexingCapacityInOCU?: number | undefined;
+    /**
+     * <p>The maximum search capacity for collections in the group.</p>
+     * @public
+     */
+    maxSearchCapacityInOCU?: number | undefined;
+    /**
+     * <p>The minimum indexing capacity for collections in the group.</p>
+     * @public
+     */
+    minIndexingCapacityInOCU?: number | undefined;
+    /**
+     * <p>The minimum search capacity for collections in the group.</p>
+     * @public
+     */
+    minSearchCapacityInOCU?: number | undefined;
+}
+/**
+ * <p>A map of key-value pairs associated to an OpenSearch Serverless resource.</p>
+ * @public
+ */
+export interface Tag {
+    /**
+     * <p>The key to use in the tag.</p>
+     * @public
+     */
+    key: string | undefined;
+    /**
+     * <p>The value of the tag.</p>
+     * @public
+     */
+    value: string | undefined;
+}
+/**
+ * <p>Details about a collection group.</p>
+ * @public
+ */
+export interface CollectionGroupDetail {
+    /**
+     * <p>The unique identifier of the collection group.</p>
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the collection group.</p>
+     * @public
+     */
+    arn?: string | undefined;
+    /**
+     * <p>The name of the collection group.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>Indicates whether standby replicas are used for the collection group.</p>
+     * @public
+     */
+    standbyReplicas?: StandbyReplicas | undefined;
+    /**
+     * <p>The description of the collection group.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>A map of key-value pairs associated with the collection group.</p>
+     * @public
+     */
+    tags?: Tag[] | undefined;
+    /**
+     * <p>The Epoch time when the collection group was created.</p>
+     * @public
+     */
+    createdDate?: number | undefined;
+    /**
+     * <p>The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).</p>
+     * @public
+     */
+    capacityLimits?: CollectionGroupCapacityLimits | undefined;
+    /**
+     * <p>The number of collections associated with the collection group.</p>
+     * @public
+     */
+    numberOfCollections?: number | undefined;
+}
+/**
+ * <p>Error details for a collection group operation.</p>
+ * @public
+ */
+export interface CollectionGroupErrorDetail {
+    /**
+     * <p>If the request contains collection group IDs, the response includes the IDs provided in the request.</p>
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * <p>If the request contains collection group names, the response includes the names provided in the request.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>A description of the error. For example, <code>The specified Collection Group is not found.</code> </p>
+     * @public
+     */
+    errorMessage?: string | undefined;
+    /**
+     * <p>The error code for the request. For example, <code>NOT_FOUND</code>.</p>
+     * @public
+     */
+    errorCode?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface BatchGetCollectionGroupResponse {
+    /**
+     * <p>Details about each collection group.</p>
+     * @public
+     */
+    collectionGroupDetails?: CollectionGroupDetail[] | undefined;
+    /**
+     * <p>Error information for the request.</p>
+     * @public
+     */
+    collectionGroupErrorDetails?: CollectionGroupErrorDetail[] | undefined;
+}
 /**
  * <p>The unique identifiers of policy types and resource names.</p>
  * @public
@@ -768,20 +922,20 @@ export interface BatchGetVpcEndpointResponse {
     vpcEndpointErrorDetails?: VpcEndpointErrorDetail[] | undefined;
 }
 /**
- * <p>A map of key-value pairs associated to an OpenSearch Serverless resource.</p>
+ * <p>Encryption settings for a collection.</p>
  * @public
  */
-export interface Tag {
+export interface EncryptionConfig {
     /**
-     * <p>The key to use in the tag.</p>
+     * <p>Indicates whether to use an Amazon Web Services-owned key for encryption.</p>
      * @public
      */
-    key: string | undefined;
+    aWSOwnedKey?: boolean | undefined;
     /**
-     * <p>The value of the tag.</p>
+     * <p>The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.</p>
      * @public
      */
-    value: string | undefined;
+    kmsKeyArn?: string | undefined;
 }
 /**
  * @public
@@ -817,6 +971,16 @@ export interface CreateCollectionRequest {
      * @public
      */
     vectorOptions?: VectorOptions | undefined;
+    /**
+     * <p>The name of the collection group to associate with the collection.</p>
+     * @public
+     */
+    collectionGroupName?: string | undefined;
+    /**
+     * <p>Encryption settings for the collection.</p>
+     * @public
+     */
+    encryptionConfig?: EncryptionConfig | undefined;
     /**
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      * @public
@@ -883,6 +1047,11 @@ export interface CreateCollectionDetail {
      * @public
      */
     lastModifiedDate?: number | undefined;
+    /**
+     * <p>The name of the collection group that contains this collection.</p>
+     * @public
+     */
+    collectionGroupName?: string | undefined;
 }
 /**
  * @public
@@ -955,6 +1124,11 @@ export interface CollectionFilters {
      * @public
      */
     status?: CollectionStatus | undefined;
+    /**
+     * <p>The name of the collection group to filter by.</p>
+     * @public
+     */
+    collectionGroupName?: string | undefined;
 }
 /**
  * @public
@@ -1001,6 +1175,16 @@ export interface CollectionSummary {
      * @public
      */
     arn?: string | undefined;
+    /**
+     * <p>The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.</p>
+     * @public
+     */
+    kmsKeyArn?: string | undefined;
+    /**
+     * <p>The name of the collection group that contains this collection.</p>
+     * @public
+     */
+    collectionGroupName?: string | undefined;
 }
 /**
  * @public
@@ -1093,6 +1277,259 @@ export interface UpdateCollectionResponse {
      */
     updateCollectionDetail?: UpdateCollectionDetail | undefined;
 }
+/**
+ * @public
+ */
+export interface CreateCollectionGroupRequest {
+    /**
+     * <p>The name of the collection group.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>Indicates whether standby replicas should be used for a collection group.</p>
+     * @public
+     */
+    standbyReplicas: StandbyReplicas | undefined;
+    /**
+     * <p>A description of the collection group.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.</p>
+     * @public
+     */
+    tags?: Tag[] | undefined;
+    /**
+     * <p>The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group.</p>
+     * @public
+     */
+    capacityLimits?: CollectionGroupCapacityLimits | undefined;
+    /**
+     * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+}
+/**
+ * <p>Details about the created collection group.</p>
+ * @public
+ */
+export interface CreateCollectionGroupDetail {
+    /**
+     * <p>The unique identifier of the collection group.</p>
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the collection group.</p>
+     * @public
+     */
+    arn?: string | undefined;
+    /**
+     * <p>The name of the collection group.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>Indicates whether standby replicas are used for the collection group.</p>
+     * @public
+     */
+    standbyReplicas?: StandbyReplicas | undefined;
+    /**
+     * <p>The description of the collection group.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>A map of key-value pairs associated with the collection group.</p>
+     * @public
+     */
+    tags?: Tag[] | undefined;
+    /**
+     * <p>The Epoch time when the collection group was created.</p>
+     * @public
+     */
+    createdDate?: number | undefined;
+    /**
+     * <p>The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).</p>
+     * @public
+     */
+    capacityLimits?: CollectionGroupCapacityLimits | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateCollectionGroupResponse {
+    /**
+     * <p>Details about the created collection group.</p>
+     * @public
+     */
+    createCollectionGroupDetail?: CreateCollectionGroupDetail | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteCollectionGroupRequest {
+    /**
+     * <p>The unique identifier of the collection group to delete.</p>
+     * @public
+     */
+    id: string | undefined;
+    /**
+     * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteCollectionGroupResponse {
+}
+/**
+ * @public
+ */
+export interface ListCollectionGroupsRequest {
+    /**
+     * <p>If your initial <code>ListCollectionGroups</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListCollectionGroups</code> operations, which returns results in the next page.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>The maximum number of results to return. Default is 20. You can use <code>nextToken</code> to get the next page of results.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+}
+/**
+ * <p>Summary information about a collection group.</p>
+ * @public
+ */
+export interface CollectionGroupSummary {
+    /**
+     * <p>The unique identifier of the collection group.</p>
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the collection group.</p>
+     * @public
+     */
+    arn?: string | undefined;
+    /**
+     * <p>The name of the collection group.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>The number of collections within the collection group.</p>
+     * @public
+     */
+    numberOfCollections?: number | undefined;
+    /**
+     * <p>The Epoch time when the collection group was created.</p>
+     * @public
+     */
+    createdDate?: number | undefined;
+    /**
+     * <p>Capacity limits for a collection group. These limits define the minimum and maximum OpenSearch Compute Units (OCUs) for indexing and search operations that can be used by collections in the group.</p>
+     * @public
+     */
+    capacityLimits?: CollectionGroupCapacityLimits | undefined;
+}
+/**
+ * @public
+ */
+export interface ListCollectionGroupsResponse {
+    /**
+     * <p>Details about each collection group.</p>
+     * @public
+     */
+    collectionGroupSummaries?: CollectionGroupSummary[] | 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. Make the call again using the returned token to retrieve the next page.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateCollectionGroupRequest {
+    /**
+     * <p>The unique identifier of the collection group to update.</p>
+     * @public
+     */
+    id: string | undefined;
+    /**
+     * <p>A new description for the collection group.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>Updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).</p>
+     * @public
+     */
+    capacityLimits?: CollectionGroupCapacityLimits | undefined;
+    /**
+     * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+}
+/**
+ * <p>Details about the updated collection group.</p>
+ * @public
+ */
+export interface UpdateCollectionGroupDetail {
+    /**
+     * <p>The unique identifier of the collection group.</p>
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the collection group.</p>
+     * @public
+     */
+    arn?: string | undefined;
+    /**
+     * <p>The name of the collection group.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>The description of the collection group.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).</p>
+     * @public
+     */
+    capacityLimits?: CollectionGroupCapacityLimits | undefined;
+    /**
+     * <p>The Epoch time when the collection group was created.</p>
+     * @public
+     */
+    createdDate?: number | undefined;
+    /**
+     * <p>The date and time when the collection group was last modified.</p>
+     * @public
+     */
+    lastModifiedDate?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateCollectionGroupResponse {
+    /**
+     * <p>Details about the updated collection group.</p>
+     * @public
+     */
+    updateCollectionGroupDetail?: UpdateCollectionGroupDetail | undefined;
+}
 /**
  * <p>Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.</p>
  * @public
@@ -1246,12 +1683,12 @@ export interface CreateSecurityConfigRequest {
      */
     description?: string | undefined;
     /**
-     * <p>Describes SAML options in in the form of a key-value map. This field is required if you specify <code>SAML</code> for the <code>type</code> parameter.</p>
+     * <p>Describes SAML options in the form of a key-value map. This field is required if you specify <code>SAML</code> for the <code>type</code> parameter.</p>
      * @public
      */
     samlOptions?: SamlConfigOptions | undefined;
     /**
-     * <p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.</p>
+     * <p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify <code>iamidentitycenter</code> for the <code>type</code> parameter.</p>
      * @public
      */
     iamIdentityCenterOptions?: CreateIamIdentityCenterConfigOptions | undefined;

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

@@ -0,0 +1,7 @@
+import type { Paginator } from "@smithy/types";
+import { ListCollectionGroupsCommandInput, ListCollectionGroupsCommandOutput } from "../commands/ListCollectionGroupsCommand";
+import { OpenSearchServerlessPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListCollectionGroups: (config: OpenSearchServerlessPaginationConfiguration, input: ListCollectionGroupsCommandInput, ...rest: any[]) => Paginator<ListCollectionGroupsCommandOutput>;

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

@@ -1,5 +1,6 @@
 export * from "./Interfaces";
 export * from "./ListAccessPoliciesPaginator";
+export * from "./ListCollectionGroupsPaginator";
 export * from "./ListCollectionsPaginator";
 export * from "./ListLifecyclePoliciesPaginator";
 export * from "./ListSecurityConfigsPaginator";

package/dist-types/schemas/schemas_0.d.ts

@@ -3,6 +3,8 @@ export declare var AccessPolicyDetail$: StaticStructureSchema;
 export declare var AccessPolicyStats$: StaticStructureSchema;
 export declare var AccessPolicySummary$: StaticStructureSchema;
 export declare var AccountSettingsDetail$: StaticStructureSchema;
+export declare var BatchGetCollectionGroupRequest$: StaticStructureSchema;
+export declare var BatchGetCollectionGroupResponse$: StaticStructureSchema;
 export declare var BatchGetCollectionRequest$: StaticStructureSchema;
 export declare var BatchGetCollectionResponse$: StaticStructureSchema;
 export declare var BatchGetEffectiveLifecyclePolicyRequest$: StaticStructureSchema;
@@ -15,11 +17,18 @@ export declare var CapacityLimits$: StaticStructureSchema;
 export declare var CollectionDetail$: StaticStructureSchema;
 export declare var CollectionErrorDetail$: StaticStructureSchema;
 export declare var CollectionFilters$: StaticStructureSchema;
+export declare var CollectionGroupCapacityLimits$: StaticStructureSchema;
+export declare var CollectionGroupDetail$: StaticStructureSchema;
+export declare var CollectionGroupErrorDetail$: StaticStructureSchema;
+export declare var CollectionGroupSummary$: StaticStructureSchema;
 export declare var CollectionSummary$: StaticStructureSchema;
 export declare var ConflictException$: StaticErrorSchema;
 export declare var CreateAccessPolicyRequest$: StaticStructureSchema;
 export declare var CreateAccessPolicyResponse$: StaticStructureSchema;
 export declare var CreateCollectionDetail$: StaticStructureSchema;
+export declare var CreateCollectionGroupDetail$: StaticStructureSchema;
+export declare var CreateCollectionGroupRequest$: StaticStructureSchema;
+export declare var CreateCollectionGroupResponse$: StaticStructureSchema;
 export declare var CreateCollectionRequest$: StaticStructureSchema;
 export declare var CreateCollectionResponse$: StaticStructureSchema;
 export declare var CreateIamIdentityCenterConfigOptions$: StaticStructureSchema;
@@ -37,6 +46,8 @@ export declare var CreateVpcEndpointResponse$: StaticStructureSchema;
 export declare var DeleteAccessPolicyRequest$: StaticStructureSchema;
 export declare var DeleteAccessPolicyResponse$: StaticStructureSchema;
 export declare var DeleteCollectionDetail$: StaticStructureSchema;
+export declare var DeleteCollectionGroupRequest$: StaticStructureSchema;
+export declare var DeleteCollectionGroupResponse$: StaticStructureSchema;
 export declare var DeleteCollectionRequest$: StaticStructureSchema;
 export declare var DeleteCollectionResponse$: StaticStructureSchema;
 export declare var DeleteIndexRequest$: StaticStructureSchema;
@@ -52,6 +63,7 @@ export declare var DeleteVpcEndpointRequest$: StaticStructureSchema;
 export declare var DeleteVpcEndpointResponse$: StaticStructureSchema;
 export declare var EffectiveLifecyclePolicyDetail$: StaticStructureSchema;
 export declare var EffectiveLifecyclePolicyErrorDetail$: StaticStructureSchema;
+export declare var EncryptionConfig$: StaticStructureSchema;
 export declare var FipsEndpoints$: StaticStructureSchema;
 export declare var GetAccessPolicyRequest$: StaticStructureSchema;
 export declare var GetAccessPolicyResponse$: StaticStructureSchema;
@@ -76,6 +88,8 @@ export declare var LifecyclePolicyStats$: StaticStructureSchema;
 export declare var LifecyclePolicySummary$: StaticStructureSchema;
 export declare var ListAccessPoliciesRequest$: StaticStructureSchema;
 export declare var ListAccessPoliciesResponse$: StaticStructureSchema;
+export declare var ListCollectionGroupsRequest$: StaticStructureSchema;
+export declare var ListCollectionGroupsResponse$: StaticStructureSchema;
 export declare var ListCollectionsRequest$: StaticStructureSchema;
 export declare var ListCollectionsResponse$: StaticStructureSchema;
 export declare var ListLifecyclePoliciesRequest$: StaticStructureSchema;
@@ -108,6 +122,9 @@ export declare var UpdateAccessPolicyResponse$: StaticStructureSchema;
 export declare var UpdateAccountSettingsRequest$: StaticStructureSchema;
 export declare var UpdateAccountSettingsResponse$: StaticStructureSchema;
 export declare var UpdateCollectionDetail$: StaticStructureSchema;
+export declare var UpdateCollectionGroupDetail$: StaticStructureSchema;
+export declare var UpdateCollectionGroupRequest$: StaticStructureSchema;
+export declare var UpdateCollectionGroupResponse$: StaticStructureSchema;
 export declare var UpdateCollectionRequest$: StaticStructureSchema;
 export declare var UpdateCollectionResponse$: StaticStructureSchema;
 export declare var UpdateIamIdentityCenterConfigOptions$: StaticStructureSchema;
@@ -130,11 +147,13 @@ export declare var VpcEndpointFilters$: StaticStructureSchema;
 export declare var VpcEndpointSummary$: StaticStructureSchema;
 export declare var OpenSearchServerlessServiceException$: StaticErrorSchema;
 export declare var BatchGetCollection$: StaticOperationSchema;
+export declare var BatchGetCollectionGroup$: StaticOperationSchema;
 export declare var BatchGetEffectiveLifecyclePolicy$: StaticOperationSchema;
 export declare var BatchGetLifecyclePolicy$: StaticOperationSchema;
 export declare var BatchGetVpcEndpoint$: StaticOperationSchema;
 export declare var CreateAccessPolicy$: StaticOperationSchema;
 export declare var CreateCollection$: StaticOperationSchema;
+export declare var CreateCollectionGroup$: StaticOperationSchema;
 export declare var CreateIndex$: StaticOperationSchema;
 export declare var CreateLifecyclePolicy$: StaticOperationSchema;
 export declare var CreateSecurityConfig$: StaticOperationSchema;
@@ -142,6 +161,7 @@ export declare var CreateSecurityPolicy$: StaticOperationSchema;
 export declare var CreateVpcEndpoint$: StaticOperationSchema;
 export declare var DeleteAccessPolicy$: StaticOperationSchema;
 export declare var DeleteCollection$: StaticOperationSchema;
+export declare var DeleteCollectionGroup$: StaticOperationSchema;
 export declare var DeleteIndex$: StaticOperationSchema;
 export declare var DeleteLifecyclePolicy$: StaticOperationSchema;
 export declare var DeleteSecurityConfig$: StaticOperationSchema;
@@ -154,6 +174,7 @@ export declare var GetPoliciesStats$: StaticOperationSchema;
 export declare var GetSecurityConfig$: StaticOperationSchema;
 export declare var GetSecurityPolicy$: StaticOperationSchema;
 export declare var ListAccessPolicies$: StaticOperationSchema;
+export declare var ListCollectionGroups$: StaticOperationSchema;
 export declare var ListCollections$: StaticOperationSchema;
 export declare var ListLifecyclePolicies$: StaticOperationSchema;
 export declare var ListSecurityConfigs$: StaticOperationSchema;
@@ -165,6 +186,7 @@ export declare var UntagResource$: StaticOperationSchema;
 export declare var UpdateAccessPolicy$: StaticOperationSchema;
 export declare var UpdateAccountSettings$: StaticOperationSchema;
 export declare var UpdateCollection$: StaticOperationSchema;
+export declare var UpdateCollectionGroup$: StaticOperationSchema;
 export declare var UpdateIndex$: StaticOperationSchema;
 export declare var UpdateLifecyclePolicy$: StaticOperationSchema;
 export declare var UpdateSecurityConfig$: StaticOperationSchema;