# Data Types
<a name="API_Types"></a>

The OpenSearch Service Serverless API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [AccessPolicyDetail](API_AccessPolicyDetail.md) 
+  [AccessPolicyStats](API_AccessPolicyStats.md) 
+  [AccessPolicySummary](API_AccessPolicySummary.md) 
+  [AccountSettingsDetail](API_AccountSettingsDetail.md) 
+  [CapacityLimits](API_CapacityLimits.md) 
+  [CollectionDetail](API_CollectionDetail.md) 
+  [CollectionErrorDetail](API_CollectionErrorDetail.md) 
+  [CollectionFilters](API_CollectionFilters.md) 
+  [CollectionGroupCapacityLimits](API_CollectionGroupCapacityLimits.md) 
+  [CollectionGroupDetail](API_CollectionGroupDetail.md) 
+  [CollectionGroupErrorDetail](API_CollectionGroupErrorDetail.md) 
+  [CollectionGroupSummary](API_CollectionGroupSummary.md) 
+  [CollectionSummary](API_CollectionSummary.md) 
+  [CreateCollectionDetail](API_CreateCollectionDetail.md) 
+  [CreateCollectionGroupDetail](API_CreateCollectionGroupDetail.md) 
+  [CreateIamIdentityCenterConfigOptions](API_CreateIamIdentityCenterConfigOptions.md) 
+  [CreateVpcEndpointDetail](API_CreateVpcEndpointDetail.md) 
+  [DeleteCollectionDetail](API_DeleteCollectionDetail.md) 
+  [DeleteVpcEndpointDetail](API_DeleteVpcEndpointDetail.md) 
+  [EffectiveLifecyclePolicyDetail](API_EffectiveLifecyclePolicyDetail.md) 
+  [EffectiveLifecyclePolicyErrorDetail](API_EffectiveLifecyclePolicyErrorDetail.md) 
+  [EncryptionConfig](API_EncryptionConfig.md) 
+  [FipsEndpoints](API_FipsEndpoints.md) 
+  [IamFederationConfigOptions](API_IamFederationConfigOptions.md) 
+  [IamIdentityCenterConfigOptions](API_IamIdentityCenterConfigOptions.md) 
+  [LifecyclePolicyDetail](API_LifecyclePolicyDetail.md) 
+  [LifecyclePolicyErrorDetail](API_LifecyclePolicyErrorDetail.md) 
+  [LifecyclePolicyIdentifier](API_LifecyclePolicyIdentifier.md) 
+  [LifecyclePolicyResourceIdentifier](API_LifecyclePolicyResourceIdentifier.md) 
+  [LifecyclePolicyStats](API_LifecyclePolicyStats.md) 
+  [LifecyclePolicySummary](API_LifecyclePolicySummary.md) 
+  [SamlConfigOptions](API_SamlConfigOptions.md) 
+  [SecurityConfigDetail](API_SecurityConfigDetail.md) 
+  [SecurityConfigStats](API_SecurityConfigStats.md) 
+  [SecurityConfigSummary](API_SecurityConfigSummary.md) 
+  [SecurityPolicyDetail](API_SecurityPolicyDetail.md) 
+  [SecurityPolicyStats](API_SecurityPolicyStats.md) 
+  [SecurityPolicySummary](API_SecurityPolicySummary.md) 
+  [Tag](API_Tag.md) 
+  [UpdateCollectionDetail](API_UpdateCollectionDetail.md) 
+  [UpdateCollectionGroupDetail](API_UpdateCollectionGroupDetail.md) 
+  [UpdateIamIdentityCenterConfigOptions](API_UpdateIamIdentityCenterConfigOptions.md) 
+  [UpdateVpcEndpointDetail](API_UpdateVpcEndpointDetail.md) 
+  [VectorOptions](API_VectorOptions.md) 
+  [VpcEndpointDetail](API_VpcEndpointDetail.md) 
+  [VpcEndpointErrorDetail](API_VpcEndpointErrorDetail.md) 
+  [VpcEndpointFilters](API_VpcEndpointFilters.md) 
+  [VpcEndpointSummary](API_VpcEndpointSummary.md) 

# AccessPolicyDetail
<a name="API_AccessPolicyDetail"></a>

Details about an OpenSearch Serverless access policy.

## Contents
<a name="API_AccessPolicyDetail_Contents"></a>

 ** createdDate **   <a name="opensearchserverless-Type-AccessPolicyDetail-createdDate"></a>
The date the policy was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-AccessPolicyDetail-description"></a>
The description of the policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-AccessPolicyDetail-lastModifiedDate"></a>
The timestamp of when the policy was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-AccessPolicyDetail-name"></a>
The name of the policy.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** policy **   <a name="opensearchserverless-Type-AccessPolicyDetail-policy"></a>
The JSON policy document without any whitespaces.  
Type: JSON value  
Required: No

 ** policyVersion **   <a name="opensearchserverless-Type-AccessPolicyDetail-policyVersion"></a>
The version of the policy.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 36.  
Pattern: `([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?`   
Required: No

 ** type **   <a name="opensearchserverless-Type-AccessPolicyDetail-type"></a>
The type of access policy.  
Type: String  
Valid Values: `data`   
Required: No

## See Also
<a name="API_AccessPolicyDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/AccessPolicyDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/AccessPolicyDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/AccessPolicyDetail) 

# AccessPolicyStats
<a name="API_AccessPolicyStats"></a>

Statistics for an OpenSearch Serverless access policy.

## Contents
<a name="API_AccessPolicyStats_Contents"></a>

 ** DataPolicyCount **   <a name="opensearchserverless-Type-AccessPolicyStats-DataPolicyCount"></a>
The number of data access policies in the current account.  
Type: Long  
Required: No

## See Also
<a name="API_AccessPolicyStats_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/AccessPolicyStats) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/AccessPolicyStats) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/AccessPolicyStats) 

# AccessPolicySummary
<a name="API_AccessPolicySummary"></a>

A summary of the data access policy.

## Contents
<a name="API_AccessPolicySummary_Contents"></a>

 ** createdDate **   <a name="opensearchserverless-Type-AccessPolicySummary-createdDate"></a>
The Epoch time when the access policy was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-AccessPolicySummary-description"></a>
The description of the access policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-AccessPolicySummary-lastModifiedDate"></a>
The date and time when the collection was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-AccessPolicySummary-name"></a>
The name of the access policy.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** policyVersion **   <a name="opensearchserverless-Type-AccessPolicySummary-policyVersion"></a>
The version of the policy.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 36.  
Pattern: `([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?`   
Required: No

 ** type **   <a name="opensearchserverless-Type-AccessPolicySummary-type"></a>
The type of access policy. Currently, the only available type is `data`.  
Type: String  
Valid Values: `data`   
Required: No

## See Also
<a name="API_AccessPolicySummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/AccessPolicySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/AccessPolicySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/AccessPolicySummary) 

# AccountSettingsDetail
<a name="API_AccountSettingsDetail"></a>

OpenSearch Serverless-related information for the current account.

## Contents
<a name="API_AccountSettingsDetail_Contents"></a>

 ** capacityLimits **   <a name="opensearchserverless-Type-AccountSettingsDetail-capacityLimits"></a>
The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see [Managing capacity limits for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html).  
Type: [CapacityLimits](API_CapacityLimits.md) object  
Required: No

## See Also
<a name="API_AccountSettingsDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/AccountSettingsDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/AccountSettingsDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/AccountSettingsDetail) 

# CapacityLimits
<a name="API_CapacityLimits"></a>

The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see [Managing capacity limits for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html).

## Contents
<a name="API_CapacityLimits_Contents"></a>

 ** maxIndexingCapacityInOCU **   <a name="opensearchserverless-Type-CapacityLimits-maxIndexingCapacityInOCU"></a>
The maximum indexing capacity for collections.  
Type: Integer  
Valid Range: Minimum value of 2.  
Required: No

 ** maxSearchCapacityInOCU **   <a name="opensearchserverless-Type-CapacityLimits-maxSearchCapacityInOCU"></a>
The maximum search capacity for collections.  
Type: Integer  
Valid Range: Minimum value of 2.  
Required: No

## See Also
<a name="API_CapacityLimits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CapacityLimits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CapacityLimits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CapacityLimits) 

# CollectionDetail
<a name="API_CollectionDetail"></a>

Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.

## Contents
<a name="API_CollectionDetail_Contents"></a>

 ** arn **   <a name="opensearchserverless-Type-CollectionDetail-arn"></a>
The Amazon Resource Name (ARN) of the collection.  
Type: String  
Required: No

 ** collectionEndpoint **   <a name="opensearchserverless-Type-CollectionDetail-collectionEndpoint"></a>
Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.  
Type: String  
Required: No

 ** collectionGroupName **   <a name="opensearchserverless-Type-CollectionDetail-collectionGroupName"></a>
The name of the collection group that contains this collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** createdDate **   <a name="opensearchserverless-Type-CollectionDetail-createdDate"></a>
The Epoch time when the collection was created.  
Type: Long  
Required: No

 ** dashboardEndpoint **   <a name="opensearchserverless-Type-CollectionDetail-dashboardEndpoint"></a>
Collection-specific endpoint used to access OpenSearch Dashboards.  
Type: String  
Required: No

 ** description **   <a name="opensearchserverless-Type-CollectionDetail-description"></a>
A description of the collection.  
Type: String  
Required: No

 ** failureCode **   <a name="opensearchserverless-Type-CollectionDetail-failureCode"></a>
A failure code associated with the request.  
Type: String  
Required: No

 ** failureMessage **   <a name="opensearchserverless-Type-CollectionDetail-failureMessage"></a>
A message associated with the failure code.  
Type: String  
Required: No

 ** fipsEndpoints **   <a name="opensearchserverless-Type-CollectionDetail-fipsEndpoints"></a>
FIPS-compliant endpoints for the collection. These endpoints use FIPS 140-3 validated cryptographic modules and are required for federal government workloads that must comply with FedRAMP security standards.  
Type: [FipsEndpoints](API_FipsEndpoints.md) object  
Required: No

 ** id **   <a name="opensearchserverless-Type-CollectionDetail-id"></a>
A unique identifier for the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** kmsKeyArn **   <a name="opensearchserverless-Type-CollectionDetail-kmsKeyArn"></a>
The ARN of the AWS KMS key used to encrypt the collection.  
Type: String  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-CollectionDetail-lastModifiedDate"></a>
The date and time when the collection was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-CollectionDetail-name"></a>
The name of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** standbyReplicas **   <a name="opensearchserverless-Type-CollectionDetail-standbyReplicas"></a>
Details about an OpenSearch Serverless collection.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** status **   <a name="opensearchserverless-Type-CollectionDetail-status"></a>
The current status of the collection.  
Type: String  
Valid Values: `CREATING | DELETING | ACTIVE | FAILED`   
Required: No

 ** type **   <a name="opensearchserverless-Type-CollectionDetail-type"></a>
The type of collection.  
Type: String  
Valid Values: `SEARCH | TIMESERIES | VECTORSEARCH`   
Required: No

 ** vectorOptions **   <a name="opensearchserverless-Type-CollectionDetail-vectorOptions"></a>
Configuration options for vector search capabilities in the collection.  
Type: [VectorOptions](API_VectorOptions.md) object  
Required: No

## See Also
<a name="API_CollectionDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CollectionDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CollectionDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CollectionDetail) 

# CollectionErrorDetail
<a name="API_CollectionErrorDetail"></a>

Error information for an OpenSearch Serverless request.

## Contents
<a name="API_CollectionErrorDetail_Contents"></a>

 ** errorCode **   <a name="opensearchserverless-Type-CollectionErrorDetail-errorCode"></a>
The error code for the request. For example, `NOT_FOUND`.  
Type: String  
Required: No

 ** errorMessage **   <a name="opensearchserverless-Type-CollectionErrorDetail-errorMessage"></a>
A description of the error. For example, `The specified Collection is not found.`   
Type: String  
Required: No

 ** id **   <a name="opensearchserverless-Type-CollectionErrorDetail-id"></a>
If the request contains collection IDs, the response includes the IDs provided in the request.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** name **   <a name="opensearchserverless-Type-CollectionErrorDetail-name"></a>
If the request contains collection names, the response includes the names provided in the request.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

## See Also
<a name="API_CollectionErrorDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CollectionErrorDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CollectionErrorDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CollectionErrorDetail) 

# CollectionFilters
<a name="API_CollectionFilters"></a>

A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.

## Contents
<a name="API_CollectionFilters_Contents"></a>

 ** collectionGroupName **   <a name="opensearchserverless-Type-CollectionFilters-collectionGroupName"></a>
The name of the collection group to filter by.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** name **   <a name="opensearchserverless-Type-CollectionFilters-name"></a>
The name of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** status **   <a name="opensearchserverless-Type-CollectionFilters-status"></a>
The current status of the collection.  
Type: String  
Valid Values: `CREATING | DELETING | ACTIVE | FAILED`   
Required: No

## See Also
<a name="API_CollectionFilters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CollectionFilters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CollectionFilters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CollectionFilters) 

# CollectionGroupCapacityLimits
<a name="API_CollectionGroupCapacityLimits"></a>

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.

## Contents
<a name="API_CollectionGroupCapacityLimits_Contents"></a>

 ** maxIndexingCapacityInOCU **   <a name="opensearchserverless-Type-CollectionGroupCapacityLimits-maxIndexingCapacityInOCU"></a>
The maximum indexing capacity for collections in the group.  
Type: Float  
Valid Range: Minimum value of 1.  
Required: No

 ** maxSearchCapacityInOCU **   <a name="opensearchserverless-Type-CollectionGroupCapacityLimits-maxSearchCapacityInOCU"></a>
The maximum search capacity for collections in the group.  
Type: Float  
Valid Range: Minimum value of 1.  
Required: No

 ** minIndexingCapacityInOCU **   <a name="opensearchserverless-Type-CollectionGroupCapacityLimits-minIndexingCapacityInOCU"></a>
The minimum indexing capacity for collections in the group.  
Type: Float  
Valid Range: Minimum value of 1.  
Required: No

 ** minSearchCapacityInOCU **   <a name="opensearchserverless-Type-CollectionGroupCapacityLimits-minSearchCapacityInOCU"></a>
The minimum search capacity for collections in the group.  
Type: Float  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_CollectionGroupCapacityLimits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CollectionGroupCapacityLimits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CollectionGroupCapacityLimits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CollectionGroupCapacityLimits) 

# CollectionGroupDetail
<a name="API_CollectionGroupDetail"></a>

Details about a collection group.

## Contents
<a name="API_CollectionGroupDetail_Contents"></a>

 ** arn **   <a name="opensearchserverless-Type-CollectionGroupDetail-arn"></a>
The Amazon Resource Name (ARN) of the collection group.  
Type: String  
Required: No

 ** capacityLimits **   <a name="opensearchserverless-Type-CollectionGroupDetail-capacityLimits"></a>
The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).  
Type: [CollectionGroupCapacityLimits](API_CollectionGroupCapacityLimits.md) object  
Required: No

 ** createdDate **   <a name="opensearchserverless-Type-CollectionGroupDetail-createdDate"></a>
The Epoch time when the collection group was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-CollectionGroupDetail-description"></a>
The description of the collection group.  
Type: String  
Required: No

 ** id **   <a name="opensearchserverless-Type-CollectionGroupDetail-id"></a>
The unique identifier of the collection group.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** name **   <a name="opensearchserverless-Type-CollectionGroupDetail-name"></a>
The name of the collection group.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** numberOfCollections **   <a name="opensearchserverless-Type-CollectionGroupDetail-numberOfCollections"></a>
The number of collections associated with the collection group.  
Type: Integer  
Required: No

 ** standbyReplicas **   <a name="opensearchserverless-Type-CollectionGroupDetail-standbyReplicas"></a>
Indicates whether standby replicas are used for the collection group.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** tags **   <a name="opensearchserverless-Type-CollectionGroupDetail-tags"></a>
A map of key-value pairs associated with the collection group.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## See Also
<a name="API_CollectionGroupDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CollectionGroupDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CollectionGroupDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CollectionGroupDetail) 

# CollectionGroupErrorDetail
<a name="API_CollectionGroupErrorDetail"></a>

Error details for a collection group operation.

## Contents
<a name="API_CollectionGroupErrorDetail_Contents"></a>

 ** errorCode **   <a name="opensearchserverless-Type-CollectionGroupErrorDetail-errorCode"></a>
The error code for the request. For example, `NOT_FOUND`.  
Type: String  
Required: No

 ** errorMessage **   <a name="opensearchserverless-Type-CollectionGroupErrorDetail-errorMessage"></a>
A description of the error. For example, `The specified Collection Group is not found.`   
Type: String  
Required: No

 ** id **   <a name="opensearchserverless-Type-CollectionGroupErrorDetail-id"></a>
If the request contains collection group IDs, the response includes the IDs provided in the request.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** name **   <a name="opensearchserverless-Type-CollectionGroupErrorDetail-name"></a>
If the request contains collection group names, the response includes the names provided in the request.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

## See Also
<a name="API_CollectionGroupErrorDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CollectionGroupErrorDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CollectionGroupErrorDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CollectionGroupErrorDetail) 

# CollectionGroupSummary
<a name="API_CollectionGroupSummary"></a>

Summary information about a collection group.

## Contents
<a name="API_CollectionGroupSummary_Contents"></a>

 ** arn **   <a name="opensearchserverless-Type-CollectionGroupSummary-arn"></a>
The Amazon Resource Name (ARN) of the collection group.  
Type: String  
Required: No

 ** capacityLimits **   <a name="opensearchserverless-Type-CollectionGroupSummary-capacityLimits"></a>
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.  
Type: [CollectionGroupCapacityLimits](API_CollectionGroupCapacityLimits.md) object  
Required: No

 ** createdDate **   <a name="opensearchserverless-Type-CollectionGroupSummary-createdDate"></a>
The Epoch time when the collection group was created.  
Type: Long  
Required: No

 ** id **   <a name="opensearchserverless-Type-CollectionGroupSummary-id"></a>
The unique identifier of the collection group.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** name **   <a name="opensearchserverless-Type-CollectionGroupSummary-name"></a>
The name of the collection group.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** numberOfCollections **   <a name="opensearchserverless-Type-CollectionGroupSummary-numberOfCollections"></a>
The number of collections within the collection group.  
Type: Integer  
Required: No

## See Also
<a name="API_CollectionGroupSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CollectionGroupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CollectionGroupSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CollectionGroupSummary) 

# CollectionSummary
<a name="API_CollectionSummary"></a>

Details about each OpenSearch Serverless collection.

## Contents
<a name="API_CollectionSummary_Contents"></a>

 ** arn **   <a name="opensearchserverless-Type-CollectionSummary-arn"></a>
The Amazon Resource Name (ARN) of the collection.  
Type: String  
Required: No

 ** collectionGroupName **   <a name="opensearchserverless-Type-CollectionSummary-collectionGroupName"></a>
The name of the collection group that contains this collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** id **   <a name="opensearchserverless-Type-CollectionSummary-id"></a>
The unique identifier of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** kmsKeyArn **   <a name="opensearchserverless-Type-CollectionSummary-kmsKeyArn"></a>
The ARN of the AWS Key Management Service key used to encrypt the collection.  
Type: String  
Required: No

 ** name **   <a name="opensearchserverless-Type-CollectionSummary-name"></a>
The name of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** status **   <a name="opensearchserverless-Type-CollectionSummary-status"></a>
The current status of the collection.  
Type: String  
Valid Values: `CREATING | DELETING | ACTIVE | FAILED`   
Required: No

## See Also
<a name="API_CollectionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CollectionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CollectionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CollectionSummary) 

# CreateCollectionDetail
<a name="API_CreateCollectionDetail"></a>

Details about the created OpenSearch Serverless collection.

## Contents
<a name="API_CreateCollectionDetail_Contents"></a>

 ** arn **   <a name="opensearchserverless-Type-CreateCollectionDetail-arn"></a>
The Amazon Resource Name (ARN) of the collection.  
Type: String  
Required: No

 ** collectionGroupName **   <a name="opensearchserverless-Type-CreateCollectionDetail-collectionGroupName"></a>
The name of the collection group that contains this collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** createdDate **   <a name="opensearchserverless-Type-CreateCollectionDetail-createdDate"></a>
The Epoch time when the collection was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-CreateCollectionDetail-description"></a>
A description of the collection.  
Type: String  
Required: No

 ** id **   <a name="opensearchserverless-Type-CreateCollectionDetail-id"></a>
The unique identifier of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** kmsKeyArn **   <a name="opensearchserverless-Type-CreateCollectionDetail-kmsKeyArn"></a>
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.  
Type: String  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-CreateCollectionDetail-lastModifiedDate"></a>
The date and time when the collection was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-CreateCollectionDetail-name"></a>
The name of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** standbyReplicas **   <a name="opensearchserverless-Type-CreateCollectionDetail-standbyReplicas"></a>
Creates details about an OpenSearch Serverless collection.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** status **   <a name="opensearchserverless-Type-CreateCollectionDetail-status"></a>
The current status of the collection.  
Type: String  
Valid Values: `CREATING | DELETING | ACTIVE | FAILED`   
Required: No

 ** type **   <a name="opensearchserverless-Type-CreateCollectionDetail-type"></a>
The type of collection.  
Type: String  
Valid Values: `SEARCH | TIMESERIES | VECTORSEARCH`   
Required: No

 ** vectorOptions **   <a name="opensearchserverless-Type-CreateCollectionDetail-vectorOptions"></a>
Configuration options for vector search capabilities in the collection.  
Type: [VectorOptions](API_VectorOptions.md) object  
Required: No

## See Also
<a name="API_CreateCollectionDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CreateCollectionDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CreateCollectionDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CreateCollectionDetail) 

# CreateCollectionGroupDetail
<a name="API_CreateCollectionGroupDetail"></a>

Details about the created collection group.

## Contents
<a name="API_CreateCollectionGroupDetail_Contents"></a>

 ** arn **   <a name="opensearchserverless-Type-CreateCollectionGroupDetail-arn"></a>
The Amazon Resource Name (ARN) of the collection group.  
Type: String  
Required: No

 ** capacityLimits **   <a name="opensearchserverless-Type-CreateCollectionGroupDetail-capacityLimits"></a>
The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).  
Type: [CollectionGroupCapacityLimits](API_CollectionGroupCapacityLimits.md) object  
Required: No

 ** createdDate **   <a name="opensearchserverless-Type-CreateCollectionGroupDetail-createdDate"></a>
The Epoch time when the collection group was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-CreateCollectionGroupDetail-description"></a>
The description of the collection group.  
Type: String  
Required: No

 ** id **   <a name="opensearchserverless-Type-CreateCollectionGroupDetail-id"></a>
The unique identifier of the collection group.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** name **   <a name="opensearchserverless-Type-CreateCollectionGroupDetail-name"></a>
The name of the collection group.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** standbyReplicas **   <a name="opensearchserverless-Type-CreateCollectionGroupDetail-standbyReplicas"></a>
Indicates whether standby replicas are used for the collection group.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** tags **   <a name="opensearchserverless-Type-CreateCollectionGroupDetail-tags"></a>
A map of key-value pairs associated with the collection group.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## See Also
<a name="API_CreateCollectionGroupDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CreateCollectionGroupDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CreateCollectionGroupDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CreateCollectionGroupDetail) 

# CreateIamIdentityCenterConfigOptions
<a name="API_CreateIamIdentityCenterConfigOptions"></a>

Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.

## Contents
<a name="API_CreateIamIdentityCenterConfigOptions_Contents"></a>

 ** instanceArn **   <a name="opensearchserverless-Type-CreateIamIdentityCenterConfigOptions-instanceArn"></a>
The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** groupAttribute **   <a name="opensearchserverless-Type-CreateIamIdentityCenterConfigOptions-groupAttribute"></a>
The group attribute for this IAM Identity Center integration. Defaults to `GroupId`.  
Type: String  
Valid Values: `GroupId | GroupName`   
Required: No

 ** userAttribute **   <a name="opensearchserverless-Type-CreateIamIdentityCenterConfigOptions-userAttribute"></a>
The user attribute for this IAM Identity Center integration. Defaults to `UserId`.  
Type: String  
Valid Values: `UserId | UserName | Email`   
Required: No

## See Also
<a name="API_CreateIamIdentityCenterConfigOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CreateIamIdentityCenterConfigOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CreateIamIdentityCenterConfigOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CreateIamIdentityCenterConfigOptions) 

# CreateVpcEndpointDetail
<a name="API_CreateVpcEndpointDetail"></a>

Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see [Access Amazon OpenSearch Serverless using an interface endpoint](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html).

## Contents
<a name="API_CreateVpcEndpointDetail_Contents"></a>

 ** id **   <a name="opensearchserverless-Type-CreateVpcEndpointDetail-id"></a>
The unique identifier of the endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `vpce-[0-9a-z]*`   
Required: No

 ** name **   <a name="opensearchserverless-Type-CreateVpcEndpointDetail-name"></a>
The name of the endpoint.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** status **   <a name="opensearchserverless-Type-CreateVpcEndpointDetail-status"></a>
The current status in the endpoint creation process.  
Type: String  
Valid Values: `PENDING | DELETING | ACTIVE | FAILED`   
Required: No

## See Also
<a name="API_CreateVpcEndpointDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CreateVpcEndpointDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CreateVpcEndpointDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CreateVpcEndpointDetail) 

# DeleteCollectionDetail
<a name="API_DeleteCollectionDetail"></a>

Details about a deleted OpenSearch Serverless collection.

## Contents
<a name="API_DeleteCollectionDetail_Contents"></a>

 ** id **   <a name="opensearchserverless-Type-DeleteCollectionDetail-id"></a>
The unique identifier of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** name **   <a name="opensearchserverless-Type-DeleteCollectionDetail-name"></a>
The name of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** status **   <a name="opensearchserverless-Type-DeleteCollectionDetail-status"></a>
The current status of the collection.  
Type: String  
Valid Values: `CREATING | DELETING | ACTIVE | FAILED`   
Required: No

## See Also
<a name="API_DeleteCollectionDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/DeleteCollectionDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/DeleteCollectionDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/DeleteCollectionDetail) 

# DeleteVpcEndpointDetail
<a name="API_DeleteVpcEndpointDetail"></a>

Deletion details for an OpenSearch Serverless-managed interface endpoint.

## Contents
<a name="API_DeleteVpcEndpointDetail_Contents"></a>

 ** id **   <a name="opensearchserverless-Type-DeleteVpcEndpointDetail-id"></a>
The unique identifier of the endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `vpce-[0-9a-z]*`   
Required: No

 ** name **   <a name="opensearchserverless-Type-DeleteVpcEndpointDetail-name"></a>
The name of the endpoint.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** status **   <a name="opensearchserverless-Type-DeleteVpcEndpointDetail-status"></a>
The current status of the endpoint deletion process.  
Type: String  
Valid Values: `PENDING | DELETING | ACTIVE | FAILED`   
Required: No

## See Also
<a name="API_DeleteVpcEndpointDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/DeleteVpcEndpointDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/DeleteVpcEndpointDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/DeleteVpcEndpointDetail) 

# EffectiveLifecyclePolicyDetail
<a name="API_EffectiveLifecyclePolicyDetail"></a>

Error information for an OpenSearch Serverless request.

## Contents
<a name="API_EffectiveLifecyclePolicyDetail_Contents"></a>

 ** noMinRetentionPeriod **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyDetail-noMinRetentionPeriod"></a>
The minimum number of index retention days set. That is an optional param that will return as `true` if the minimum number of days or hours is not set to a index resource.  
Type: Boolean  
Required: No

 ** policyName **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyDetail-policyName"></a>
The name of the lifecycle policy.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** resource **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyDetail-resource"></a>
The name of the OpenSearch Serverless index resource.  
Type: String  
Required: No

 ** resourceType **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyDetail-resourceType"></a>
The type of OpenSearch Serverless resource. Currently, the only supported resource is `index`.  
Type: String  
Valid Values: `index`   
Required: No

 ** retentionPeriod **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyDetail-retentionPeriod"></a>
The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.  
Type: String  
Required: No

 ** type **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyDetail-type"></a>
The type of lifecycle policy.  
Type: String  
Valid Values: `retention`   
Required: No

## See Also
<a name="API_EffectiveLifecyclePolicyDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/EffectiveLifecyclePolicyDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/EffectiveLifecyclePolicyDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/EffectiveLifecyclePolicyDetail) 

# EffectiveLifecyclePolicyErrorDetail
<a name="API_EffectiveLifecyclePolicyErrorDetail"></a>

Error information for an OpenSearch Serverless request.

## Contents
<a name="API_EffectiveLifecyclePolicyErrorDetail_Contents"></a>

 ** errorCode **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyErrorDetail-errorCode"></a>
The error code for the request.  
Type: String  
Required: No

 ** errorMessage **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyErrorDetail-errorMessage"></a>
A description of the error. For example, `The specified Index resource is not found`.  
Type: String  
Required: No

 ** resource **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyErrorDetail-resource"></a>
The name of OpenSearch Serverless index resource.  
Type: String  
Required: No

 ** type **   <a name="opensearchserverless-Type-EffectiveLifecyclePolicyErrorDetail-type"></a>
The type of lifecycle policy.  
Type: String  
Valid Values: `retention`   
Required: No

## See Also
<a name="API_EffectiveLifecyclePolicyErrorDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/EffectiveLifecyclePolicyErrorDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/EffectiveLifecyclePolicyErrorDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/EffectiveLifecyclePolicyErrorDetail) 

# EncryptionConfig
<a name="API_EncryptionConfig"></a>

Encryption settings for a collection.

## Contents
<a name="API_EncryptionConfig_Contents"></a>

 ** aWSOwnedKey **   <a name="opensearchserverless-Type-EncryptionConfig-aWSOwnedKey"></a>
Indicates whether to use an AWS-owned key for encryption.  
Type: Boolean  
Required: No

 ** kmsKeyArn **   <a name="opensearchserverless-Type-EncryptionConfig-kmsKeyArn"></a>
The ARN of the AWS Key Management Service key used to encrypt the collection.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 100.  
Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

## See Also
<a name="API_EncryptionConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/EncryptionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/EncryptionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/EncryptionConfig) 

# FipsEndpoints
<a name="API_FipsEndpoints"></a>

FIPS-compliant endpoint URLs for an OpenSearch Serverless collection. These endpoints ensure all data transmission uses FIPS 140-3 validated cryptographic implementations, meeting federal security requirements for government workloads.

## Contents
<a name="API_FipsEndpoints_Contents"></a>

 ** collectionEndpoint **   <a name="opensearchserverless-Type-FipsEndpoints-collectionEndpoint"></a>
FIPS-compliant collection endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads.  
Type: String  
Required: No

 ** dashboardEndpoint **   <a name="opensearchserverless-Type-FipsEndpoints-dashboardEndpoint"></a>
FIPS-compliant endpoint used to access OpenSearch Dashboards. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads that need dashboard visualization capabilities.  
Type: String  
Required: No

## See Also
<a name="API_FipsEndpoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/FipsEndpoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/FipsEndpoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/FipsEndpoints) 

# IamFederationConfigOptions
<a name="API_IamFederationConfigOptions"></a>

Describes IAM federation options for an OpenSearch Serverless security configuration in the form of a key-value map. These options define how OpenSearch Serverless integrates with external identity providers using federation.

## Contents
<a name="API_IamFederationConfigOptions_Contents"></a>

 ** groupAttribute **   <a name="opensearchserverless-Type-IamFederationConfigOptions-groupAttribute"></a>
The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z][A-Za-z0-9_.:/=+\-@]*`   
Required: No

 ** userAttribute **   <a name="opensearchserverless-Type-IamFederationConfigOptions-userAttribute"></a>
The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z][A-Za-z0-9_.:/=+\-@]*`   
Required: No

## See Also
<a name="API_IamFederationConfigOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/IamFederationConfigOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/IamFederationConfigOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/IamFederationConfigOptions) 

# IamIdentityCenterConfigOptions
<a name="API_IamIdentityCenterConfigOptions"></a>

Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.

## Contents
<a name="API_IamIdentityCenterConfigOptions_Contents"></a>

 ** applicationArn **   <a name="opensearchserverless-Type-IamIdentityCenterConfigOptions-applicationArn"></a>
The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: No

 ** applicationDescription **   <a name="opensearchserverless-Type-IamIdentityCenterConfigOptions-applicationDescription"></a>
The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.  
Type: String  
Required: No

 ** applicationName **   <a name="opensearchserverless-Type-IamIdentityCenterConfigOptions-applicationName"></a>
The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.  
Type: String  
Required: No

 ** groupAttribute **   <a name="opensearchserverless-Type-IamIdentityCenterConfigOptions-groupAttribute"></a>
The group attribute for this IAM Identity Center integration. Defaults to `GroupId`.  
Type: String  
Valid Values: `GroupId | GroupName`   
Required: No

 ** instanceArn **   <a name="opensearchserverless-Type-IamIdentityCenterConfigOptions-instanceArn"></a>
The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: No

 ** userAttribute **   <a name="opensearchserverless-Type-IamIdentityCenterConfigOptions-userAttribute"></a>
The user attribute for this IAM Identity Center integration. Defaults to `UserId`   
Type: String  
Valid Values: `UserId | UserName | Email`   
Required: No

## See Also
<a name="API_IamIdentityCenterConfigOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/IamIdentityCenterConfigOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/IamIdentityCenterConfigOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/IamIdentityCenterConfigOptions) 

# LifecyclePolicyDetail
<a name="API_LifecyclePolicyDetail"></a>

Details about an OpenSearch Serverless lifecycle policy.

## Contents
<a name="API_LifecyclePolicyDetail_Contents"></a>

 ** createdDate **   <a name="opensearchserverless-Type-LifecyclePolicyDetail-createdDate"></a>
The date the lifecycle policy was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-LifecyclePolicyDetail-description"></a>
The description of the lifecycle policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-LifecyclePolicyDetail-lastModifiedDate"></a>
The timestamp of when the lifecycle policy was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-LifecyclePolicyDetail-name"></a>
The name of the lifecycle policy.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** policy **   <a name="opensearchserverless-Type-LifecyclePolicyDetail-policy"></a>
The JSON policy document without any whitespaces.  
Type: JSON value  
Required: No

 ** policyVersion **   <a name="opensearchserverless-Type-LifecyclePolicyDetail-policyVersion"></a>
The version of the lifecycle policy.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 36.  
Pattern: `([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?`   
Required: No

 ** type **   <a name="opensearchserverless-Type-LifecyclePolicyDetail-type"></a>
The type of lifecycle policy.  
Type: String  
Valid Values: `retention`   
Required: No

## See Also
<a name="API_LifecyclePolicyDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/LifecyclePolicyDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/LifecyclePolicyDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/LifecyclePolicyDetail) 

# LifecyclePolicyErrorDetail
<a name="API_LifecyclePolicyErrorDetail"></a>

Error information for an OpenSearch Serverless request.

## Contents
<a name="API_LifecyclePolicyErrorDetail_Contents"></a>

 ** errorCode **   <a name="opensearchserverless-Type-LifecyclePolicyErrorDetail-errorCode"></a>
The error code for the request. For example, `NOT_FOUND`.  
Type: String  
Required: No

 ** errorMessage **   <a name="opensearchserverless-Type-LifecyclePolicyErrorDetail-errorMessage"></a>
A description of the error. For example, `The specified Lifecycle Policy is not found`.  
Type: String  
Required: No

 ** name **   <a name="opensearchserverless-Type-LifecyclePolicyErrorDetail-name"></a>
The name of the lifecycle policy.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** type **   <a name="opensearchserverless-Type-LifecyclePolicyErrorDetail-type"></a>
The type of lifecycle policy.  
Type: String  
Valid Values: `retention`   
Required: No

## See Also
<a name="API_LifecyclePolicyErrorDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/LifecyclePolicyErrorDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/LifecyclePolicyErrorDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/LifecyclePolicyErrorDetail) 

# LifecyclePolicyIdentifier
<a name="API_LifecyclePolicyIdentifier"></a>

The unique identifiers of policy types and policy names.

## Contents
<a name="API_LifecyclePolicyIdentifier_Contents"></a>

 ** name **   <a name="opensearchserverless-Type-LifecyclePolicyIdentifier-name"></a>
The name of the lifecycle policy.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: Yes

 ** type **   <a name="opensearchserverless-Type-LifecyclePolicyIdentifier-type"></a>
The type of lifecycle policy.  
Type: String  
Valid Values: `retention`   
Required: Yes

## See Also
<a name="API_LifecyclePolicyIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/LifecyclePolicyIdentifier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/LifecyclePolicyIdentifier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/LifecyclePolicyIdentifier) 

# LifecyclePolicyResourceIdentifier
<a name="API_LifecyclePolicyResourceIdentifier"></a>

The unique identifiers of policy types and resource names.

## Contents
<a name="API_LifecyclePolicyResourceIdentifier_Contents"></a>

 ** resource **   <a name="opensearchserverless-Type-LifecyclePolicyResourceIdentifier-resource"></a>
The name of the OpenSearch Serverless ilndex resource.  
Type: String  
Pattern: `index/[a-z][a-z0-9-]{3,32}/([a-z;0-9&$%][+.~=\-_a-z;0-9&$%]*)`   
Required: Yes

 ** type **   <a name="opensearchserverless-Type-LifecyclePolicyResourceIdentifier-type"></a>
The type of lifecycle policy.  
Type: String  
Valid Values: `retention`   
Required: Yes

## See Also
<a name="API_LifecyclePolicyResourceIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/LifecyclePolicyResourceIdentifier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/LifecyclePolicyResourceIdentifier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/LifecyclePolicyResourceIdentifier) 

# LifecyclePolicyStats
<a name="API_LifecyclePolicyStats"></a>

Statistics for an OpenSearch Serverless lifecycle policy.

## Contents
<a name="API_LifecyclePolicyStats_Contents"></a>

 ** RetentionPolicyCount **   <a name="opensearchserverless-Type-LifecyclePolicyStats-RetentionPolicyCount"></a>
The number of retention lifecycle policies in the current account.  
Type: Long  
Required: No

## See Also
<a name="API_LifecyclePolicyStats_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/LifecyclePolicyStats) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/LifecyclePolicyStats) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/LifecyclePolicyStats) 

# LifecyclePolicySummary
<a name="API_LifecyclePolicySummary"></a>

A summary of the lifecycle policy.

## Contents
<a name="API_LifecyclePolicySummary_Contents"></a>

 ** createdDate **   <a name="opensearchserverless-Type-LifecyclePolicySummary-createdDate"></a>
The Epoch time when the lifecycle policy was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-LifecyclePolicySummary-description"></a>
The description of the lifecycle policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-LifecyclePolicySummary-lastModifiedDate"></a>
The date and time when the lifecycle policy was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-LifecyclePolicySummary-name"></a>
The name of the lifecycle policy.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** policyVersion **   <a name="opensearchserverless-Type-LifecyclePolicySummary-policyVersion"></a>
The version of the lifecycle policy.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 36.  
Pattern: `([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?`   
Required: No

 ** type **   <a name="opensearchserverless-Type-LifecyclePolicySummary-type"></a>
The type of lifecycle policy.  
Type: String  
Valid Values: `retention`   
Required: No

## See Also
<a name="API_LifecyclePolicySummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/LifecyclePolicySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/LifecyclePolicySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/LifecyclePolicySummary) 

# SamlConfigOptions
<a name="API_SamlConfigOptions"></a>

Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.

## Contents
<a name="API_SamlConfigOptions_Contents"></a>

 ** metadata **   <a name="opensearchserverless-Type-SamlConfigOptions-metadata"></a>
The XML IdP metadata file generated from your identity provider.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Pattern: `.*[\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]+.*`   
Required: Yes

 ** groupAttribute **   <a name="opensearchserverless-Type-SamlConfigOptions-groupAttribute"></a>
The group attribute for this SAML integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*[\w+=,.@-]+.*`   
Required: No

 ** openSearchServerlessEntityId **   <a name="opensearchserverless-Type-SamlConfigOptions-openSearchServerlessEntityId"></a>
Custom entity ID attribute to override the default entity ID for this SAML integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `aws:opensearch:[0-9]{12}:*.*`   
Required: No

 ** sessionTimeout **   <a name="opensearchserverless-Type-SamlConfigOptions-sessionTimeout"></a>
The session timeout, in minutes. Default is 60 minutes (12 hours).  
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 720.  
Required: No

 ** userAttribute **   <a name="opensearchserverless-Type-SamlConfigOptions-userAttribute"></a>
A user attribute for this SAML integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*[\w+=,.@-]+.*`   
Required: No

## See Also
<a name="API_SamlConfigOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/SamlConfigOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/SamlConfigOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/SamlConfigOptions) 

# SecurityConfigDetail
<a name="API_SecurityConfigDetail"></a>

Details about a security configuration for OpenSearch Serverless.

## Contents
<a name="API_SecurityConfigDetail_Contents"></a>

 ** configVersion **   <a name="opensearchserverless-Type-SecurityConfigDetail-configVersion"></a>
The version of the security configuration.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 36.  
Pattern: `([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?`   
Required: No

 ** createdDate **   <a name="opensearchserverless-Type-SecurityConfigDetail-createdDate"></a>
The date the configuration was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-SecurityConfigDetail-description"></a>
The description of the security configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** iamFederationOptions **   <a name="opensearchserverless-Type-SecurityConfigDetail-iamFederationOptions"></a>
Describes IAM federation options in the form of a key-value map. Contains configuration details about how OpenSearch Serverless integrates with external identity providers through federation.  
Type: [IamFederationConfigOptions](API_IamFederationConfigOptions.md) object  
Required: No

 ** iamIdentityCenterOptions **   <a name="opensearchserverless-Type-SecurityConfigDetail-iamIdentityCenterOptions"></a>
Describes IAM Identity Center options in the form of a key-value map.  
Type: [IamIdentityCenterConfigOptions](API_IamIdentityCenterConfigOptions.md) object  
Required: No

 ** id **   <a name="opensearchserverless-Type-SecurityConfigDetail-id"></a>
The unique identifier of the security configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-SecurityConfigDetail-lastModifiedDate"></a>
The timestamp of when the configuration was last modified.  
Type: Long  
Required: No

 ** samlOptions **   <a name="opensearchserverless-Type-SecurityConfigDetail-samlOptions"></a>
SAML options for the security configuration in the form of a key-value map.  
Type: [SamlConfigOptions](API_SamlConfigOptions.md) object  
Required: No

 ** type **   <a name="opensearchserverless-Type-SecurityConfigDetail-type"></a>
The type of security configuration.  
Type: String  
Valid Values: `saml | iamidentitycenter | iamfederation`   
Required: No

## See Also
<a name="API_SecurityConfigDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/SecurityConfigDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/SecurityConfigDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/SecurityConfigDetail) 

# SecurityConfigStats
<a name="API_SecurityConfigStats"></a>

Statistics for an OpenSearch Serverless security configuration.

## Contents
<a name="API_SecurityConfigStats_Contents"></a>

 ** SamlConfigCount **   <a name="opensearchserverless-Type-SecurityConfigStats-SamlConfigCount"></a>
The number of security configurations in the current account.  
Type: Long  
Required: No

## See Also
<a name="API_SecurityConfigStats_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/SecurityConfigStats) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/SecurityConfigStats) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/SecurityConfigStats) 

# SecurityConfigSummary
<a name="API_SecurityConfigSummary"></a>

A summary of a security configuration for OpenSearch Serverless.

## Contents
<a name="API_SecurityConfigSummary_Contents"></a>

 ** configVersion **   <a name="opensearchserverless-Type-SecurityConfigSummary-configVersion"></a>
The version of the security configuration.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 36.  
Pattern: `([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?`   
Required: No

 ** createdDate **   <a name="opensearchserverless-Type-SecurityConfigSummary-createdDate"></a>
The Epoch time when the security configuration was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-SecurityConfigSummary-description"></a>
The description of the security configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** id **   <a name="opensearchserverless-Type-SecurityConfigSummary-id"></a>
The unique identifier of the security configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-SecurityConfigSummary-lastModifiedDate"></a>
The timestamp of when the configuration was last modified.  
Type: Long  
Required: No

 ** type **   <a name="opensearchserverless-Type-SecurityConfigSummary-type"></a>
The type of security configuration.  
Type: String  
Valid Values: `saml | iamidentitycenter | iamfederation`   
Required: No

## See Also
<a name="API_SecurityConfigSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/SecurityConfigSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/SecurityConfigSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/SecurityConfigSummary) 

# SecurityPolicyDetail
<a name="API_SecurityPolicyDetail"></a>

Details about an OpenSearch Serverless security policy.

## Contents
<a name="API_SecurityPolicyDetail_Contents"></a>

 ** createdDate **   <a name="opensearchserverless-Type-SecurityPolicyDetail-createdDate"></a>
The date the policy was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-SecurityPolicyDetail-description"></a>
The description of the security policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-SecurityPolicyDetail-lastModifiedDate"></a>
The timestamp of when the policy was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-SecurityPolicyDetail-name"></a>
The name of the policy.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** policy **   <a name="opensearchserverless-Type-SecurityPolicyDetail-policy"></a>
The JSON policy document without any whitespaces.  
Type: JSON value  
Required: No

 ** policyVersion **   <a name="opensearchserverless-Type-SecurityPolicyDetail-policyVersion"></a>
The version of the policy.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 36.  
Pattern: `([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?`   
Required: No

 ** type **   <a name="opensearchserverless-Type-SecurityPolicyDetail-type"></a>
The type of security policy.  
Type: String  
Valid Values: `encryption | network`   
Required: No

## See Also
<a name="API_SecurityPolicyDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/SecurityPolicyDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/SecurityPolicyDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/SecurityPolicyDetail) 

# SecurityPolicyStats
<a name="API_SecurityPolicyStats"></a>

Statistics for an OpenSearch Serverless security policy.

## Contents
<a name="API_SecurityPolicyStats_Contents"></a>

 ** EncryptionPolicyCount **   <a name="opensearchserverless-Type-SecurityPolicyStats-EncryptionPolicyCount"></a>
The number of encryption policies in the current account.  
Type: Long  
Required: No

 ** NetworkPolicyCount **   <a name="opensearchserverless-Type-SecurityPolicyStats-NetworkPolicyCount"></a>
The number of network policies in the current account.  
Type: Long  
Required: No

## See Also
<a name="API_SecurityPolicyStats_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/SecurityPolicyStats) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/SecurityPolicyStats) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/SecurityPolicyStats) 

# SecurityPolicySummary
<a name="API_SecurityPolicySummary"></a>

A summary of a security policy for OpenSearch Serverless.

## Contents
<a name="API_SecurityPolicySummary_Contents"></a>

 ** createdDate **   <a name="opensearchserverless-Type-SecurityPolicySummary-createdDate"></a>
The date the policy was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-SecurityPolicySummary-description"></a>
The description of the security policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-SecurityPolicySummary-lastModifiedDate"></a>
The timestamp of when the policy was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-SecurityPolicySummary-name"></a>
The name of the policy.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** policyVersion **   <a name="opensearchserverless-Type-SecurityPolicySummary-policyVersion"></a>
The version of the policy.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 36.  
Pattern: `([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?`   
Required: No

 ** type **   <a name="opensearchserverless-Type-SecurityPolicySummary-type"></a>
The type of security policy.  
Type: String  
Valid Values: `encryption | network`   
Required: No

## See Also
<a name="API_SecurityPolicySummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/SecurityPolicySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/SecurityPolicySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/SecurityPolicySummary) 

# Tag
<a name="API_Tag"></a>

A map of key-value pairs associated to an OpenSearch Serverless resource.

## Contents
<a name="API_Tag_Contents"></a>

 ** key **   <a name="opensearchserverless-Type-Tag-key"></a>
The key to use in the tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** value **   <a name="opensearchserverless-Type-Tag-value"></a>
The value of the tag.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/Tag) 

# UpdateCollectionDetail
<a name="API_UpdateCollectionDetail"></a>

Details about an updated OpenSearch Serverless collection.

## Contents
<a name="API_UpdateCollectionDetail_Contents"></a>

 ** arn **   <a name="opensearchserverless-Type-UpdateCollectionDetail-arn"></a>
The Amazon Resource Name (ARN) of the collection.  
Type: String  
Required: No

 ** createdDate **   <a name="opensearchserverless-Type-UpdateCollectionDetail-createdDate"></a>
The date and time when the collection was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-UpdateCollectionDetail-description"></a>
The description of the collection.  
Type: String  
Required: No

 ** id **   <a name="opensearchserverless-Type-UpdateCollectionDetail-id"></a>
The unique identifier of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-UpdateCollectionDetail-lastModifiedDate"></a>
The date and time when the collection was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-UpdateCollectionDetail-name"></a>
The name of the collection.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** status **   <a name="opensearchserverless-Type-UpdateCollectionDetail-status"></a>
The current status of the collection.  
Type: String  
Valid Values: `CREATING | DELETING | ACTIVE | FAILED`   
Required: No

 ** type **   <a name="opensearchserverless-Type-UpdateCollectionDetail-type"></a>
The collection type.  
Type: String  
Valid Values: `SEARCH | TIMESERIES | VECTORSEARCH`   
Required: No

## See Also
<a name="API_UpdateCollectionDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/UpdateCollectionDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/UpdateCollectionDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/UpdateCollectionDetail) 

# UpdateCollectionGroupDetail
<a name="API_UpdateCollectionGroupDetail"></a>

Details about the updated collection group.

## Contents
<a name="API_UpdateCollectionGroupDetail_Contents"></a>

 ** arn **   <a name="opensearchserverless-Type-UpdateCollectionGroupDetail-arn"></a>
The Amazon Resource Name (ARN) of the collection group.  
Type: String  
Required: No

 ** capacityLimits **   <a name="opensearchserverless-Type-UpdateCollectionGroupDetail-capacityLimits"></a>
The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).  
Type: [CollectionGroupCapacityLimits](API_CollectionGroupCapacityLimits.md) object  
Required: No

 ** createdDate **   <a name="opensearchserverless-Type-UpdateCollectionGroupDetail-createdDate"></a>
The Epoch time when the collection group was created.  
Type: Long  
Required: No

 ** description **   <a name="opensearchserverless-Type-UpdateCollectionGroupDetail-description"></a>
The description of the collection group.  
Type: String  
Required: No

 ** id **   <a name="opensearchserverless-Type-UpdateCollectionGroupDetail-id"></a>
The unique identifier of the collection group.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-z0-9]{3,40}`   
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-UpdateCollectionGroupDetail-lastModifiedDate"></a>
The date and time when the collection group was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-UpdateCollectionGroupDetail-name"></a>
The name of the collection group.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

## See Also
<a name="API_UpdateCollectionGroupDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/UpdateCollectionGroupDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/UpdateCollectionGroupDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/UpdateCollectionGroupDetail) 

# UpdateIamIdentityCenterConfigOptions
<a name="API_UpdateIamIdentityCenterConfigOptions"></a>

Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.

## Contents
<a name="API_UpdateIamIdentityCenterConfigOptions_Contents"></a>

 ** groupAttribute **   <a name="opensearchserverless-Type-UpdateIamIdentityCenterConfigOptions-groupAttribute"></a>
The group attribute for this IAM Identity Center integration. Defaults to `GroupId`.  
Type: String  
Valid Values: `GroupId | GroupName`   
Required: No

 ** userAttribute **   <a name="opensearchserverless-Type-UpdateIamIdentityCenterConfigOptions-userAttribute"></a>
The user attribute for this IAM Identity Center integration. Defaults to `UserId`.  
Type: String  
Valid Values: `UserId | UserName | Email`   
Required: No

## See Also
<a name="API_UpdateIamIdentityCenterConfigOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/UpdateIamIdentityCenterConfigOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/UpdateIamIdentityCenterConfigOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/UpdateIamIdentityCenterConfigOptions) 

# UpdateVpcEndpointDetail
<a name="API_UpdateVpcEndpointDetail"></a>

Update details for an OpenSearch Serverless-managed interface endpoint.

## Contents
<a name="API_UpdateVpcEndpointDetail_Contents"></a>

 ** id **   <a name="opensearchserverless-Type-UpdateVpcEndpointDetail-id"></a>
The unique identifier of the endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `vpce-[0-9a-z]*`   
Required: No

 ** lastModifiedDate **   <a name="opensearchserverless-Type-UpdateVpcEndpointDetail-lastModifiedDate"></a>
The timestamp of when the endpoint was last modified.  
Type: Long  
Required: No

 ** name **   <a name="opensearchserverless-Type-UpdateVpcEndpointDetail-name"></a>
The name of the endpoint.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** securityGroupIds **   <a name="opensearchserverless-Type-UpdateVpcEndpointDetail-securityGroupIds"></a>
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w+\-]+`   
Required: No

 ** status **   <a name="opensearchserverless-Type-UpdateVpcEndpointDetail-status"></a>
The current status of the endpoint update process.  
Type: String  
Valid Values: `PENDING | DELETING | ACTIVE | FAILED`   
Required: No

 ** subnetIds **   <a name="opensearchserverless-Type-UpdateVpcEndpointDetail-subnetIds"></a>
The ID of the subnets from which you access OpenSearch Serverless.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `subnet-([0-9a-f]{8}|[0-9a-f]{17})`   
Required: No

## See Also
<a name="API_UpdateVpcEndpointDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/UpdateVpcEndpointDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/UpdateVpcEndpointDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/UpdateVpcEndpointDetail) 

# VectorOptions
<a name="API_VectorOptions"></a>

Configuration options for vector search capabilities in an OpenSearch Serverless collection.

## Contents
<a name="API_VectorOptions_Contents"></a>

 ** ServerlessVectorAcceleration **   <a name="opensearchserverless-Type-VectorOptions-ServerlessVectorAcceleration"></a>
Specifies whether serverless vector acceleration is enabled for the collection.  
Type: String  
Valid Values: `ENABLED | DISABLED | ALLOWED`   
Required: Yes

## See Also
<a name="API_VectorOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/VectorOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/VectorOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/VectorOptions) 

# VpcEndpointDetail
<a name="API_VpcEndpointDetail"></a>

Details about an OpenSearch Serverless-managed interface endpoint.

## Contents
<a name="API_VpcEndpointDetail_Contents"></a>

 ** createdDate **   <a name="opensearchserverless-Type-VpcEndpointDetail-createdDate"></a>
The date the endpoint was created.  
Type: Long  
Required: No

 ** failureCode **   <a name="opensearchserverless-Type-VpcEndpointDetail-failureCode"></a>
A failure code associated with the request.  
Type: String  
Required: No

 ** failureMessage **   <a name="opensearchserverless-Type-VpcEndpointDetail-failureMessage"></a>
A message associated with the failure code.  
Type: String  
Required: No

 ** id **   <a name="opensearchserverless-Type-VpcEndpointDetail-id"></a>
The unique identifier of the endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `vpce-[0-9a-z]*`   
Required: No

 ** name **   <a name="opensearchserverless-Type-VpcEndpointDetail-name"></a>
The name of the endpoint.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** securityGroupIds **   <a name="opensearchserverless-Type-VpcEndpointDetail-securityGroupIds"></a>
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w+\-]+`   
Required: No

 ** status **   <a name="opensearchserverless-Type-VpcEndpointDetail-status"></a>
The current status of the endpoint.  
Type: String  
Valid Values: `PENDING | DELETING | ACTIVE | FAILED`   
Required: No

 ** subnetIds **   <a name="opensearchserverless-Type-VpcEndpointDetail-subnetIds"></a>
The ID of the subnets from which you access OpenSearch Serverless.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `subnet-([0-9a-f]{8}|[0-9a-f]{17})`   
Required: No

 ** vpcId **   <a name="opensearchserverless-Type-VpcEndpointDetail-vpcId"></a>
The ID of the VPC from which you access OpenSearch Serverless.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `vpc-[0-9a-z]*`   
Required: No

## See Also
<a name="API_VpcEndpointDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/VpcEndpointDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/VpcEndpointDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/VpcEndpointDetail) 

# VpcEndpointErrorDetail
<a name="API_VpcEndpointErrorDetail"></a>

Error information for a failed `BatchGetVpcEndpoint` request.

## Contents
<a name="API_VpcEndpointErrorDetail_Contents"></a>

 ** errorCode **   <a name="opensearchserverless-Type-VpcEndpointErrorDetail-errorCode"></a>
The error code for the failed request.  
Type: String  
Required: No

 ** errorMessage **   <a name="opensearchserverless-Type-VpcEndpointErrorDetail-errorMessage"></a>
An error message describing the reason for the failure.  
Type: String  
Required: No

 ** id **   <a name="opensearchserverless-Type-VpcEndpointErrorDetail-id"></a>
The unique identifier of the VPC endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `vpce-[0-9a-z]*`   
Required: No

## See Also
<a name="API_VpcEndpointErrorDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/VpcEndpointErrorDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/VpcEndpointErrorDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/VpcEndpointErrorDetail) 

# VpcEndpointFilters
<a name="API_VpcEndpointFilters"></a>

Filter the results of a `ListVpcEndpoints` request.

## Contents
<a name="API_VpcEndpointFilters_Contents"></a>

 ** status **   <a name="opensearchserverless-Type-VpcEndpointFilters-status"></a>
The current status of the endpoint.  
Type: String  
Valid Values: `PENDING | DELETING | ACTIVE | FAILED`   
Required: No

## See Also
<a name="API_VpcEndpointFilters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/VpcEndpointFilters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/VpcEndpointFilters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/VpcEndpointFilters) 

# VpcEndpointSummary
<a name="API_VpcEndpointSummary"></a>

The VPC endpoint object.

## Contents
<a name="API_VpcEndpointSummary_Contents"></a>

 ** id **   <a name="opensearchserverless-Type-VpcEndpointSummary-id"></a>
The unique identifier of the endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `vpce-[0-9a-z]*`   
Required: No

 ** name **   <a name="opensearchserverless-Type-VpcEndpointSummary-name"></a>
The name of the endpoint.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: No

 ** status **   <a name="opensearchserverless-Type-VpcEndpointSummary-status"></a>
The current status of the endpoint.  
Type: String  
Valid Values: `PENDING | DELETING | ACTIVE | FAILED`   
Required: No

## See Also
<a name="API_VpcEndpointSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/VpcEndpointSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/VpcEndpointSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/VpcEndpointSummary)