Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.
OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.
To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?
", "operations": { "BatchGetCollection": "Returns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", "BatchGetCollectionGroup": "Returns attributes for one or more collection groups, including capacity limits and the number of collections in each group. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", "BatchGetEffectiveLifecyclePolicy": "Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.
", "BatchGetLifecyclePolicy": "Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
", "BatchGetVpcEndpoint": "Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", "CancelIngestionJob": "Cancels an in-progress ingestion job. Documents that were already indexed before the cancellation remain in the index.
", "CreateAccessPolicy": "Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.
", "CreateCollection": "Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", "CreateCollectionGroup": "Creates a collection group within OpenSearch Serverless. Collection groups let you manage OpenSearch Compute Units (OCUs) at a group level, with multiple collections sharing the group's capacity limits.
For more information, see Managing collection groups.
", "CreateIndex": "Creates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes created by this API are automatically configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment in the OpenSearch User Guide.
", "CreateIngestionJob": "Creates an ingestion job that performs a one-time bulk ingestion of data from an Amazon S3 bucket into an index in an OpenSearch Serverless collection. An ingestion job scans the source bucket, indexes the documents it finds, and then completes. To continuously ingest new data as it arrives, use CreateIngestionStream instead.
Creates an ingestion stream that continuously ingests data from an Amazon S3 bucket into an index in an OpenSearch Serverless collection. An ingestion stream processes Amazon S3 event notifications delivered to an Amazon SQS queue and ingests new objects as they arrive. The stream continues to ingest data until you delete it. To perform a one-time bulk ingestion instead, use CreateIngestionJob.
Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.
", "CreateSecurityConfig": "Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "CreateSecurityPolicy": "Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
", "CreateVpcEndpoint": "Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", "DeleteAccessPolicy": "Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
", "DeleteCollection": "Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", "DeleteCollectionGroup": "Deletes a collection group. You can only delete empty collection groups that contain no collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", "DeleteIndex": "Deletes an index from an OpenSearch Serverless collection. Be aware that the index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.
", "DeleteIngestionStream": "Deletes an ingestion stream. Documents that were already indexed by the stream remain in the index.
", "DeleteLifecyclePolicy": "Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.
", "DeleteSecurityConfig": "Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "DeleteSecurityPolicy": "Deletes an OpenSearch Serverless security policy.
", "DeleteVpcEndpoint": "Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", "GetAccessPolicy": "Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
", "GetAccountSettings": "Returns account-level settings related to OpenSearch Serverless.
", "GetIndex": "Retrieves information about an index in an OpenSearch Serverless collection, including its schema definition. The index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.
", "GetIngestionJob": "Returns information about an ingestion job, including its configuration, status, and processing state.
", "GetIngestionStream": "Returns information about an ingestion stream, including its configuration, status, and processing state.
", "GetPoliciesStats": "Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
", "GetSecurityConfig": "Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "GetSecurityPolicy": "Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
", "ListAccessPolicies": "Returns information about a list of OpenSearch Serverless access policies.
", "ListCollectionGroups": "Returns a list of collection groups. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", "ListCollections": "Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Make sure to include an empty request body {} if you don't include any collection filters in the request.
Returns a list of ingestion jobs in a collection.
", "ListIngestionStreams": "Returns a list of ingestion streams in a collection.
", "ListLifecyclePolicies": "Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
", "ListSecurityConfigs": "Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "ListSecurityPolicies": "Returns information about configured OpenSearch Serverless security policies.
", "ListTagsForResource": "Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
", "ListVpcEndpoints": "Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", "TagResource": "Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
", "UntagResource": "Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
", "UpdateAccessPolicy": "Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
", "UpdateAccountSettings": "Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
", "UpdateCollection": "Updates an OpenSearch Serverless collection.
", "UpdateCollectionGroup": "Updates the description and capacity limits of a collection group.
", "UpdateIndex": "Updates an existing index in an OpenSearch Serverless collection. This operation allows you to modify the index schema, including adding new fields or changing field mappings. You can also enable automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.
", "UpdateLifecyclePolicy": "Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.
", "UpdateSecurityConfig": "Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "UpdateSecurityPolicy": "Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
", "UpdateVpcEndpoint": "Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
" }, "shapes": { "AccessPolicyDetail": { "base": "Details about an OpenSearch Serverless access policy.
", "refs": { "CreateAccessPolicyResponse$accessPolicyDetail": "Details about the created access policy.
", "GetAccessPolicyResponse$accessPolicyDetail": "Details about the requested access policy.
", "UpdateAccessPolicyResponse$accessPolicyDetail": "Details about the updated access policy.
" } }, "AccessPolicyStats": { "base": "Statistics for an OpenSearch Serverless access policy.
", "refs": { "GetPoliciesStatsResponse$AccessPolicyStats": "Information about the data access policies in your account.
" } }, "AccessPolicySummaries": { "base": null, "refs": { "ListAccessPoliciesResponse$accessPolicySummaries": "Details about the requested access policies.
" } }, "AccessPolicySummary": { "base": "A summary of the data access policy.
", "refs": { "AccessPolicySummaries$member": null } }, "AccessPolicyType": { "base": null, "refs": { "AccessPolicyDetail$type": "The type of access policy.
", "AccessPolicySummary$type": "The type of access policy. Currently, the only available type is data.
The type of policy.
", "DeleteAccessPolicyRequest$type": "The type of policy.
", "GetAccessPolicyRequest$type": "Tye type of policy. Currently, the only supported value is data.
The type of access policy.
", "UpdateAccessPolicyRequest$type": "The type of policy.
" } }, "AccountSettingsDetail": { "base": "OpenSearch Serverless-related information for the current account.
", "refs": { "GetAccountSettingsResponse$accountSettingsDetail": "OpenSearch Serverless-related details for the current account.
", "UpdateAccountSettingsResponse$accountSettingsDetail": "OpenSearch Serverless-related settings for the current Amazon Web Services account.
" } }, "Arn": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.
The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.
The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.
The autoscaling status of an OpenSearch Serverless collection group: ACTION_SCALING_UP, ACTION_SCALING_DOWN, or NO_ACTION.
The current autoscaling status for the collection group.
" } }, "BatchGetCollectionGroupRequest": { "base": null, "refs": {} }, "BatchGetCollectionGroupResponse": { "base": null, "refs": {} }, "BatchGetCollectionRequest": { "base": null, "refs": {} }, "BatchGetCollectionResponse": { "base": null, "refs": {} }, "BatchGetEffectiveLifecyclePolicyRequest": { "base": null, "refs": {} }, "BatchGetEffectiveLifecyclePolicyResponse": { "base": null, "refs": {} }, "BatchGetLifecyclePolicyRequest": { "base": null, "refs": {} }, "BatchGetLifecyclePolicyResponse": { "base": null, "refs": {} }, "BatchGetVpcEndpointRequest": { "base": null, "refs": {} }, "BatchGetVpcEndpointResponse": { "base": null, "refs": {} }, "Boolean": { "base": null, "refs": { "EffectiveLifecyclePolicyDetail$noMinRetentionPeriod": "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.
Indicates whether to use an Amazon Web Services-owned key for encryption.
" } }, "BucketOwnerAccountId": { "base": null, "refs": { "IngestionJobS3Source$bucketOwnerAccountId": "The Amazon Web Services account ID that owns the Amazon S3 bucket.
", "StreamBucketConfig$bucketOwnerAccountId": "The AWS account ID that owns the S3 bucket. Optional. If omitted, the control plane derives it from the account segment of sqsArn.
" } }, "CancelIngestionJobRequest": { "base": null, "refs": {} }, "CancelIngestionJobResponse": { "base": null, "refs": {} }, "CapacityDetails": { "base": "Capacity details for an OpenSearch Serverless collection group, including the current capacity and autoscaling status.
", "refs": { "CurrentCapacity$search": "The search capacity for the collection group.
", "CurrentCapacity$indexing": "The indexing capacity for the collection group.
" } }, "CapacityLimits": { "base": "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.
", "refs": { "AccountSettingsDetail$capacityLimits": null, "UpdateAccountSettingsRequest$capacityLimits": null } }, "ClientToken": { "base": null, "refs": { "CancelIngestionJobRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "CreateAccessPolicyRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "CreateCollectionGroupRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "CreateCollectionRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "CreateIngestionJobRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "CreateIngestionStreamRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "CreateLifecyclePolicyRequest$clientToken": "A unique, case-sensitive identifier to ensure idempotency of the request.
", "CreateSecurityConfigRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "CreateSecurityPolicyRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "CreateVpcEndpointRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "DeleteAccessPolicyRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "DeleteCollectionGroupRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "DeleteCollectionRequest$clientToken": "A unique, case-sensitive identifier to ensure idempotency of the request.
", "DeleteIngestionStreamRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "DeleteLifecyclePolicyRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "DeleteSecurityConfigRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "DeleteSecurityPolicyRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "DeleteVpcEndpointRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "UpdateAccessPolicyRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "UpdateCollectionGroupRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "UpdateCollectionRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "UpdateLifecyclePolicyRequest$clientToken": "A unique, case-sensitive identifier to ensure idempotency of the request.
", "UpdateSecurityConfigRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "UpdateSecurityPolicyRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "UpdateVpcEndpointRequest$clientToken": "Unique, case-sensitive identifier to ensure idempotency of the request.
" } }, "CollectionDetail": { "base": "Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.
", "refs": { "CollectionDetails$member": null } }, "CollectionDetails": { "base": null, "refs": { "BatchGetCollectionResponse$collectionDetails": "Details about each collection.
" } }, "CollectionErrorDetail": { "base": "Error information for an OpenSearch Serverless request.
", "refs": { "CollectionErrorDetails$member": null } }, "CollectionErrorDetails": { "base": null, "refs": { "BatchGetCollectionResponse$collectionErrorDetails": "Error information for the request.
" } }, "CollectionFilters": { "base": "A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.
", "refs": { "ListCollectionsRequest$collectionFilters": "A list of filter names and values that you can use for requests.
" } }, "CollectionGroupCapacityLimits": { "base": "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.
", "refs": { "CollectionGroupDetail$capacityLimits": "The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
", "CollectionGroupSummary$capacityLimits": null, "CreateCollectionGroupDetail$capacityLimits": "The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
", "CreateCollectionGroupRequest$capacityLimits": "The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group.
", "UpdateCollectionGroupDetail$capacityLimits": "The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
", "UpdateCollectionGroupRequest$capacityLimits": "The updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs). Updates to capacity limits are not incremental. Any field not specified resets to its default value.
" } }, "CollectionGroupDetail": { "base": "Details about a collection group.
", "refs": { "CollectionGroupDetails$member": null } }, "CollectionGroupDetails": { "base": null, "refs": { "BatchGetCollectionGroupResponse$collectionGroupDetails": "Details about each collection group.
" } }, "CollectionGroupErrorDetail": { "base": "Error details for a collection group operation.
", "refs": { "CollectionGroupErrorDetails$member": null } }, "CollectionGroupErrorDetails": { "base": null, "refs": { "BatchGetCollectionGroupResponse$collectionGroupErrorDetails": "Error information for the request.
" } }, "CollectionGroupId": { "base": null, "refs": { "CollectionGroupDetail$id": "The unique identifier of the collection group.
", "CollectionGroupErrorDetail$id": "If the request contains collection group IDs, the response includes the IDs provided in the request.
", "CollectionGroupIds$member": null, "CollectionGroupSummary$id": "The unique identifier of the collection group.
", "CreateCollectionGroupDetail$id": "The unique identifier of the collection group.
", "DeleteCollectionGroupRequest$id": "The unique identifier of the collection group to delete.
", "UpdateCollectionGroupDetail$id": "The unique identifier of the collection group.
", "UpdateCollectionGroupRequest$id": "The unique identifier of the collection group to update.
" } }, "CollectionGroupIds": { "base": null, "refs": { "BatchGetCollectionGroupRequest$ids": "A list of collection group IDs. You can't provide names and IDs in the same request.
" } }, "CollectionGroupMaxIndexingCapacityValue": { "base": null, "refs": { "CollectionGroupCapacityLimits$maxIndexingCapacityInOCU": "The maximum indexing capacity for collections in the group.
" } }, "CollectionGroupMaxSearchCapacityValue": { "base": null, "refs": { "CollectionGroupCapacityLimits$maxSearchCapacityInOCU": "The maximum search capacity for collections in the group.
" } }, "CollectionGroupMinIndexingCapacityValue": { "base": null, "refs": { "CollectionGroupCapacityLimits$minIndexingCapacityInOCU": "The minimum indexing capacity for collections in the group.
" } }, "CollectionGroupMinSearchCapacityValue": { "base": null, "refs": { "CollectionGroupCapacityLimits$minSearchCapacityInOCU": "The minimum search capacity for collections in the group.
" } }, "CollectionGroupName": { "base": null, "refs": { "CollectionDetail$collectionGroupName": "The name of the collection group that contains this collection.
", "CollectionFilters$collectionGroupName": "The name of the collection group to filter by.
", "CollectionGroupDetail$name": "The name of the collection group.
", "CollectionGroupErrorDetail$name": "If the request contains collection group names, the response includes the names provided in the request.
", "CollectionGroupNames$member": null, "CollectionGroupSummary$name": "The name of the collection group.
", "CollectionSummary$collectionGroupName": "The name of the collection group that contains this collection.
", "CreateCollectionDetail$collectionGroupName": "The name of the collection group that contains this collection.
", "CreateCollectionGroupDetail$name": "The name of the collection group.
", "CreateCollectionGroupRequest$name": "The name of the collection group.
", "CreateCollectionRequest$collectionGroupName": "The name of the collection group to associate with the collection.
", "UpdateCollectionGroupDetail$name": "The name of the collection group.
" } }, "CollectionGroupNames": { "base": null, "refs": { "BatchGetCollectionGroupRequest$names": "A list of collection group names. You can't provide names and IDs in the same request.
" } }, "CollectionGroupSummaries": { "base": null, "refs": { "ListCollectionGroupsResponse$collectionGroupSummaries": "Details about each collection group.
" } }, "CollectionGroupSummary": { "base": "Summary information about a collection group.
", "refs": { "CollectionGroupSummaries$member": null } }, "CollectionId": { "base": null, "refs": { "CancelIngestionJobRequest$collectionId": "The unique identifier of the collection that the ingestion job belongs to.
", "CancelIngestionJobResponse$collectionId": "The unique identifier of the collection that the ingestion job belongs to.
", "CollectionDetail$id": "A unique identifier for the collection.
", "CollectionErrorDetail$id": "If the request contains collection IDs, the response includes the IDs provided in the request.
", "CollectionIds$member": null, "CollectionSummary$id": "The unique identifier of the collection.
", "CreateCollectionDetail$id": "The unique identifier of the collection.
", "CreateIndexRequest$id": "The unique identifier of the collection in which to create the index.
", "CreateIngestionJobRequest$collectionId": "The unique identifier of the collection to ingest data into.
", "CreateIngestionStreamRequest$collectionId": "The unique identifier of the collection to ingest data into.
", "DeleteCollectionDetail$id": "The unique identifier of the collection.
", "DeleteCollectionRequest$id": "The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.
The unique identifier of the collection containing the index to delete.
", "DeleteIngestionStreamRequest$collectionId": "The unique identifier of the collection that the ingestion stream belongs to.
", "DeleteIngestionStreamResponse$collectionId": "The unique identifier of the collection that the ingestion stream belonged to.
", "GetIndexRequest$id": "The unique identifier of the collection containing the index.
", "GetIngestionJobRequest$collectionId": "The unique identifier of the collection that the ingestion job belongs to.
", "GetIngestionStreamRequest$collectionId": "The unique identifier of the collection that the ingestion stream belongs to.
", "IngestionJobDetail$collectionId": "The unique identifier of the collection that the ingestion job belongs to.
", "IngestionStreamDetail$collectionId": "The unique identifier of the collection that the ingestion stream belongs to.
", "ListIngestionJobsRequest$collectionId": "The unique identifier of the collection to list ingestion jobs for.
", "ListIngestionStreamsRequest$collectionId": "The unique identifier of the collection to list ingestion streams for.
", "UpdateCollectionDetail$id": "The unique identifier of the collection.
", "UpdateCollectionRequest$id": "The unique identifier of the collection.
", "UpdateIndexRequest$id": "The unique identifier of the collection containing the index to update.
" } }, "CollectionIds": { "base": null, "refs": { "BatchGetCollectionRequest$ids": "A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.
" } }, "CollectionName": { "base": null, "refs": { "CollectionDetail$name": "The name of the collection.
", "CollectionErrorDetail$name": "If the request contains collection names, the response includes the names provided in the request.
", "CollectionFilters$name": "The name of the collection.
", "CollectionNames$member": null, "CollectionSummary$name": "The name of the collection.
", "CreateCollectionDetail$name": "The name of the collection.
", "CreateCollectionRequest$name": "Name of the collection.
", "DeleteCollectionDetail$name": "The name of the collection.
", "UpdateCollectionDetail$name": "The name of the collection.
" } }, "CollectionNames": { "base": null, "refs": { "BatchGetCollectionRequest$names": "A list of collection names. You can't provide names and IDs in the same request.
" } }, "CollectionStatus": { "base": null, "refs": { "CollectionDetail$status": "The current status of the collection.
", "CollectionFilters$status": "The current status of the collection.
", "CollectionSummary$status": "The current status of the collection.
", "CreateCollectionDetail$status": "The current status of the collection.
", "DeleteCollectionDetail$status": "The current status of the collection.
", "UpdateCollectionDetail$status": "The current status of the collection.
" } }, "CollectionSummaries": { "base": null, "refs": { "ListCollectionsResponse$collectionSummaries": "Details about each collection.
" } }, "CollectionSummary": { "base": "Details about each OpenSearch Serverless collection.
", "refs": { "CollectionSummaries$member": null } }, "CollectionType": { "base": null, "refs": { "CollectionDetail$type": "The type of collection.
", "CreateCollectionDetail$type": "The type of collection.
", "CreateCollectionRequest$type": "The type of collection.
", "UpdateCollectionDetail$type": "The collection type.
" } }, "ConfigDescription": { "base": null, "refs": { "CreateSecurityConfigRequest$description": "A description of the security configuration.
", "SecurityConfigDetail$description": "The description of the security configuration.
", "SecurityConfigSummary$description": "The description of the security configuration.
", "UpdateSecurityConfigRequest$description": "A description of the security configuration.
" } }, "ConfigName": { "base": null, "refs": { "CreateSecurityConfigRequest$name": "The name of the security configuration.
" } }, "ConflictException": { "base": "When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE, FAILED, or UPDATE_FAILED state.
", "refs": {} }, "CreateAccessPolicyRequest": { "base": null, "refs": {} }, "CreateAccessPolicyResponse": { "base": null, "refs": {} }, "CreateCollectionDetail": { "base": "Details about the created OpenSearch Serverless collection.
", "refs": { "CreateCollectionResponse$createCollectionDetail": "Details about the collection.
" } }, "CreateCollectionGroupDetail": { "base": "Details about the created collection group.
", "refs": { "CreateCollectionGroupResponse$createCollectionGroupDetail": "Details about the created collection group.
" } }, "CreateCollectionGroupRequest": { "base": null, "refs": {} }, "CreateCollectionGroupRequestDescriptionString": { "base": null, "refs": { "CreateCollectionGroupRequest$description": "A description of the collection group.
" } }, "CreateCollectionGroupResponse": { "base": null, "refs": {} }, "CreateCollectionRequest": { "base": null, "refs": {} }, "CreateCollectionRequestDescriptionString": { "base": null, "refs": { "CreateCollectionRequest$description": "Description of the collection.
" } }, "CreateCollectionResponse": { "base": null, "refs": {} }, "CreateIamIdentityCenterConfigOptions": { "base": "Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.
", "refs": { "CreateSecurityConfigRequest$iamIdentityCenterOptions": "Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.
Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", "refs": { "CreateVpcEndpointResponse$createVpcEndpointDetail": "Details about the created interface VPC endpoint.
" } }, "CreateVpcEndpointRequest": { "base": null, "refs": {} }, "CreateVpcEndpointResponse": { "base": null, "refs": {} }, "CurrentCapacity": { "base": "Current search and indexing capacity for an OpenSearch Serverless collection group. Measured in OpenSearch Compute Units (OCUs).
", "refs": { "CollectionGroupDetail$currentCapacity": "Current search and indexing capacity for the collection group.
" } }, "DeleteAccessPolicyRequest": { "base": null, "refs": {} }, "DeleteAccessPolicyResponse": { "base": null, "refs": {} }, "DeleteCollectionDetail": { "base": "Details about a deleted OpenSearch Serverless collection.
", "refs": { "DeleteCollectionResponse$deleteCollectionDetail": "Details of the deleted collection.
" } }, "DeleteCollectionGroupRequest": { "base": null, "refs": {} }, "DeleteCollectionGroupResponse": { "base": null, "refs": {} }, "DeleteCollectionRequest": { "base": null, "refs": {} }, "DeleteCollectionResponse": { "base": null, "refs": {} }, "DeleteIndexRequest": { "base": null, "refs": {} }, "DeleteIndexResponse": { "base": null, "refs": {} }, "DeleteIngestionStreamRequest": { "base": null, "refs": {} }, "DeleteIngestionStreamResponse": { "base": null, "refs": {} }, "DeleteLifecyclePolicyRequest": { "base": null, "refs": {} }, "DeleteLifecyclePolicyResponse": { "base": null, "refs": {} }, "DeleteSecurityConfigRequest": { "base": null, "refs": {} }, "DeleteSecurityConfigResponse": { "base": null, "refs": {} }, "DeleteSecurityPolicyRequest": { "base": null, "refs": {} }, "DeleteSecurityPolicyResponse": { "base": null, "refs": {} }, "DeleteVpcEndpointDetail": { "base": "Deletion details for an OpenSearch Serverless-managed interface endpoint.
", "refs": { "DeleteVpcEndpointResponse$deleteVpcEndpointDetail": "Details about the deleted endpoint.
" } }, "DeleteVpcEndpointRequest": { "base": null, "refs": {} }, "DeleteVpcEndpointResponse": { "base": null, "refs": {} }, "DeletionProtection": { "base": "Indicates whether deletion protection is ENABLED or DISABLED for the collection. When deletion protection is ENABLED, the collection cannot be deleted.
Indicates whether deletion protection is ENABLED or DISABLED for the collection.
Indicates whether deletion protection is ENABLED or DISABLED for the collection.
Indicates whether to enable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.
Indicates whether deletion protection is ENABLED or DISABLED for the collection.
Indicates whether deletion protection is ENABLED or DISABLED for the collection.
Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.
The JSON policy document without any whitespaces.
", "LifecyclePolicyDetail$policy": "The JSON policy document without any whitespaces.
", "SecurityPolicyDetail$policy": "The JSON policy document without any whitespaces.
" } }, "EffectiveLifecyclePolicyDetail": { "base": "Error information for an OpenSearch Serverless request.
", "refs": { "EffectiveLifecyclePolicyDetails$member": null } }, "EffectiveLifecyclePolicyDetails": { "base": null, "refs": { "BatchGetEffectiveLifecyclePolicyResponse$effectiveLifecyclePolicyDetails": "A list of lifecycle policies applied to the OpenSearch Serverless indexes.
" } }, "EffectiveLifecyclePolicyErrorDetail": { "base": "Error information for an OpenSearch Serverless request.
", "refs": { "EffectiveLifecyclePolicyErrorDetails$member": null } }, "EffectiveLifecyclePolicyErrorDetails": { "base": null, "refs": { "BatchGetEffectiveLifecyclePolicyResponse$effectiveLifecyclePolicyErrorDetails": "A list of resources for which retrieval failed.
" } }, "EncryptionConfig": { "base": "Encryption settings for a collection.
", "refs": { "CreateCollectionRequest$encryptionConfig": "Encryption settings for the collection.
", "UpdateCollectionRequest$encryptionConfig": null } }, "EncryptionConfigKmsKeyArnString": { "base": null, "refs": { "EncryptionConfig$kmsKeyArn": "The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.
" } }, "FipsEndpoints": { "base": "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.
", "refs": { "CollectionDetail$fipsEndpoints": "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.
" } }, "Float": { "base": null, "refs": { "CapacityDetails$capacityInOcu": "The current capacity in OpenSearch Compute Units (OCUs).
" } }, "GetAccessPolicyRequest": { "base": null, "refs": {} }, "GetAccessPolicyResponse": { "base": null, "refs": {} }, "GetAccountSettingsRequest": { "base": null, "refs": {} }, "GetAccountSettingsResponse": { "base": null, "refs": {} }, "GetIndexRequest": { "base": null, "refs": {} }, "GetIndexResponse": { "base": null, "refs": {} }, "GetIngestionJobRequest": { "base": null, "refs": {} }, "GetIngestionJobResponse": { "base": null, "refs": {} }, "GetIngestionStreamRequest": { "base": null, "refs": {} }, "GetIngestionStreamResponse": { "base": null, "refs": {} }, "GetPoliciesStatsRequest": { "base": null, "refs": {} }, "GetPoliciesStatsResponse": { "base": null, "refs": {} }, "GetSecurityConfigRequest": { "base": null, "refs": {} }, "GetSecurityConfigResponse": { "base": null, "refs": {} }, "GetSecurityPolicyRequest": { "base": null, "refs": {} }, "GetSecurityPolicyResponse": { "base": null, "refs": {} }, "IamFederationConfigOptions": { "base": "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.
", "refs": { "CreateSecurityConfigRequest$iamFederationOptions": "Describes IAM federation options in the form of a key-value map. This field is required if you specify iamFederation for the type parameter.
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.
", "UpdateSecurityConfigRequest$iamFederationOptions": "Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.
" } }, "IamIdentityCenterApplicationArn": { "base": null, "refs": { "IamIdentityCenterConfigOptions$applicationArn": "The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.
" } }, "IamIdentityCenterConfigOptions": { "base": "Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.
", "refs": { "SecurityConfigDetail$iamIdentityCenterOptions": "Describes IAM Identity Center options in the form of a key-value map.
" } }, "IamIdentityCenterGroupAttribute": { "base": null, "refs": { "CreateIamIdentityCenterConfigOptions$groupAttribute": "The group attribute for this IAM Identity Center integration. Defaults to GroupId.
The group attribute for this IAM Identity Center integration. Defaults to GroupId.
The group attribute for this IAM Identity Center integration. Defaults to GroupId.
The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
", "IamIdentityCenterConfigOptions$instanceArn": "The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
" } }, "IamIdentityCenterUserAttribute": { "base": null, "refs": { "CreateIamIdentityCenterConfigOptions$userAttribute": "The user attribute for this IAM Identity Center integration. Defaults to UserId.
The user attribute for this IAM Identity Center integration. Defaults to UserId
The user attribute for this IAM Identity Center integration. Defaults to UserId.
The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).
", "DeleteIndexRequest$indexName": "The name of the index to delete.
", "GetIndexRequest$indexName": "The name of the index to retrieve information about.
", "UpdateIndexRequest$indexName": "The name of the index to update.
" } }, "IndexSchema": { "base": null, "refs": { "CreateIndexRequest$indexSchema": "The JSON schema definition for the index, including field mappings and settings.
", "GetIndexResponse$indexSchema": "The JSON schema definition for the index, including field mappings and settings.
", "UpdateIndexRequest$indexSchema": "The updated JSON schema definition for the index, including field mappings and settings.
" } }, "IndexingCapacityValue": { "base": null, "refs": { "CapacityLimits$maxIndexingCapacityInOCU": "The maximum indexing capacity for collections.
" } }, "IngestionAlert": { "base": "An active alert about a running ingestion — operational issues or updates to processing state. Cleared when the issue resolves.
", "refs": { "IngestionAlerts$member": null } }, "IngestionAlertCode": { "base": "Codes for active operational issues affecting a running ingestion.
", "refs": { "IngestionAlert$code": "The code that identifies the alert.
" } }, "IngestionAlerts": { "base": null, "refs": { "IngestionJobDetail$activeAlerts": "Active alerts about operational issues that currently affect the ingestion job. Alerts are cleared when the issue is resolved.
", "IngestionStreamDetail$activeAlerts": "Active alerts about operational issues that currently affect the ingestion stream. Alerts are cleared when the issue is resolved.
" } }, "IngestionFailureCode": { "base": "Codes explaining why an ingestion reached a terminal failure state.
", "refs": { "IngestionFailureReason$code": "The code that identifies the reason for the failure.
" } }, "IngestionFailureReason": { "base": "A terminal failure reason explaining why an ingestion stopped.
", "refs": { "IngestionFailureReasons$member": null } }, "IngestionFailureReasons": { "base": null, "refs": { "IngestionJobDetail$failureReasons": "The reasons that the ingestion job reached a terminal failure state, if applicable.
", "IngestionStreamDetail$failureReasons": "The reasons that the ingestion stream reached a terminal failure state, if applicable.
" } }, "IngestionIndexName": { "base": null, "refs": { "CreateIngestionJobRequest$indexName": "The name of the index to ingest documents into.
", "CreateIngestionJobRequest$failureIndexName": "The name of the index where documents that fail to be ingested are recorded.
", "CreateIngestionStreamRequest$indexName": "The name of the index to ingest documents into.
", "CreateIngestionStreamRequest$failureIndexName": "The name of the index where documents that fail to be ingested are recorded.
", "IngestionJobDetail$indexName": "The name of the index that documents are ingested into.
", "IngestionJobDetail$failureIndexName": "The name of the index where documents that fail to be ingested are recorded.
", "IngestionJobSummary$indexName": "The name of the index that documents are ingested into.
", "IngestionStreamDetail$indexName": "The name of the index that documents are ingested into.
", "IngestionStreamDetail$failureIndexName": "The name of the index where documents that fail to be ingested are recorded.
", "IngestionStreamSummary$indexName": "The name of the index that documents are ingested into.
" } }, "IngestionJobDetail": { "base": "Details about an ingestion job.
", "refs": { "CreateIngestionJobResponse$ingestionJobDetail": "Details about the created ingestion job.
", "GetIngestionJobResponse$ingestionJobDetail": "Details about the requested ingestion job.
" } }, "IngestionJobId": { "base": null, "refs": { "CancelIngestionJobRequest$ingestionJobId": "The unique identifier of the ingestion job to cancel.
", "CancelIngestionJobResponse$ingestionJobId": "The unique identifier of the cancelled ingestion job.
", "GetIngestionJobRequest$ingestionJobId": "The unique identifier of the ingestion job to retrieve.
", "IngestionJobDetail$ingestionJobId": "The unique identifier of the ingestion job.
", "IngestionJobSummary$ingestionJobId": "The unique identifier of the ingestion job.
" } }, "IngestionJobName": { "base": null, "refs": { "CancelIngestionJobResponse$ingestionJobName": "The name of the cancelled ingestion job.
", "CreateIngestionJobRequest$ingestionJobName": "The name of the ingestion job. The name must be unique within the collection.
", "IngestionJobDetail$ingestionJobName": "The name of the ingestion job.
", "IngestionJobSummary$ingestionJobName": "The name of the ingestion job.
" } }, "IngestionJobResourceArn": { "base": null, "refs": { "IngestionJobDetail$arn": "The Amazon Resource Name (ARN) of the ingestion job.
", "IngestionJobSummary$arn": "The Amazon Resource Name (ARN) of the ingestion job.
" } }, "IngestionJobS3Source": { "base": "The Amazon S3 source configuration for an ingestion job.
", "refs": { "IngestionJobSource$s3": "The Amazon S3 source configuration for the ingestion job.
" } }, "IngestionJobS3SourceKeyPrefixString": { "base": null, "refs": { "IngestionJobS3Source$keyPrefix": "A key prefix that limits ingestion to objects in the Amazon S3 bucket whose keys begin with the prefix.
" } }, "IngestionJobSource": { "base": "The source that an ingestion job ingests data from.
", "refs": { "CreateIngestionJobRequest$source": "The Amazon S3 source to ingest data from.
", "IngestionJobDetail$source": "The Amazon S3 source that the ingestion job ingests data from.
" } }, "IngestionJobStatus": { "base": null, "refs": { "CancelIngestionJobResponse$status": "The current status of the ingestion job.
", "IngestionJobDetail$status": "The current lifecycle status of the ingestion job. For example, CREATING, ACTIVE, COMPLETED, or CANCELLED.
The current lifecycle status of the ingestion job.
" } }, "IngestionJobSummaries": { "base": null, "refs": { "ListIngestionJobsResponse$ingestionJobSummaries": "Summary information about each ingestion job.
" } }, "IngestionJobSummary": { "base": "Summary information about an ingestion job.
", "refs": { "IngestionJobSummaries$member": null } }, "IngestionState": { "base": null, "refs": { "IngestionJobDetail$state": "The current processing state of the ingestion job. For example, SCANNING, INGESTION_IN_PROGRESS, or INGESTION_COMPLETE.
The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.
Processing statistics for an ingestion job or ingestion stream.
", "refs": { "IngestionJobDetail$statistics": "Processing statistics for the ingestion job, such as the number of Amazon S3 objects discovered, ingested, and failed.
", "IngestionStreamDetail$statistics": "Processing statistics for the ingestion stream, such as the number of Amazon S3 objects discovered, ingested, and failed.
" } }, "IngestionStreamDetail": { "base": "Details about an ingestion stream.
", "refs": { "CreateIngestionStreamResponse$ingestionStreamDetail": "Details about the created ingestion stream.
", "GetIngestionStreamResponse$ingestionStreamDetail": "Details about the requested ingestion stream.
" } }, "IngestionStreamId": { "base": null, "refs": { "DeleteIngestionStreamRequest$ingestionStreamId": "The unique identifier of the ingestion stream to delete.
", "DeleteIngestionStreamResponse$ingestionStreamId": "The unique identifier of the deleted ingestion stream.
", "GetIngestionStreamRequest$ingestionStreamId": "The unique identifier of the ingestion stream to retrieve.
", "IngestionStreamDetail$ingestionStreamId": "The unique identifier of the ingestion stream.
", "IngestionStreamSummary$ingestionStreamId": "The unique identifier of the ingestion stream.
" } }, "IngestionStreamName": { "base": null, "refs": { "CreateIngestionStreamRequest$ingestionStreamName": "The name of the ingestion stream. The name must be unique within the collection.
", "DeleteIngestionStreamResponse$ingestionStreamName": "The name of the deleted ingestion stream.
", "IngestionStreamDetail$ingestionStreamName": "The name of the ingestion stream.
", "IngestionStreamSummary$ingestionStreamName": "The name of the ingestion stream.
" } }, "IngestionStreamResourceArn": { "base": null, "refs": { "IngestionStreamDetail$arn": "The Amazon Resource Name (ARN) of the ingestion stream.
", "IngestionStreamSummary$arn": "The Amazon Resource Name (ARN) of the ingestion stream.
" } }, "IngestionStreamS3Source": { "base": "The Amazon S3 source configuration for an ingestion stream.
", "refs": { "IngestionStreamSource$s3": "The Amazon S3 source configuration for the ingestion stream.
" } }, "IngestionStreamSource": { "base": "The source that an ingestion stream ingests data from.
", "refs": { "CreateIngestionStreamRequest$source": "The Amazon S3 source to ingest data from, including the Amazon SQS queue that receives S3 event notifications.
", "IngestionStreamDetail$source": "The Amazon S3 source that the ingestion stream ingests data from.
" } }, "IngestionStreamStatus": { "base": null, "refs": { "DeleteIngestionStreamResponse$status": "The current status of the ingestion stream.
", "IngestionStreamDetail$status": "The current lifecycle status of the ingestion stream. For example, CREATING, ACTIVE, or DELETING.
The current lifecycle status of the ingestion stream.
" } }, "IngestionStreamSummaries": { "base": null, "refs": { "ListIngestionStreamsResponse$ingestionStreamSummaries": "Summary information about each ingestion stream.
" } }, "IngestionStreamSummary": { "base": "Summary information about an ingestion stream.
", "refs": { "IngestionStreamSummaries$member": null } }, "InitialScan": { "base": "Controls whether to perform a one-time delta scan of existing S3 objects before continuous ingestion processes SQS notifications.
", "refs": { "StreamBucketConfig$initialScan": "Specifies whether to perform a one-time scan of the objects that already exist in the bucket before the stream begins processing Amazon S3 event notifications. If DISABLED, only new objects are ingested.
The number of collections associated with the collection group.
", "CollectionGroupSummary$numberOfCollections": "The number of collections within the collection group.
" } }, "InternalServerException": { "base": "Thrown when an error internal to the service occurs while processing a request.
", "refs": {} }, "LifecyclePolicyDetail": { "base": "Details about an OpenSearch Serverless lifecycle policy.
", "refs": { "CreateLifecyclePolicyResponse$lifecyclePolicyDetail": "Details about the created lifecycle policy.
", "LifecyclePolicyDetails$member": null, "UpdateLifecyclePolicyResponse$lifecyclePolicyDetail": "Details about the updated lifecycle policy.
" } }, "LifecyclePolicyDetails": { "base": null, "refs": { "BatchGetLifecyclePolicyResponse$lifecyclePolicyDetails": "A list of lifecycle policies matched to the input policy name and policy type.
" } }, "LifecyclePolicyErrorDetail": { "base": "Error information for an OpenSearch Serverless request.
", "refs": { "LifecyclePolicyErrorDetails$member": null } }, "LifecyclePolicyErrorDetails": { "base": null, "refs": { "BatchGetLifecyclePolicyResponse$lifecyclePolicyErrorDetails": "A list of lifecycle policy names and policy types for which retrieval failed.
" } }, "LifecyclePolicyIdentifier": { "base": "The unique identifiers of policy types and policy names.
", "refs": { "LifecyclePolicyIdentifiers$member": null } }, "LifecyclePolicyIdentifiers": { "base": null, "refs": { "BatchGetLifecyclePolicyRequest$identifiers": "The unique identifiers of policy types and policy names.
" } }, "LifecyclePolicyResourceIdentifier": { "base": "The unique identifiers of policy types and resource names.
", "refs": { "LifecyclePolicyResourceIdentifiers$member": null } }, "LifecyclePolicyResourceIdentifiers": { "base": null, "refs": { "BatchGetEffectiveLifecyclePolicyRequest$resourceIdentifiers": "The unique identifiers of policy types and resource names.
" } }, "LifecyclePolicyStats": { "base": "Statistics for an OpenSearch Serverless lifecycle policy.
", "refs": { "GetPoliciesStatsResponse$LifecyclePolicyStats": "Information about the lifecycle policies in your account.
" } }, "LifecyclePolicySummaries": { "base": null, "refs": { "ListLifecyclePoliciesResponse$lifecyclePolicySummaries": "Details about the requested lifecycle policies.
" } }, "LifecyclePolicySummary": { "base": "A summary of the lifecycle policy.
", "refs": { "LifecyclePolicySummaries$member": null } }, "LifecyclePolicyType": { "base": null, "refs": { "CreateLifecyclePolicyRequest$type": "The type of lifecycle policy.
", "DeleteLifecyclePolicyRequest$type": "The type of lifecycle policy.
", "EffectiveLifecyclePolicyDetail$type": "The type of lifecycle policy.
", "EffectiveLifecyclePolicyErrorDetail$type": "The type of lifecycle policy.
", "LifecyclePolicyDetail$type": "The type of lifecycle policy.
", "LifecyclePolicyErrorDetail$type": "The type of lifecycle policy.
", "LifecyclePolicyIdentifier$type": "The type of lifecycle policy.
", "LifecyclePolicyResourceIdentifier$type": "The type of lifecycle policy.
", "LifecyclePolicySummary$type": "The type of lifecycle policy.
", "ListLifecyclePoliciesRequest$type": "The type of lifecycle policy.
", "UpdateLifecyclePolicyRequest$type": "The type of lifecycle policy.
" } }, "LifecycleResource": { "base": null, "refs": { "ListLifecyclePoliciesRequestResourcesList$member": null } }, "ListAccessPoliciesRequest": { "base": null, "refs": {} }, "ListAccessPoliciesRequestMaxResultsInteger": { "base": null, "refs": { "ListAccessPoliciesRequest$maxResults": "An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
Resource filters (can be collections or indexes) that policies can apply to.
" } }, "ListAccessPoliciesResponse": { "base": null, "refs": {} }, "ListCollectionGroupsRequest": { "base": null, "refs": {} }, "ListCollectionGroupsRequestMaxResultsInteger": { "base": null, "refs": { "ListCollectionGroupsRequest$maxResults": "The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.
The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.
The maximum number of results to return. Valid values are 1–100. If you don't specify a value, the default is 100. You can use nextToken to get the next page of results.
A response can contain fewer results than maxResults, or no results, and still include a nextToken. To retrieve all results, continue to make the call with the returned nextToken until no nextToken is returned.
The maximum number of results to return. Valid values are 1–100. If you don't specify a value, the default is 100. You can use nextToken to get the next page of results.
A response can contain fewer results than maxResults, or no results, and still include a nextToken. To retrieve all results, continue to make the call with the returned nextToken until no nextToken is returned.
An optional parameter that specifies the maximum number of results to return. You can use use nextToken to get the next page of results. The default is 10.
Resource filters that policies can apply to. Currently, the only supported resource type is index.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
Resource filters (can be collection or indexes) that policies can apply to.
" } }, "ListSecurityPoliciesResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "ListVpcEndpointsRequest": { "base": null, "refs": {} }, "ListVpcEndpointsRequestMaxResultsInteger": { "base": null, "refs": { "ListVpcEndpointsRequest$maxResults": "An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
The date the policy was created.
", "AccessPolicyDetail$lastModifiedDate": "The timestamp of when the policy was last modified.
", "AccessPolicyStats$DataPolicyCount": "The number of data access policies in the current account.
", "AccessPolicySummary$createdDate": "The Epoch time when the access policy was created.
", "AccessPolicySummary$lastModifiedDate": "The date and time when the collection was last modified.
", "CollectionDetail$createdDate": "The Epoch time when the collection was created.
", "CollectionDetail$lastModifiedDate": "The date and time when the collection was last modified.
", "CollectionGroupDetail$createdDate": "The Epoch time when the collection group was created.
", "CollectionGroupSummary$createdDate": "The Epoch time when the collection group was created.
", "CreateCollectionDetail$createdDate": "The Epoch time when the collection was created.
", "CreateCollectionDetail$lastModifiedDate": "The date and time when the collection was last modified.
", "CreateCollectionGroupDetail$createdDate": "The Epoch time when the collection group was created.
", "GetPoliciesStatsResponse$TotalPolicyCount": "The total number of OpenSearch Serverless security policies and configurations in your account.
", "IngestionJobDetail$revision": "The revision number of the ingestion job.
", "IngestionStreamDetail$revision": "The revision number of the ingestion stream.
", "LifecyclePolicyDetail$createdDate": "The date the lifecycle policy was created.
", "LifecyclePolicyDetail$lastModifiedDate": "The timestamp of when the lifecycle policy was last modified.
", "LifecyclePolicyStats$RetentionPolicyCount": "The number of retention lifecycle policies in the current account.
", "LifecyclePolicySummary$createdDate": "The Epoch time when the lifecycle policy was created.
", "LifecyclePolicySummary$lastModifiedDate": "The date and time when the lifecycle policy was last modified.
", "S3Statistics$objectsDiscovered": "The number of Amazon S3 objects discovered for ingestion.
", "S3Statistics$objectsIngested": "The number of Amazon S3 objects successfully ingested.
", "S3Statistics$objectsFailed": "The number of Amazon S3 objects that failed to be ingested.
", "SecurityConfigDetail$createdDate": "The date the configuration was created.
", "SecurityConfigDetail$lastModifiedDate": "The timestamp of when the configuration was last modified.
", "SecurityConfigStats$SamlConfigCount": "The number of security configurations in the current account.
", "SecurityConfigSummary$createdDate": "The Epoch time when the security configuration was created.
", "SecurityConfigSummary$lastModifiedDate": "The timestamp of when the configuration was last modified.
", "SecurityPolicyDetail$createdDate": "The date the policy was created.
", "SecurityPolicyDetail$lastModifiedDate": "The timestamp of when the policy was last modified.
", "SecurityPolicyStats$EncryptionPolicyCount": "The number of encryption policies in the current account.
", "SecurityPolicyStats$NetworkPolicyCount": "The number of network policies in the current account.
", "SecurityPolicySummary$createdDate": "The date the policy was created.
", "SecurityPolicySummary$lastModifiedDate": "The timestamp of when the policy was last modified.
", "UpdateCollectionDetail$createdDate": "The date and time when the collection was created.
", "UpdateCollectionDetail$lastModifiedDate": "The date and time when the collection was last modified.
", "UpdateCollectionGroupDetail$createdDate": "The Epoch time when the collection group was created.
", "UpdateCollectionGroupDetail$lastModifiedDate": "The date and time when the collection group was last modified.
", "UpdateVpcEndpointDetail$lastModifiedDate": "The timestamp of when the endpoint was last modified.
", "VpcEndpointDetail$createdDate": "The date the endpoint was created.
" } }, "OcuLimitExceededException": { "base": "Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.
", "refs": {} }, "PolicyDescription": { "base": null, "refs": { "AccessPolicyDetail$description": "The description of the policy.
", "AccessPolicySummary$description": "The description of the access policy.
", "CreateAccessPolicyRequest$description": "A description of the policy. Typically used to store information about the permissions defined in the policy.
", "CreateLifecyclePolicyRequest$description": "A description of the lifecycle policy.
", "CreateSecurityPolicyRequest$description": "A description of the policy. Typically used to store information about the permissions defined in the policy.
", "LifecyclePolicyDetail$description": "The description of the lifecycle policy.
", "LifecyclePolicySummary$description": "The description of the lifecycle policy.
", "SecurityPolicyDetail$description": "The description of the security policy.
", "SecurityPolicySummary$description": "The description of the security policy.
", "UpdateAccessPolicyRequest$description": "A description of the policy. Typically used to store information about the permissions defined in the policy.
", "UpdateLifecyclePolicyRequest$description": "A description of the lifecycle policy.
", "UpdateSecurityPolicyRequest$description": "A description of the policy. Typically used to store information about the permissions defined in the policy.
" } }, "PolicyDocument": { "base": null, "refs": { "CreateAccessPolicyRequest$policy": "The JSON policy document to use as the content for the policy.
", "CreateLifecyclePolicyRequest$policy": "The JSON policy document to use as the content for the lifecycle policy.
", "CreateSecurityPolicyRequest$policy": "The JSON policy document to use as the content for the new policy.
", "UpdateAccessPolicyRequest$policy": "The JSON policy document to use as the content for the policy.
", "UpdateLifecyclePolicyRequest$policy": "The JSON policy document to use as the content for the lifecycle policy.
", "UpdateSecurityPolicyRequest$policy": "The JSON policy document to use as the content for the new policy.
" } }, "PolicyName": { "base": null, "refs": { "AccessPolicyDetail$name": "The name of the policy.
", "AccessPolicySummary$name": "The name of the access policy.
", "CreateAccessPolicyRequest$name": "The name of the policy.
", "CreateLifecyclePolicyRequest$name": "The name of the lifecycle policy.
", "CreateSecurityPolicyRequest$name": "The name of the policy.
", "DeleteAccessPolicyRequest$name": "The name of the policy to delete.
", "DeleteLifecyclePolicyRequest$name": "The name of the policy to delete.
", "DeleteSecurityPolicyRequest$name": "The name of the policy to delete.
", "EffectiveLifecyclePolicyDetail$policyName": "The name of the lifecycle policy.
", "GetAccessPolicyRequest$name": "The name of the access policy.
", "GetSecurityPolicyRequest$name": "The name of the security policy.
", "LifecyclePolicyDetail$name": "The name of the lifecycle policy.
", "LifecyclePolicyErrorDetail$name": "The name of the lifecycle policy.
", "LifecyclePolicyIdentifier$name": "The name of the lifecycle policy.
", "LifecyclePolicySummary$name": "The name of the lifecycle policy.
", "SecurityPolicyDetail$name": "The name of the policy.
", "SecurityPolicySummary$name": "The name of the policy.
", "UpdateAccessPolicyRequest$name": "The name of the policy.
", "UpdateLifecyclePolicyRequest$name": "The name of the policy.
", "UpdateSecurityPolicyRequest$name": "The name of the policy.
" } }, "PolicyVersion": { "base": null, "refs": { "AccessPolicyDetail$policyVersion": "The version of the policy.
", "AccessPolicySummary$policyVersion": "The version of the policy.
", "LifecyclePolicyDetail$policyVersion": "The version of the lifecycle policy.
", "LifecyclePolicySummary$policyVersion": "The version of the lifecycle policy.
", "SecurityConfigDetail$configVersion": "The version of the security configuration.
", "SecurityConfigSummary$configVersion": "The version of the security configuration.
", "SecurityPolicyDetail$policyVersion": "The version of the policy.
", "SecurityPolicySummary$policyVersion": "The version of the policy.
", "UpdateAccessPolicyRequest$policyVersion": "The version of the policy being updated.
", "UpdateLifecyclePolicyRequest$policyVersion": "The version of the policy being updated.
", "UpdateSecurityConfigRequest$configVersion": "The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.
The version of the policy being updated.
" } }, "Resource": { "base": null, "refs": { "EffectiveLifecyclePolicyDetail$resource": "The name of the OpenSearch Serverless index resource.
", "EffectiveLifecyclePolicyErrorDetail$resource": "The name of OpenSearch Serverless index resource.
", "ListAccessPoliciesRequestResourceList$member": null, "ListSecurityPoliciesRequestResourceList$member": null } }, "ResourceName": { "base": null, "refs": { "LifecyclePolicyResourceIdentifier$resource": "The name of the OpenSearch Serverless ilndex resource.
" } }, "ResourceNotFoundException": { "base": "Thrown when accessing or deleting a resource that does not exist.
", "refs": {} }, "ResourceType": { "base": null, "refs": { "EffectiveLifecyclePolicyDetail$resourceType": "The type of OpenSearch Serverless resource. Currently, the only supported resource is index.
The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source. The role must be in the same account as the collection.
", "IngestionStreamDetail$roleArn": "The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source.
" } }, "S3BucketNameOrArn": { "base": null, "refs": { "IngestionJobS3Source$bucket": "The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.
", "StreamBucketConfig$bucket": "The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.
" } }, "S3Statistics": { "base": "Processing statistics for the Amazon S3 objects in an ingestion source.
", "refs": { "IngestionStatistics$s3": "Processing statistics for the Amazon S3 source.
" } }, "SamlConfigOptions": { "base": "Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.
", "refs": { "CreateSecurityConfigRequest$samlOptions": "Describes SAML options in the form of a key-value map. This field is required if you specify SAML for the type parameter.
SAML options for the security configuration in the form of a key-value map.
", "UpdateSecurityConfigRequest$samlOptions": "SAML options in in the form of a key-value map.
" } }, "SamlConfigOptionsSessionTimeoutInteger": { "base": null, "refs": { "SamlConfigOptions$sessionTimeout": "The session timeout, in minutes. Default is 60 minutes (12 hours).
" } }, "SearchCapacityValue": { "base": null, "refs": { "CapacityLimits$maxSearchCapacityInOCU": "The maximum search capacity for collections.
" } }, "SecurityConfigDetail": { "base": "Details about a security configuration for OpenSearch Serverless.
", "refs": { "CreateSecurityConfigResponse$securityConfigDetail": "Details about the created security configuration.
", "GetSecurityConfigResponse$securityConfigDetail": "Details of the requested security configuration.
", "UpdateSecurityConfigResponse$securityConfigDetail": "Details about the updated security configuration.
" } }, "SecurityConfigId": { "base": null, "refs": { "DeleteSecurityConfigRequest$id": "The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
The unique identifier of the security configuration.
", "SecurityConfigDetail$id": "The unique identifier of the security configuration.
", "SecurityConfigSummary$id": "The unique identifier of the security configuration.
", "UpdateSecurityConfigRequest$id": "The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
Statistics for an OpenSearch Serverless security configuration.
", "refs": { "GetPoliciesStatsResponse$SecurityConfigStats": "Information about the security configurations in your account.
" } }, "SecurityConfigSummaries": { "base": null, "refs": { "ListSecurityConfigsResponse$securityConfigSummaries": "Details about the security configurations in your account.
" } }, "SecurityConfigSummary": { "base": "A summary of a security configuration for OpenSearch Serverless.
", "refs": { "SecurityConfigSummaries$member": null } }, "SecurityConfigType": { "base": null, "refs": { "CreateSecurityConfigRequest$type": "The type of security configuration.
", "ListSecurityConfigsRequest$type": "The type of security configuration.
", "SecurityConfigDetail$type": "The type of security configuration.
", "SecurityConfigSummary$type": "The type of security configuration.
" } }, "SecurityGroupId": { "base": null, "refs": { "SecurityGroupIds$member": null } }, "SecurityGroupIds": { "base": null, "refs": { "CreateVpcEndpointRequest$securityGroupIds": "The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
", "UpdateVpcEndpointDetail$securityGroupIds": "The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
", "UpdateVpcEndpointRequest$addSecurityGroupIds": "The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
", "UpdateVpcEndpointRequest$removeSecurityGroupIds": "The unique identifiers of the security groups to remove from the endpoint.
", "VpcEndpointDetail$securityGroupIds": "The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" } }, "SecurityPolicyDetail": { "base": "Details about an OpenSearch Serverless security policy.
", "refs": { "CreateSecurityPolicyResponse$securityPolicyDetail": "Details about the created security policy.
", "GetSecurityPolicyResponse$securityPolicyDetail": "Details about the requested security policy.
", "UpdateSecurityPolicyResponse$securityPolicyDetail": "Details about the updated security policy.
" } }, "SecurityPolicyStats": { "base": "Statistics for an OpenSearch Serverless security policy.
", "refs": { "GetPoliciesStatsResponse$SecurityPolicyStats": "Information about the security policies in your account.
" } }, "SecurityPolicySummaries": { "base": null, "refs": { "ListSecurityPoliciesResponse$securityPolicySummaries": "Details about the security policies in your account.
" } }, "SecurityPolicySummary": { "base": "A summary of a security policy for OpenSearch Serverless.
", "refs": { "SecurityPolicySummaries$member": null } }, "SecurityPolicyType": { "base": null, "refs": { "CreateSecurityPolicyRequest$type": "The type of security policy.
", "DeleteSecurityPolicyRequest$type": "The type of policy.
", "GetSecurityPolicyRequest$type": "The type of security policy.
", "ListSecurityPoliciesRequest$type": "The type of policy.
", "SecurityPolicyDetail$type": "The type of security policy.
", "SecurityPolicySummary$type": "The type of security policy.
", "UpdateSecurityPolicyRequest$type": "The type of access policy.
" } }, "ServerlessGeneration": { "base": null, "refs": { "CollectionGroupDetail$generation": "The generation of Amazon OpenSearch Serverless for the collection group.
", "CollectionGroupSummary$generation": "The generation of Amazon OpenSearch Serverless for the collection group.
", "CreateCollectionGroupDetail$generation": "The generation of Amazon OpenSearch Serverless for the collection group.
", "CreateCollectionGroupRequest$generation": "The generation of Amazon OpenSearch Serverless for the collection group. Valid values are CLASSIC and NEXTGEN.
The generation of Amazon OpenSearch Serverless for the collection group.
" } }, "ServerlessVectorAccelerationStatus": { "base": "Specifies whether serverless vector acceleration is enabled for the collection.
", "refs": { "VectorOptions$ServerlessVectorAcceleration": "Specifies whether serverless vector acceleration is enabled for the collection.
" } }, "ServiceQuotaExceededException": { "base": "Thrown when you attempt to create more resources than the service allows based on service quotas.
", "refs": {} }, "SqsArn": { "base": null, "refs": { "IngestionStreamS3Source$sqsArn": "The Amazon Resource Name (ARN) of the Amazon SQS queue that receives Amazon S3 event notifications for the source buckets.
" } }, "StandbyReplicas": { "base": null, "refs": { "CollectionDetail$standbyReplicas": "Details about an OpenSearch Serverless collection.
", "CollectionGroupDetail$standbyReplicas": "Indicates whether standby replicas are used for the collection group.
", "CreateCollectionDetail$standbyReplicas": "Creates details about an OpenSearch Serverless collection.
", "CreateCollectionGroupDetail$standbyReplicas": "Indicates whether standby replicas are used for the collection group.
", "CreateCollectionGroupRequest$standbyReplicas": "Indicates whether standby replicas should be used for a collection group.
", "CreateCollectionRequest$standbyReplicas": "Indicates whether standby replicas should be used for a collection.
" } }, "StreamBucketConfig": { "base": "S3 bucket configuration for SQS-driven ingestion. The scan mode controls only the optional one-time delta scan of existing objects in this bucket.
", "refs": { "StreamBucketConfigs$member": null } }, "StreamBucketConfigs": { "base": null, "refs": { "IngestionStreamS3Source$buckets": "The configuration for each Amazon S3 bucket that the ingestion stream ingests data from.
" } }, "String": { "base": null, "refs": { "CollectionDetail$description": "A description of the collection.
", "CollectionDetail$arn": "The Amazon Resource Name (ARN) of the collection.
", "CollectionDetail$kmsKeyArn": "The ARN of the Amazon Web Services KMS key used to encrypt the collection.
", "CollectionDetail$collectionEndpoint": "Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
", "CollectionDetail$dashboardEndpoint": "Collection-specific endpoint used to access OpenSearch Dashboards.
", "CollectionDetail$failureCode": "A failure code associated with the request.
", "CollectionDetail$failureMessage": "A message associated with the failure code.
", "CollectionErrorDetail$errorMessage": "A description of the error. For example, The specified Collection is not found.
The error code for the request. For example, NOT_FOUND.
The Amazon Resource Name (ARN) of the collection group.
", "CollectionGroupDetail$description": "The description of the collection group.
", "CollectionGroupErrorDetail$errorMessage": "A description of the error. For example, The specified Collection Group is not found.
The error code for the request. For example, NOT_FOUND.
The Amazon Resource Name (ARN) of the collection group.
", "CollectionSummary$arn": "The Amazon Resource Name (ARN) of the collection.
", "CollectionSummary$kmsKeyArn": "The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.
", "ConflictException$message": null, "CreateCollectionDetail$description": "A description of the collection.
", "CreateCollectionDetail$arn": "The Amazon Resource Name (ARN) of the collection.
", "CreateCollectionDetail$kmsKeyArn": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
", "CreateCollectionGroupDetail$arn": "The Amazon Resource Name (ARN) of the collection group.
", "CreateCollectionGroupDetail$description": "The description of the collection group.
", "EffectiveLifecyclePolicyDetail$retentionPeriod": "The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.
", "EffectiveLifecyclePolicyErrorDetail$errorMessage": "A description of the error. For example, The specified Index resource is not found.
The error code for the request.
", "FipsEndpoints$collectionEndpoint": "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.
", "FipsEndpoints$dashboardEndpoint": "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.
", "IamIdentityCenterConfigOptions$applicationName": "The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
", "IamIdentityCenterConfigOptions$applicationDescription": "The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.
", "IngestionAlert$message": "A description of the alert.
", "IngestionFailureReason$message": "A description of the reason for the failure.
", "InternalServerException$message": null, "LifecyclePolicyErrorDetail$errorMessage": "A description of the error. For example, The specified Lifecycle Policy is not found.
The error code for the request. For example, NOT_FOUND.
If your initial ListAccessPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListAccessPolicies operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListCollectionGroups operation returns a nextToken, you can include the returned nextToken in subsequent ListCollectionGroups operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListIngestionJobs operation returns a nextToken, you can include the returned nextToken in subsequent ListIngestionJobs operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListIngestionStreams operation returns a nextToken, you can include the returned nextToken in subsequent ListIngestionStreams operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListLifecyclePolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListLifecyclePolicies operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListSecurityConfigs operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityConfigs operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListSecurityPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Description of the error.
", "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": "Description of the error.
", "ServiceQuotaExceededException$resourceId": "Identifier of the resource affected.
", "ServiceQuotaExceededException$resourceType": "Type of the resource affected.
", "ServiceQuotaExceededException$serviceCode": "Service Quotas requirement to identify originating service.
", "ServiceQuotaExceededException$quotaCode": "Service Quotas requirement to identify originating quota.
", "UpdateCollectionDetail$description": "The description of the collection.
", "UpdateCollectionDetail$kmsKeyArn": "The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key used to encrypt the collection.
", "UpdateCollectionDetail$arn": "The Amazon Resource Name (ARN) of the collection.
", "UpdateCollectionGroupDetail$arn": "The Amazon Resource Name (ARN) of the collection group.
", "UpdateCollectionGroupDetail$description": "The description of the collection group.
", "ValidationException$message": null, "VpcEndpointDetail$failureCode": "A failure code associated with the request.
", "VpcEndpointDetail$failureMessage": "A message associated with the failure code.
", "VpcEndpointErrorDetail$errorMessage": "An error message describing the reason for the failure.
", "VpcEndpointErrorDetail$errorCode": "The error code for the failed request.
" } }, "SubnetId": { "base": null, "refs": { "SubnetIds$member": null } }, "SubnetIds": { "base": null, "refs": { "CreateVpcEndpointRequest$subnetIds": "The ID of one or more subnets from which you'll access OpenSearch Serverless.
", "UpdateVpcEndpointDetail$subnetIds": "The ID of the subnets from which you access OpenSearch Serverless.
", "UpdateVpcEndpointRequest$addSubnetIds": "The ID of one or more subnets to add to the endpoint.
", "UpdateVpcEndpointRequest$removeSubnetIds": "The unique identifiers of the subnets to remove from the endpoint.
", "VpcEndpointDetail$subnetIds": "The ID of the subnets from which you access OpenSearch Serverless.
" } }, "Tag": { "base": "A map of key-value pairs associated to an OpenSearch Serverless resource.
", "refs": { "Tags$member": null } }, "TagKey": { "base": null, "refs": { "Tag$key": "The key to use in the tag.
", "TagKeys$member": null } }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The tag or set of tags to remove from the resource. All tag keys in the request must be unique.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "Tag$value": "The value of the tag.
" } }, "Tags": { "base": null, "refs": { "CollectionGroupDetail$tags": "A map of key-value pairs associated with the collection group.
", "CreateCollectionGroupDetail$tags": "A map of key-value pairs associated with the collection group.
", "CreateCollectionGroupRequest$tags": "An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.
", "CreateCollectionRequest$tags": "An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
", "CreateIngestionJobRequest$tags": "An arbitrary set of tags (key–value pairs) to associate with the ingestion job.
", "CreateIngestionStreamRequest$tags": "An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.
", "ListTagsForResourceResponse$tags": "The tags associated with the resource.
", "TagResourceRequest$tags": "A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.
" } }, "Timestamp": { "base": null, "refs": { "IngestionJobDetail$createdAt": "The date and time when the ingestion job was created.
", "IngestionJobDetail$updatedAt": "The date and time when the ingestion job was last updated.
", "IngestionJobSummary$createdAt": "The date and time when the ingestion job was created.
", "IngestionJobSummary$updatedAt": "The date and time when the ingestion job was last updated.
", "IngestionStreamDetail$createdAt": "The date and time when the ingestion stream was created.
", "IngestionStreamDetail$updatedAt": "The date and time when the ingestion stream was last updated.
", "IngestionStreamSummary$createdAt": "The date and time when the ingestion stream was created.
", "IngestionStreamSummary$updatedAt": "The date and time when the ingestion stream was last updated.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateAccessPolicyRequest": { "base": null, "refs": {} }, "UpdateAccessPolicyResponse": { "base": null, "refs": {} }, "UpdateAccountSettingsRequest": { "base": null, "refs": {} }, "UpdateAccountSettingsResponse": { "base": null, "refs": {} }, "UpdateCollectionDetail": { "base": "Details about an updated OpenSearch Serverless collection.
", "refs": { "UpdateCollectionResponse$updateCollectionDetail": "Details about the updated collection.
" } }, "UpdateCollectionGroupDetail": { "base": "Details about the updated collection group.
", "refs": { "UpdateCollectionGroupResponse$updateCollectionGroupDetail": "Details about the updated collection group.
" } }, "UpdateCollectionGroupRequest": { "base": null, "refs": {} }, "UpdateCollectionGroupRequestDescriptionString": { "base": null, "refs": { "UpdateCollectionGroupRequest$description": "A new description for the collection group.
" } }, "UpdateCollectionGroupResponse": { "base": null, "refs": {} }, "UpdateCollectionRequest": { "base": null, "refs": {} }, "UpdateCollectionRequestDescriptionString": { "base": null, "refs": { "UpdateCollectionRequest$description": "A description of the collection.
" } }, "UpdateCollectionResponse": { "base": null, "refs": {} }, "UpdateIamIdentityCenterConfigOptions": { "base": "Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.
", "refs": { "UpdateSecurityConfigRequest$iamIdentityCenterOptionsUpdates": "Describes IAM Identity Center options in the form of a key-value map.
" } }, "UpdateIndexRequest": { "base": null, "refs": {} }, "UpdateIndexResponse": { "base": null, "refs": {} }, "UpdateLifecyclePolicyRequest": { "base": null, "refs": {} }, "UpdateLifecyclePolicyResponse": { "base": null, "refs": {} }, "UpdateSecurityConfigRequest": { "base": null, "refs": {} }, "UpdateSecurityConfigResponse": { "base": null, "refs": {} }, "UpdateSecurityPolicyRequest": { "base": null, "refs": {} }, "UpdateSecurityPolicyResponse": { "base": null, "refs": {} }, "UpdateVpcEndpointDetail": { "base": "Update details for an OpenSearch Serverless-managed interface endpoint.
", "refs": { "UpdateVpcEndpointResponse$UpdateVpcEndpointDetail": "Details about the updated VPC endpoint.
" } }, "UpdateVpcEndpointRequest": { "base": null, "refs": {} }, "UpdateVpcEndpointResponse": { "base": null, "refs": {} }, "ValidationException": { "base": "Thrown when the HTTP request contains invalid input or is missing required input.
", "refs": {} }, "VectorOptions": { "base": "Configuration options for vector search capabilities in an OpenSearch Serverless collection.
", "refs": { "CollectionDetail$vectorOptions": "Configuration options for vector search capabilities in the collection.
", "CreateCollectionDetail$vectorOptions": "Configuration options for vector search capabilities in the collection.
", "CreateCollectionRequest$vectorOptions": "Configuration options for vector search capabilities in the collection.
", "UpdateCollectionDetail$vectorOptions": "Configuration options for vector search capabilities in the collection.
", "UpdateCollectionRequest$vectorOptions": "Configuration options for vector search capabilities in the collection.
" } }, "VpcEndpointDetail": { "base": "Details about an OpenSearch Serverless-managed interface endpoint.
", "refs": { "VpcEndpointDetails$member": null } }, "VpcEndpointDetails": { "base": null, "refs": { "BatchGetVpcEndpointResponse$vpcEndpointDetails": "Details about the specified VPC endpoint.
" } }, "VpcEndpointErrorDetail": { "base": "Error information for a failed BatchGetVpcEndpoint request.
Error information for a failed request.
" } }, "VpcEndpointFilters": { "base": "Filter the results of a ListVpcEndpoints request.
Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.
The unique identifier of the endpoint.
", "DeleteVpcEndpointDetail$id": "The unique identifier of the endpoint.
", "DeleteVpcEndpointRequest$id": "The VPC endpoint identifier.
", "UpdateVpcEndpointDetail$id": "The unique identifier of the endpoint.
", "UpdateVpcEndpointRequest$id": "The unique identifier of the interface endpoint to update.
", "VpcEndpointDetail$id": "The unique identifier of the endpoint.
", "VpcEndpointErrorDetail$id": "The unique identifier of the VPC endpoint.
", "VpcEndpointIds$member": null, "VpcEndpointSummary$id": "The unique identifier of the endpoint.
" } }, "VpcEndpointIds": { "base": null, "refs": { "BatchGetVpcEndpointRequest$ids": "A list of VPC endpoint identifiers.
" } }, "VpcEndpointName": { "base": null, "refs": { "CreateVpcEndpointDetail$name": "The name of the endpoint.
", "CreateVpcEndpointRequest$name": "The name of the interface endpoint.
", "DeleteVpcEndpointDetail$name": "The name of the endpoint.
", "UpdateVpcEndpointDetail$name": "The name of the endpoint.
", "VpcEndpointDetail$name": "The name of the endpoint.
", "VpcEndpointSummary$name": "The name of the endpoint.
" } }, "VpcEndpointStatus": { "base": null, "refs": { "CreateVpcEndpointDetail$status": "The current status in the endpoint creation process.
", "DeleteVpcEndpointDetail$status": "The current status of the endpoint deletion process.
", "UpdateVpcEndpointDetail$status": "The current status of the endpoint update process.
", "VpcEndpointDetail$status": "The current status of the endpoint.
", "VpcEndpointFilters$status": "The current status of the endpoint.
", "VpcEndpointSummary$status": "The current status of the endpoint.
" } }, "VpcEndpointSummaries": { "base": null, "refs": { "ListVpcEndpointsResponse$vpcEndpointSummaries": "Details about each VPC endpoint, including the name and current status.
" } }, "VpcEndpointSummary": { "base": "The VPC endpoint object.
", "refs": { "VpcEndpointSummaries$member": null } }, "VpcId": { "base": null, "refs": { "CreateVpcEndpointRequest$vpcId": "The ID of the VPC from which you'll access OpenSearch Serverless.
", "VpcEndpointDetail$vpcId": "The ID of the VPC from which you access OpenSearch Serverless.
" } }, "iamFederationGroupAttribute": { "base": null, "refs": { "IamFederationConfigOptions$groupAttribute": "The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions.
" } }, "iamFederationUserAttribute": { "base": null, "refs": { "IamFederationConfigOptions$userAttribute": "The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process.
" } }, "openSearchServerlessEntityId": { "base": null, "refs": { "SamlConfigOptions$openSearchServerlessEntityId": "Custom entity ID attribute to override the default entity ID for this SAML integration.
" } }, "samlGroupAttribute": { "base": null, "refs": { "SamlConfigOptions$groupAttribute": "The group attribute for this SAML integration.
" } }, "samlMetadata": { "base": null, "refs": { "SamlConfigOptions$metadata": "The XML IdP metadata file generated from your identity provider.
" } }, "samlUserAttribute": { "base": null, "refs": { "SamlConfigOptions$userAttribute": "A user attribute for this SAML integration.
" } } } }