{ "smithy": "2.0", "shapes": { "com.amazonaws.opensearchserverless#AccessPolicy": { "type": "resource", "identifiers": { "type": { "target": "com.amazonaws.opensearchserverless#AccessPolicyType" }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName" } }, "put": { "target": "com.amazonaws.opensearchserverless#CreateAccessPolicy" }, "read": { "target": "com.amazonaws.opensearchserverless#GetAccessPolicy" }, "update": { "target": "com.amazonaws.opensearchserverless#UpdateAccessPolicy" }, "delete": { "target": "com.amazonaws.opensearchserverless#DeleteAccessPolicy" }, "list": { "target": "com.amazonaws.opensearchserverless#ListAccessPolicies" }, "traits": { "aws.cloudformation#cfnResource": { "name": "AccessPolicy" } } }, "com.amazonaws.opensearchserverless#AccessPolicyDetail": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#AccessPolicyType", "traits": { "smithy.api#documentation": "
The type of access policy.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
" } }, "policyVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the policy.
" } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "The description of the policy.
" } }, "policy": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The JSON policy document without any whitespaces.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date the policy was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp of when the policy was last modified.
" } } }, "traits": { "smithy.api#documentation": "Details about an OpenSearch Serverless access policy.
" } }, "com.amazonaws.opensearchserverless#AccessPolicyStats": { "type": "structure", "members": { "DataPolicyCount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of data access policies in the current account.
" } } }, "traits": { "smithy.api#documentation": "Statistics for an OpenSearch Serverless access policy.
" } }, "com.amazonaws.opensearchserverless#AccessPolicySummaries": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#AccessPolicySummary" } }, "com.amazonaws.opensearchserverless#AccessPolicySummary": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#AccessPolicyType", "traits": { "smithy.api#documentation": "The type of access policy. Currently, the only available type is data.
The name of the access policy.
" } }, "policyVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the policy.
" } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "The description of the access policy.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The Epoch time when the access policy was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date and time when the collection was last modified.
" } } }, "traits": { "smithy.api#documentation": "A summary of the data access policy.
" } }, "com.amazonaws.opensearchserverless#AccessPolicyType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "data", "value": "data", "documentation": "data policy type" } ] } }, "com.amazonaws.opensearchserverless#AccountSettingsDetail": { "type": "structure", "members": { "capacityLimits": { "target": "com.amazonaws.opensearchserverless#CapacityLimits" } }, "traits": { "smithy.api#documentation": "OpenSearch Serverless-related information for the current account.
" } }, "com.amazonaws.opensearchserverless#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 } } }, "com.amazonaws.opensearchserverless#AutoscalingStatus": { "type": "string", "traits": { "smithy.api#documentation": "The autoscaling status of an OpenSearch Serverless collection group: ACTION_SCALING_UP, ACTION_SCALING_DOWN, or NO_ACTION.
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.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#BatchGetCollectionGroup": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#BatchGetCollectionGroupRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#BatchGetCollectionGroupResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#BatchGetCollectionGroupRequest": { "type": "structure", "members": { "ids": { "target": "com.amazonaws.opensearchserverless#CollectionGroupIds", "traits": { "smithy.api#documentation": "A list of collection group IDs. You can't provide names and IDs in the same request.
" } }, "names": { "target": "com.amazonaws.opensearchserverless#CollectionGroupNames", "traits": { "smithy.api#documentation": "A list of collection group names. You can't provide names and IDs in the same request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#BatchGetCollectionGroupResponse": { "type": "structure", "members": { "collectionGroupDetails": { "target": "com.amazonaws.opensearchserverless#CollectionGroupDetails", "traits": { "smithy.api#documentation": "Details about each collection group.
" } }, "collectionGroupErrorDetails": { "target": "com.amazonaws.opensearchserverless#CollectionGroupErrorDetails", "traits": { "smithy.api#documentation": "Error information for the request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#BatchGetCollectionRequest": { "type": "structure", "members": { "ids": { "target": "com.amazonaws.opensearchserverless#CollectionIds", "traits": { "smithy.api#documentation": "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.
" } }, "names": { "target": "com.amazonaws.opensearchserverless#CollectionNames", "traits": { "smithy.api#documentation": "A list of collection names. You can't provide names and IDs in the same request.
" } } } }, "com.amazonaws.opensearchserverless#BatchGetCollectionResponse": { "type": "structure", "members": { "collectionDetails": { "target": "com.amazonaws.opensearchserverless#CollectionDetails", "traits": { "smithy.api#documentation": "Details about each collection.
" } }, "collectionErrorDetails": { "target": "com.amazonaws.opensearchserverless#CollectionErrorDetails", "traits": { "smithy.api#documentation": "Error information for the request.
" } } } }, "com.amazonaws.opensearchserverless#BatchGetEffectiveLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#BatchGetEffectiveLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#BatchGetEffectiveLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#BatchGetEffectiveLifecyclePolicyRequest": { "type": "structure", "members": { "resourceIdentifiers": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyResourceIdentifiers", "traits": { "smithy.api#documentation": "The unique identifiers of policy types and resource names.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#BatchGetEffectiveLifecyclePolicyResponse": { "type": "structure", "members": { "effectiveLifecyclePolicyDetails": { "target": "com.amazonaws.opensearchserverless#EffectiveLifecyclePolicyDetails", "traits": { "smithy.api#documentation": "A list of lifecycle policies applied to the OpenSearch Serverless indexes.
" } }, "effectiveLifecyclePolicyErrorDetails": { "target": "com.amazonaws.opensearchserverless#EffectiveLifecyclePolicyErrorDetails", "traits": { "smithy.api#documentation": "A list of resources for which retrieval failed.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#BatchGetLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#BatchGetLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#BatchGetLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#BatchGetLifecyclePolicyRequest": { "type": "structure", "members": { "identifiers": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyIdentifiers", "traits": { "smithy.api#documentation": "The unique identifiers of policy types and policy names.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#BatchGetLifecyclePolicyResponse": { "type": "structure", "members": { "lifecyclePolicyDetails": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyDetails", "traits": { "smithy.api#documentation": "A list of lifecycle policies matched to the input policy name and policy type.
" } }, "lifecyclePolicyErrorDetails": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyErrorDetails", "traits": { "smithy.api#documentation": "A list of lifecycle policy names and policy types for which retrieval failed.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#BatchGetVpcEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#BatchGetVpcEndpointRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#BatchGetVpcEndpointResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#BatchGetVpcEndpointRequest": { "type": "structure", "members": { "ids": { "target": "com.amazonaws.opensearchserverless#VpcEndpointIds", "traits": { "smithy.api#documentation": "A list of VPC endpoint identifiers.
", "smithy.api#required": {} } } } }, "com.amazonaws.opensearchserverless#BatchGetVpcEndpointResponse": { "type": "structure", "members": { "vpcEndpointDetails": { "target": "com.amazonaws.opensearchserverless#VpcEndpointDetails", "traits": { "smithy.api#documentation": "Details about the specified VPC endpoint.
" } }, "vpcEndpointErrorDetails": { "target": "com.amazonaws.opensearchserverless#VpcEndpointErrorDetails", "traits": { "smithy.api#documentation": "Error information for a failed request.
" } } } }, "com.amazonaws.opensearchserverless#BucketOwnerAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.opensearchserverless#CancelIngestionJob": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CancelIngestionJobRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CancelIngestionJobResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Cancels an in-progress ingestion job. Documents that were already indexed before the cancellation remain in the index.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#CancelIngestionJobRequest": { "type": "structure", "members": { "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection that the ingestion job belongs to.
", "smithy.api#required": {} } }, "ingestionJobId": { "target": "com.amazonaws.opensearchserverless#IngestionJobId", "traits": { "smithy.api#documentation": "The unique identifier of the ingestion job to cancel.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#CancelIngestionJobResponse": { "type": "structure", "members": { "ingestionJobId": { "target": "com.amazonaws.opensearchserverless#IngestionJobId", "traits": { "smithy.api#documentation": "The unique identifier of the cancelled ingestion job.
" } }, "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection that the ingestion job belongs to.
" } }, "ingestionJobName": { "target": "com.amazonaws.opensearchserverless#IngestionJobName", "traits": { "smithy.api#documentation": "The name of the cancelled ingestion job.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#IngestionJobStatus", "traits": { "smithy.api#documentation": "The current status of the ingestion job.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#CapacityDetails": { "type": "structure", "members": { "capacityInOcu": { "target": "smithy.api#Float", "traits": { "smithy.api#documentation": "The current capacity in OpenSearch Compute Units (OCUs).
" } }, "autoscalingStatus": { "target": "com.amazonaws.opensearchserverless#AutoscalingStatus", "traits": { "smithy.api#documentation": "The current autoscaling status for the collection group.
" } } }, "traits": { "smithy.api#documentation": "Capacity details for an OpenSearch Serverless collection group, including the current capacity and autoscaling status.
" } }, "com.amazonaws.opensearchserverless#CapacityLimits": { "type": "structure", "members": { "maxIndexingCapacityInOCU": { "target": "com.amazonaws.opensearchserverless#IndexingCapacityValue", "traits": { "smithy.api#documentation": "The maximum indexing capacity for collections.
" } }, "maxSearchCapacityInOCU": { "target": "com.amazonaws.opensearchserverless#SearchCapacityValue", "traits": { "smithy.api#documentation": "The maximum search capacity for collections.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.opensearchserverless#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.opensearchserverless#Collection": { "type": "resource", "identifiers": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId" } }, "create": { "target": "com.amazonaws.opensearchserverless#CreateCollection" }, "update": { "target": "com.amazonaws.opensearchserverless#UpdateCollection" }, "delete": { "target": "com.amazonaws.opensearchserverless#DeleteCollection" }, "list": { "target": "com.amazonaws.opensearchserverless#ListCollections" }, "traits": { "aws.api#arn": { "template": "collection/{id}" }, "aws.cloudformation#cfnResource": { "name": "Collection" } } }, "com.amazonaws.opensearchserverless#CollectionDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "A unique identifier for the collection.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionName", "traits": { "smithy.api#documentation": "The name of the collection.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#CollectionStatus", "traits": { "smithy.api#documentation": "The current status of the collection.
" } }, "type": { "target": "com.amazonaws.opensearchserverless#CollectionType", "traits": { "smithy.api#documentation": "The type of collection.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the collection.
" } }, "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collection.
" } }, "kmsKeyArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ARN of the Amazon Web Services KMS key used to encrypt the collection.
" } }, "standbyReplicas": { "target": "com.amazonaws.opensearchserverless#StandbyReplicas", "traits": { "smithy.api#documentation": "Details about an OpenSearch Serverless collection.
" } }, "deletionProtection": { "target": "com.amazonaws.opensearchserverless#DeletionProtection", "traits": { "smithy.api#documentation": "Indicates whether deletion protection is ENABLED or DISABLED for the collection.
Configuration options for vector search capabilities in the collection.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The Epoch time when the collection was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date and time when the collection was last modified.
" } }, "collectionEndpoint": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
" } }, "dashboardEndpoint": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Collection-specific endpoint used to access OpenSearch Dashboards.
" } }, "fipsEndpoints": { "target": "com.amazonaws.opensearchserverless#FipsEndpoints", "traits": { "smithy.api#documentation": "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.
" } }, "failureCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A failure code associated with the request.
" } }, "failureMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message associated with the failure code.
" } }, "collectionGroupName": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group that contains this collection.
" } } }, "traits": { "smithy.api#documentation": "Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.
" } }, "com.amazonaws.opensearchserverless#CollectionDetails": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionDetail" } }, "com.amazonaws.opensearchserverless#CollectionErrorDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "If the request contains collection IDs, the response includes the IDs provided in the request.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionName", "traits": { "smithy.api#documentation": "If the request contains collection names, the response includes the names provided in the request.
" } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the error. For example, The specified Collection is not found.
The error code for the request. For example, NOT_FOUND.
Error information for an OpenSearch Serverless request.
" } }, "com.amazonaws.opensearchserverless#CollectionErrorDetails": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionErrorDetail" } }, "com.amazonaws.opensearchserverless#CollectionFilters": { "type": "structure", "members": { "name": { "target": "com.amazonaws.opensearchserverless#CollectionName", "traits": { "smithy.api#documentation": "The name of the collection.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#CollectionStatus", "traits": { "smithy.api#documentation": "The current status of the collection.
" } }, "collectionGroupName": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group to filter by.
" } } }, "traits": { "smithy.api#documentation": "A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.
" } }, "com.amazonaws.opensearchserverless#CollectionGroup": { "type": "resource", "identifiers": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionGroupId" } }, "create": { "target": "com.amazonaws.opensearchserverless#CreateCollectionGroup" }, "update": { "target": "com.amazonaws.opensearchserverless#UpdateCollectionGroup" }, "delete": { "target": "com.amazonaws.opensearchserverless#DeleteCollectionGroup" }, "list": { "target": "com.amazonaws.opensearchserverless#ListCollectionGroups" }, "traits": { "aws.api#arn": { "template": "collection-group/{id}" }, "aws.cloudformation#cfnResource": { "name": "CollectionGroup" } } }, "com.amazonaws.opensearchserverless#CollectionGroupCapacityLimits": { "type": "structure", "members": { "maxIndexingCapacityInOCU": { "target": "com.amazonaws.opensearchserverless#CollectionGroupMaxIndexingCapacityValue", "traits": { "smithy.api#documentation": "The maximum indexing capacity for collections in the group.
" } }, "maxSearchCapacityInOCU": { "target": "com.amazonaws.opensearchserverless#CollectionGroupMaxSearchCapacityValue", "traits": { "smithy.api#documentation": "The maximum search capacity for collections in the group.
" } }, "minIndexingCapacityInOCU": { "target": "com.amazonaws.opensearchserverless#CollectionGroupMinIndexingCapacityValue", "traits": { "smithy.api#documentation": "The minimum indexing capacity for collections in the group.
" } }, "minSearchCapacityInOCU": { "target": "com.amazonaws.opensearchserverless#CollectionGroupMinSearchCapacityValue", "traits": { "smithy.api#documentation": "The minimum search capacity for collections in the group.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.opensearchserverless#CollectionGroupDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionGroupId", "traits": { "smithy.api#documentation": "The unique identifier of the collection group.
" } }, "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collection group.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group.
" } }, "standbyReplicas": { "target": "com.amazonaws.opensearchserverless#StandbyReplicas", "traits": { "smithy.api#documentation": "Indicates whether standby replicas are used for the collection group.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the collection group.
" } }, "tags": { "target": "com.amazonaws.opensearchserverless#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs associated with the collection group.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The Epoch time when the collection group was created.
" } }, "capacityLimits": { "target": "com.amazonaws.opensearchserverless#CollectionGroupCapacityLimits", "traits": { "smithy.api#documentation": "The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
" } }, "currentCapacity": { "target": "com.amazonaws.opensearchserverless#CurrentCapacity", "traits": { "smithy.api#documentation": "Current search and indexing capacity for the collection group.
" } }, "numberOfCollections": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of collections associated with the collection group.
" } }, "generation": { "target": "com.amazonaws.opensearchserverless#ServerlessGeneration", "traits": { "smithy.api#documentation": "The generation of Amazon OpenSearch Serverless for the collection group.
" } } }, "traits": { "smithy.api#documentation": "Details about a collection group.
" } }, "com.amazonaws.opensearchserverless#CollectionGroupDetails": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionGroupDetail" } }, "com.amazonaws.opensearchserverless#CollectionGroupErrorDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionGroupId", "traits": { "smithy.api#documentation": "If the request contains collection group IDs, the response includes the IDs provided in the request.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "If the request contains collection group names, the response includes the names provided in the request.
" } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the error. For example, The specified Collection Group is not found.
The error code for the request. For example, NOT_FOUND.
Error details for a collection group operation.
" } }, "com.amazonaws.opensearchserverless#CollectionGroupErrorDetails": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionGroupErrorDetail" } }, "com.amazonaws.opensearchserverless#CollectionGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 40 }, "smithy.api#pattern": "^[a-z0-9]{3,40}$" } }, "com.amazonaws.opensearchserverless#CollectionGroupIds": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionGroupId" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.opensearchserverless#CollectionGroupMaxIndexingCapacityValue": { "type": "float", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.opensearchserverless#CollectionGroupMaxSearchCapacityValue": { "type": "float", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.opensearchserverless#CollectionGroupMinIndexingCapacityValue": { "type": "float", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.opensearchserverless#CollectionGroupMinSearchCapacityValue": { "type": "float", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.opensearchserverless#CollectionGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 32 }, "smithy.api#pattern": "^[a-z][a-z0-9-]+$" } }, "com.amazonaws.opensearchserverless#CollectionGroupNames": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.opensearchserverless#CollectionGroupSummaries": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionGroupSummary" } }, "com.amazonaws.opensearchserverless#CollectionGroupSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionGroupId", "traits": { "smithy.api#documentation": "The unique identifier of the collection group.
" } }, "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collection group.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group.
" } }, "numberOfCollections": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of collections within the collection group.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The Epoch time when the collection group was created.
" } }, "capacityLimits": { "target": "com.amazonaws.opensearchserverless#CollectionGroupCapacityLimits" }, "generation": { "target": "com.amazonaws.opensearchserverless#ServerlessGeneration", "traits": { "smithy.api#documentation": "The generation of Amazon OpenSearch Serverless for the collection group.
" } } }, "traits": { "smithy.api#documentation": "Summary information about a collection group.
" } }, "com.amazonaws.opensearchserverless#CollectionId": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 40 }, "smithy.api#pattern": "^[a-z0-9]{3,40}$" } }, "com.amazonaws.opensearchserverless#CollectionIds": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionId" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.opensearchserverless#CollectionName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 64 }, "smithy.api#pattern": "^[a-z][a-z0-9_-]+$" } }, "com.amazonaws.opensearchserverless#CollectionNames": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionName" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.opensearchserverless#CollectionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "CREATING", "value": "CREATING", "documentation": "Creating collection resource" }, { "name": "UPDATING", "value": "UPDATING", "documentation": "Updating collection resource" }, { "name": "DELETING", "value": "DELETING", "documentation": "Deleting collection resource" }, { "name": "ACTIVE", "value": "ACTIVE", "documentation": "Collection resource is ready to use" }, { "name": "FAILED", "value": "FAILED", "documentation": "Collection resource create or delete failed" }, { "name": "UPDATE_FAILED", "value": "UPDATE_FAILED", "documentation": "Collection resource update failed" } ] } }, "com.amazonaws.opensearchserverless#CollectionSummaries": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#CollectionSummary" } }, "com.amazonaws.opensearchserverless#CollectionSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionName", "traits": { "smithy.api#documentation": "The name of the collection.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#CollectionStatus", "traits": { "smithy.api#documentation": "The current status of the collection.
" } }, "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collection.
" } }, "kmsKeyArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.
" } }, "collectionGroupName": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group that contains this collection.
" } } }, "traits": { "smithy.api#documentation": "Details about each OpenSearch Serverless collection.
" } }, "com.amazonaws.opensearchserverless#CollectionType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "SEARCH", "value": "SEARCH", "documentation": "Search collection type" }, { "name": "TIMESERIES", "value": "TIMESERIES", "documentation": "Timeseries collection type" }, { "name": "VECTORSEARCH", "value": "VECTORSEARCH", "documentation": "Vectorsearch collection type" } ] } }, "com.amazonaws.opensearchserverless#ConfigDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.opensearchserverless#ConfigName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 32 }, "smithy.api#pattern": "^[a-z][a-z0-9-]+$" } }, "com.amazonaws.opensearchserverless#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "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.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.opensearchserverless#CreateAccessPolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateAccessPolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateAccessPolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#CreateAccessPolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#AccessPolicyType", "traits": { "smithy.api#documentation": "The type of policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "A description of the policy. Typically used to store information about the permissions defined in the policy.
" } }, "policy": { "target": "com.amazonaws.opensearchserverless#PolicyDocument", "traits": { "smithy.api#documentation": "The JSON policy document to use as the content for the policy.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#CreateAccessPolicyResponse": { "type": "structure", "members": { "accessPolicyDetail": { "target": "com.amazonaws.opensearchserverless#AccessPolicyDetail", "traits": { "smithy.api#documentation": "Details about the created access policy.
" } } } }, "com.amazonaws.opensearchserverless#CreateCollection": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateCollectionRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateCollectionResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#OcuLimitExceededException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#CreateCollectionDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionName", "traits": { "smithy.api#documentation": "The name of the collection.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#CollectionStatus", "traits": { "smithy.api#documentation": "The current status of the collection.
" } }, "type": { "target": "com.amazonaws.opensearchserverless#CollectionType", "traits": { "smithy.api#documentation": "The type of collection.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the collection.
" } }, "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collection.
" } }, "kmsKeyArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
" } }, "standbyReplicas": { "target": "com.amazonaws.opensearchserverless#StandbyReplicas", "traits": { "smithy.api#documentation": "Creates details about an OpenSearch Serverless collection.
" } }, "deletionProtection": { "target": "com.amazonaws.opensearchserverless#DeletionProtection", "traits": { "smithy.api#documentation": "Indicates whether deletion protection is ENABLED or DISABLED for the collection.
Configuration options for vector search capabilities in the collection.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The Epoch time when the collection was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date and time when the collection was last modified.
" } }, "collectionGroupName": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group that contains this collection.
" } } }, "traits": { "smithy.api#documentation": "Details about the created OpenSearch Serverless collection.
" } }, "com.amazonaws.opensearchserverless#CreateCollectionGroup": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateCollectionGroupRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateCollectionGroupResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#CreateCollectionGroupDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionGroupId", "traits": { "smithy.api#documentation": "The unique identifier of the collection group.
" } }, "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collection group.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group.
" } }, "standbyReplicas": { "target": "com.amazonaws.opensearchserverless#StandbyReplicas", "traits": { "smithy.api#documentation": "Indicates whether standby replicas are used for the collection group.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the collection group.
" } }, "tags": { "target": "com.amazonaws.opensearchserverless#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs associated with the collection group.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The Epoch time when the collection group was created.
" } }, "capacityLimits": { "target": "com.amazonaws.opensearchserverless#CollectionGroupCapacityLimits", "traits": { "smithy.api#documentation": "The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
" } }, "generation": { "target": "com.amazonaws.opensearchserverless#ServerlessGeneration", "traits": { "smithy.api#documentation": "The generation of Amazon OpenSearch Serverless for the collection group.
" } } }, "traits": { "smithy.api#documentation": "Details about the created collection group.
" } }, "com.amazonaws.opensearchserverless#CreateCollectionGroupRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group.
", "smithy.api#required": {} } }, "standbyReplicas": { "target": "com.amazonaws.opensearchserverless#StandbyReplicas", "traits": { "smithy.api#documentation": "Indicates whether standby replicas should be used for a collection group.
", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the collection group.
", "smithy.api#length": { "max": 1000 } } }, "tags": { "target": "com.amazonaws.opensearchserverless#Tags", "traits": { "smithy.api#documentation": "An arbitrary set of tags (key\u2013value pairs) to associate with the OpenSearch Serverless collection group.
" } }, "capacityLimits": { "target": "com.amazonaws.opensearchserverless#CollectionGroupCapacityLimits", "traits": { "smithy.api#documentation": "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.
" } }, "generation": { "target": "com.amazonaws.opensearchserverless#ServerlessGeneration", "traits": { "smithy.api#documentation": "The generation of Amazon OpenSearch Serverless for the collection group. Valid values are CLASSIC and NEXTGEN.
Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#CreateCollectionGroupResponse": { "type": "structure", "members": { "createCollectionGroupDetail": { "target": "com.amazonaws.opensearchserverless#CreateCollectionGroupDetail", "traits": { "smithy.api#documentation": "Details about the created collection group.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#CreateCollectionRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.opensearchserverless#CollectionName", "traits": { "smithy.api#documentation": "Name of the collection.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.opensearchserverless#CollectionType", "traits": { "smithy.api#documentation": "The type of collection.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Description of the collection.
", "smithy.api#length": { "max": 1000 } } }, "tags": { "target": "com.amazonaws.opensearchserverless#Tags", "traits": { "smithy.api#documentation": "An arbitrary set of tags (key\u2013value pairs) to associate with the OpenSearch Serverless collection.
" } }, "standbyReplicas": { "target": "com.amazonaws.opensearchserverless#StandbyReplicas", "traits": { "smithy.api#documentation": "Indicates whether standby replicas should be used for a collection.
" } }, "vectorOptions": { "target": "com.amazonaws.opensearchserverless#VectorOptions", "traits": { "smithy.api#documentation": "Configuration options for vector search capabilities in the collection.
" } }, "collectionGroupName": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group to associate with the collection.
" } }, "encryptionConfig": { "target": "com.amazonaws.opensearchserverless#EncryptionConfig", "traits": { "smithy.api#documentation": "Encryption settings for the collection.
" } }, "deletionProtection": { "target": "com.amazonaws.opensearchserverless#DeletionProtection", "traits": { "smithy.api#documentation": "Indicates whether to enable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.
Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#CreateCollectionResponse": { "type": "structure", "members": { "createCollectionDetail": { "target": "com.amazonaws.opensearchserverless#CreateCollectionDetail", "traits": { "smithy.api#documentation": "Details about the collection.
" } } } }, "com.amazonaws.opensearchserverless#CreateIamIdentityCenterConfigOptions": { "type": "structure", "members": { "instanceArn": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn", "traits": { "smithy.api#documentation": "The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
", "smithy.api#required": {} } }, "userAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", "traits": { "smithy.api#documentation": "The user attribute for this IAM Identity Center integration. Defaults to UserId.
The group attribute for this IAM Identity Center integration. Defaults to GroupId.
Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.
" } }, "com.amazonaws.opensearchserverless#CreateIndex": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateIndexRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateIndexResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#CreateIndexRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection in which to create the index.
", "smithy.api#required": {} } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IndexName", "traits": { "smithy.api#documentation": "The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).
", "smithy.api#required": {} } }, "indexSchema": { "target": "com.amazonaws.opensearchserverless#IndexSchema", "traits": { "smithy.api#documentation": "The JSON schema definition for the index, including field mappings and settings.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#CreateIndexResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#CreateIngestionJob": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateIngestionJobRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateIngestionJobResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
The unique identifier of the collection to ingest data into.
", "smithy.api#required": {} } }, "ingestionJobName": { "target": "com.amazonaws.opensearchserverless#IngestionJobName", "traits": { "smithy.api#documentation": "The name of the ingestion job. The name must be unique within the collection.
", "smithy.api#required": {} } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index to ingest documents into.
", "smithy.api#required": {} } }, "failureIndexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index where documents that fail to be ingested are recorded.
" } }, "source": { "target": "com.amazonaws.opensearchserverless#IngestionJobSource", "traits": { "smithy.api#documentation": "The Amazon S3 source to ingest data from.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.opensearchserverless#Tags", "traits": { "smithy.api#documentation": "An arbitrary set of tags (key\u2013value pairs) to associate with the ingestion job.
" } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#CreateIngestionJobResponse": { "type": "structure", "members": { "ingestionJobDetail": { "target": "com.amazonaws.opensearchserverless#IngestionJobDetail", "traits": { "smithy.api#documentation": "Details about the created ingestion job.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#CreateIngestionStream": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateIngestionStreamRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateIngestionStreamResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
The unique identifier of the collection to ingest data into.
", "smithy.api#required": {} } }, "ingestionStreamName": { "target": "com.amazonaws.opensearchserverless#IngestionStreamName", "traits": { "smithy.api#documentation": "The name of the ingestion stream. The name must be unique within the collection.
", "smithy.api#required": {} } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index to ingest documents into.
", "smithy.api#required": {} } }, "failureIndexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index where documents that fail to be ingested are recorded.
" } }, "source": { "target": "com.amazonaws.opensearchserverless#IngestionStreamSource", "traits": { "smithy.api#documentation": "The Amazon S3 source to ingest data from, including the Amazon SQS queue that receives S3 event notifications.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.opensearchserverless#RoleArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.opensearchserverless#Tags", "traits": { "smithy.api#documentation": "An arbitrary set of tags (key\u2013value pairs) to associate with the ingestion stream.
" } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#CreateIngestionStreamResponse": { "type": "structure", "members": { "ingestionStreamDetail": { "target": "com.amazonaws.opensearchserverless#IngestionStreamDetail", "traits": { "smithy.api#documentation": "Details about the created ingestion stream.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#CreateLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#CreateLifecyclePolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the lifecycle policy.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "A description of the lifecycle policy.
" } }, "policy": { "target": "com.amazonaws.opensearchserverless#PolicyDocument", "traits": { "smithy.api#documentation": "The JSON policy document to use as the content for the lifecycle policy.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#CreateLifecyclePolicyResponse": { "type": "structure", "members": { "lifecyclePolicyDetail": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyDetail", "traits": { "smithy.api#documentation": "Details about the created lifecycle policy.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#CreateSecurityConfig": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateSecurityConfigRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateSecurityConfigResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#CreateSecurityConfigRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityConfigType", "traits": { "smithy.api#documentation": "The type of security configuration.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#ConfigName", "traits": { "smithy.api#documentation": "The name of the security configuration.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.opensearchserverless#ConfigDescription", "traits": { "smithy.api#documentation": "A description of the security configuration.
" } }, "samlOptions": { "target": "com.amazonaws.opensearchserverless#SamlConfigOptions", "traits": { "smithy.api#documentation": "Describes SAML options in the form of a key-value map. This field is required if you specify SAML for the type parameter.
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.
Describes IAM federation options in the form of a key-value map. This field is required if you specify iamFederation for the type parameter.
Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#CreateSecurityConfigResponse": { "type": "structure", "members": { "securityConfigDetail": { "target": "com.amazonaws.opensearchserverless#SecurityConfigDetail", "traits": { "smithy.api#documentation": "Details about the created security configuration.
" } } } }, "com.amazonaws.opensearchserverless#CreateSecurityPolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateSecurityPolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateSecurityPolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#CreateSecurityPolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyType", "traits": { "smithy.api#documentation": "The type of security policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "A description of the policy. Typically used to store information about the permissions defined in the policy.
" } }, "policy": { "target": "com.amazonaws.opensearchserverless#PolicyDocument", "traits": { "smithy.api#documentation": "The JSON policy document to use as the content for the new policy.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#CreateSecurityPolicyResponse": { "type": "structure", "members": { "securityPolicyDetail": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyDetail", "traits": { "smithy.api#documentation": "Details about the created security policy.
" } } } }, "com.amazonaws.opensearchserverless#CreateVpcEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#CreateVpcEndpointRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#CreateVpcEndpointResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#CreateVpcEndpointDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#VpcEndpointId", "traits": { "smithy.api#documentation": "The unique identifier of the endpoint.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#VpcEndpointName", "traits": { "smithy.api#documentation": "The name of the endpoint.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#VpcEndpointStatus", "traits": { "smithy.api#documentation": "The current status in the endpoint creation process.
" } } }, "traits": { "smithy.api#documentation": "Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
" } }, "com.amazonaws.opensearchserverless#CreateVpcEndpointRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.opensearchserverless#VpcEndpointName", "traits": { "smithy.api#documentation": "The name of the interface endpoint.
", "smithy.api#required": {} } }, "vpcId": { "target": "com.amazonaws.opensearchserverless#VpcId", "traits": { "smithy.api#documentation": "The ID of the VPC from which you'll access OpenSearch Serverless.
", "smithy.api#required": {} } }, "subnetIds": { "target": "com.amazonaws.opensearchserverless#SubnetIds", "traits": { "smithy.api#documentation": "The ID of one or more subnets from which you'll access OpenSearch Serverless.
", "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.opensearchserverless#SecurityGroupIds", "traits": { "smithy.api#documentation": "The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#CreateVpcEndpointResponse": { "type": "structure", "members": { "createVpcEndpointDetail": { "target": "com.amazonaws.opensearchserverless#CreateVpcEndpointDetail", "traits": { "smithy.api#documentation": "Details about the created interface VPC endpoint.
" } } } }, "com.amazonaws.opensearchserverless#CurrentCapacity": { "type": "structure", "members": { "search": { "target": "com.amazonaws.opensearchserverless#CapacityDetails", "traits": { "smithy.api#documentation": "The search capacity for the collection group.
" } }, "indexing": { "target": "com.amazonaws.opensearchserverless#CapacityDetails", "traits": { "smithy.api#documentation": "The indexing capacity for the collection group.
" } } }, "traits": { "smithy.api#documentation": "Current search and indexing capacity for an OpenSearch Serverless collection group. Measured in OpenSearch Compute Units (OCUs).
" } }, "com.amazonaws.opensearchserverless#DeleteAccessPolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#DeleteAccessPolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#DeleteAccessPolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#DeleteAccessPolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#AccessPolicyType", "traits": { "smithy.api#documentation": "The type of policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy to delete.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#DeleteAccessPolicyResponse": { "type": "structure", "members": {} }, "com.amazonaws.opensearchserverless#DeleteCollection": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#DeleteCollectionRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#DeleteCollectionResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#DeleteCollectionDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionName", "traits": { "smithy.api#documentation": "The name of the collection.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#CollectionStatus", "traits": { "smithy.api#documentation": "The current status of the collection.
" } }, "deletionProtection": { "target": "com.amazonaws.opensearchserverless#DeletionProtection", "traits": { "smithy.api#documentation": "Indicates whether deletion protection is ENABLED or DISABLED for the collection.
Details about a deleted OpenSearch Serverless collection.
" } }, "com.amazonaws.opensearchserverless#DeleteCollectionGroup": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#DeleteCollectionGroupRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#DeleteCollectionGroupResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#DeleteCollectionGroupRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionGroupId", "traits": { "smithy.api#documentation": "The unique identifier of the collection group to delete.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#DeleteCollectionGroupResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#DeleteCollectionRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "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.
A unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#DeleteCollectionResponse": { "type": "structure", "members": { "deleteCollectionDetail": { "target": "com.amazonaws.opensearchserverless#DeleteCollectionDetail", "traits": { "smithy.api#documentation": "Details of the deleted collection.
" } } } }, "com.amazonaws.opensearchserverless#DeleteIndex": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#DeleteIndexRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#DeleteIndexResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#DeleteIndexRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection containing the index to delete.
", "smithy.api#required": {} } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IndexName", "traits": { "smithy.api#documentation": "The name of the index to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#DeleteIndexResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#DeleteIngestionStream": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#DeleteIngestionStreamRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#DeleteIngestionStreamResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an ingestion stream. Documents that were already indexed by the stream remain in the index.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#DeleteIngestionStreamRequest": { "type": "structure", "members": { "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection that the ingestion stream belongs to.
", "smithy.api#required": {} } }, "ingestionStreamId": { "target": "com.amazonaws.opensearchserverless#IngestionStreamId", "traits": { "smithy.api#documentation": "The unique identifier of the ingestion stream to delete.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#DeleteIngestionStreamResponse": { "type": "structure", "members": { "ingestionStreamId": { "target": "com.amazonaws.opensearchserverless#IngestionStreamId", "traits": { "smithy.api#documentation": "The unique identifier of the deleted ingestion stream.
" } }, "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection that the ingestion stream belonged to.
" } }, "ingestionStreamName": { "target": "com.amazonaws.opensearchserverless#IngestionStreamName", "traits": { "smithy.api#documentation": "The name of the deleted ingestion stream.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#IngestionStreamStatus", "traits": { "smithy.api#documentation": "The current status of the ingestion stream.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#DeleteLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#DeleteLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#DeleteLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#DeleteLifecyclePolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy to delete.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#DeleteLifecyclePolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#DeleteSecurityConfig": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#DeleteSecurityConfigRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#DeleteSecurityConfigResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#DeleteSecurityConfigRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#SecurityConfigId", "traits": { "smithy.api#documentation": "The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#DeleteSecurityConfigResponse": { "type": "structure", "members": {} }, "com.amazonaws.opensearchserverless#DeleteSecurityPolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#DeleteSecurityPolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#DeleteSecurityPolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an OpenSearch Serverless security policy.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#DeleteSecurityPolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyType", "traits": { "smithy.api#documentation": "The type of policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy to delete.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#DeleteSecurityPolicyResponse": { "type": "structure", "members": {} }, "com.amazonaws.opensearchserverless#DeleteVpcEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#DeleteVpcEndpointRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#DeleteVpcEndpointResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#DeleteVpcEndpointDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#VpcEndpointId", "traits": { "smithy.api#documentation": "The unique identifier of the endpoint.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#VpcEndpointName", "traits": { "smithy.api#documentation": "The name of the endpoint.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#VpcEndpointStatus", "traits": { "smithy.api#documentation": "The current status of the endpoint deletion process.
" } } }, "traits": { "smithy.api#documentation": "Deletion details for an OpenSearch Serverless-managed interface endpoint.
" } }, "com.amazonaws.opensearchserverless#DeleteVpcEndpointRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#VpcEndpointId", "traits": { "smithy.api#documentation": "The VPC endpoint identifier.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#DeleteVpcEndpointResponse": { "type": "structure", "members": { "deleteVpcEndpointDetail": { "target": "com.amazonaws.opensearchserverless#DeleteVpcEndpointDetail", "traits": { "smithy.api#documentation": "Details about the deleted endpoint.
" } } } }, "com.amazonaws.opensearchserverless#DeletionProtection": { "type": "string", "traits": { "smithy.api#documentation": "Indicates whether deletion protection is ENABLED or DISABLED for the collection. When deletion protection is ENABLED, the collection cannot be deleted.
The type of lifecycle policy.
" } }, "resource": { "target": "com.amazonaws.opensearchserverless#Resource", "traits": { "smithy.api#documentation": "The name of the OpenSearch Serverless index resource.
" } }, "policyName": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the lifecycle policy.
" } }, "resourceType": { "target": "com.amazonaws.opensearchserverless#ResourceType", "traits": { "smithy.api#documentation": "The type of OpenSearch Serverless resource. Currently, the only supported resource is index.
The minimum number of index retention in days or hours. This is an optional parameter that will return only if it\u2019s set.
" } }, "noMinRetentionPeriod": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "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.
Error information for an OpenSearch Serverless request.
" } }, "com.amazonaws.opensearchserverless#EffectiveLifecyclePolicyDetails": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#EffectiveLifecyclePolicyDetail" } }, "com.amazonaws.opensearchserverless#EffectiveLifecyclePolicyErrorDetail": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
" } }, "resource": { "target": "com.amazonaws.opensearchserverless#Resource", "traits": { "smithy.api#documentation": "The name of OpenSearch Serverless index resource.
" } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the error. For example, The specified Index resource is not found.
The error code for the request.
" } } }, "traits": { "smithy.api#documentation": "Error information for an OpenSearch Serverless request.
" } }, "com.amazonaws.opensearchserverless#EffectiveLifecyclePolicyErrorDetails": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#EffectiveLifecyclePolicyErrorDetail" } }, "com.amazonaws.opensearchserverless#EncryptionConfig": { "type": "structure", "members": { "aWSOwnedKey": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates whether to use an Amazon Web Services-owned key for encryption.
" } }, "kmsKeyArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.
", "smithy.api#length": { "min": 10, "max": 2048 }, "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):(kms):[a-zA-Z-]+\\d{1}:\\d{12}:(key)\\/.{1,2048}" } } }, "traits": { "smithy.api#documentation": "Encryption settings for a collection.
" } }, "com.amazonaws.opensearchserverless#FipsEndpoints": { "type": "structure", "members": { "collectionEndpoint": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
" } }, "dashboardEndpoint": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.opensearchserverless#GetAccessPolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#GetAccessPolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#GetAccessPolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#GetAccessPolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#AccessPolicyType", "traits": { "smithy.api#documentation": "Tye type of policy. Currently, the only supported value is data.
The name of the access policy.
", "smithy.api#required": {} } } } }, "com.amazonaws.opensearchserverless#GetAccessPolicyResponse": { "type": "structure", "members": { "accessPolicyDetail": { "target": "com.amazonaws.opensearchserverless#AccessPolicyDetail", "traits": { "smithy.api#documentation": "Details about the requested access policy.
" } } } }, "com.amazonaws.opensearchserverless#GetAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#GetAccountSettingsRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#GetAccountSettingsResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns account-level settings related to OpenSearch Serverless.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#GetAccountSettingsRequest": { "type": "structure", "members": {} }, "com.amazonaws.opensearchserverless#GetAccountSettingsResponse": { "type": "structure", "members": { "accountSettingsDetail": { "target": "com.amazonaws.opensearchserverless#AccountSettingsDetail", "traits": { "smithy.api#documentation": "OpenSearch Serverless-related details for the current account.
" } } } }, "com.amazonaws.opensearchserverless#GetIndex": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#GetIndexRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#GetIndexResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#GetIndexRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection containing the index.
", "smithy.api#required": {} } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IndexName", "traits": { "smithy.api#documentation": "The name of the index to retrieve information about.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#GetIndexResponse": { "type": "structure", "members": { "indexSchema": { "target": "com.amazonaws.opensearchserverless#IndexSchema", "traits": { "smithy.api#documentation": "The JSON schema definition for the index, including field mappings and settings.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#GetIngestionJob": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#GetIngestionJobRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#GetIngestionJobResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about an ingestion job, including its configuration, status, and processing state.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#GetIngestionJobRequest": { "type": "structure", "members": { "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection that the ingestion job belongs to.
", "smithy.api#required": {} } }, "ingestionJobId": { "target": "com.amazonaws.opensearchserverless#IngestionJobId", "traits": { "smithy.api#documentation": "The unique identifier of the ingestion job to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#GetIngestionJobResponse": { "type": "structure", "members": { "ingestionJobDetail": { "target": "com.amazonaws.opensearchserverless#IngestionJobDetail", "traits": { "smithy.api#documentation": "Details about the requested ingestion job.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#GetIngestionStream": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#GetIngestionStreamRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#GetIngestionStreamResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about an ingestion stream, including its configuration, status, and processing state.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#GetIngestionStreamRequest": { "type": "structure", "members": { "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection that the ingestion stream belongs to.
", "smithy.api#required": {} } }, "ingestionStreamId": { "target": "com.amazonaws.opensearchserverless#IngestionStreamId", "traits": { "smithy.api#documentation": "The unique identifier of the ingestion stream to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#GetIngestionStreamResponse": { "type": "structure", "members": { "ingestionStreamDetail": { "target": "com.amazonaws.opensearchserverless#IngestionStreamDetail", "traits": { "smithy.api#documentation": "Details about the requested ingestion stream.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#GetPoliciesStats": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#GetPoliciesStatsRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#GetPoliciesStatsResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" } ], "traits": { "smithy.api#documentation": "Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#GetPoliciesStatsRequest": { "type": "structure", "members": {} }, "com.amazonaws.opensearchserverless#GetPoliciesStatsResponse": { "type": "structure", "members": { "AccessPolicyStats": { "target": "com.amazonaws.opensearchserverless#AccessPolicyStats", "traits": { "smithy.api#documentation": "Information about the data access policies in your account.
" } }, "SecurityPolicyStats": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyStats", "traits": { "smithy.api#documentation": "Information about the security policies in your account.
" } }, "SecurityConfigStats": { "target": "com.amazonaws.opensearchserverless#SecurityConfigStats", "traits": { "smithy.api#documentation": "Information about the security configurations in your account.
" } }, "LifecyclePolicyStats": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyStats", "traits": { "smithy.api#documentation": "Information about the lifecycle policies in your account.
" } }, "TotalPolicyCount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The total number of OpenSearch Serverless security policies and configurations in your account.
" } } } }, "com.amazonaws.opensearchserverless#GetSecurityConfig": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#GetSecurityConfigRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#GetSecurityConfigResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#GetSecurityConfigRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#SecurityConfigId", "traits": { "smithy.api#documentation": "The unique identifier of the security configuration.
", "smithy.api#required": {} } } } }, "com.amazonaws.opensearchserverless#GetSecurityConfigResponse": { "type": "structure", "members": { "securityConfigDetail": { "target": "com.amazonaws.opensearchserverless#SecurityConfigDetail", "traits": { "smithy.api#documentation": "Details of the requested security configuration.
" } } } }, "com.amazonaws.opensearchserverless#GetSecurityPolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#GetSecurityPolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#GetSecurityPolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#GetSecurityPolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyType", "traits": { "smithy.api#documentation": "The type of security policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the security policy.
", "smithy.api#required": {} } } } }, "com.amazonaws.opensearchserverless#GetSecurityPolicyResponse": { "type": "structure", "members": { "securityPolicyDetail": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyDetail", "traits": { "smithy.api#documentation": "Details about the requested security policy.
" } } } }, "com.amazonaws.opensearchserverless#IamFederationConfigOptions": { "type": "structure", "members": { "groupAttribute": { "target": "com.amazonaws.opensearchserverless#iamFederationGroupAttribute", "traits": { "smithy.api#documentation": "The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions.
" } }, "userAttribute": { "target": "com.amazonaws.opensearchserverless#iamFederationUserAttribute", "traits": { "smithy.api#documentation": "The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.opensearchserverless#IamIdentityCenterApplicationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 1224 }, "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" } }, "com.amazonaws.opensearchserverless#IamIdentityCenterConfigOptions": { "type": "structure", "members": { "instanceArn": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn", "traits": { "smithy.api#documentation": "The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
" } }, "applicationArn": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterApplicationArn", "traits": { "smithy.api#documentation": "The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.
" } }, "applicationName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
" } }, "applicationDescription": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.
" } }, "userAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", "traits": { "smithy.api#documentation": "The user attribute for this IAM Identity Center integration. Defaults to UserId
The group attribute for this IAM Identity Center integration. Defaults to GroupId.
Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.
" } }, "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "GroupId", "value": "GroupId", "documentation": "Group ID" }, { "name": "GroupName", "value": "GroupName", "documentation": "Group Name" } ] } }, "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 1224 }, "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" } }, "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "UserId", "value": "UserId", "documentation": "User ID" }, { "name": "UserName", "value": "UserName", "documentation": "User Name" }, { "name": "Email", "value": "Email", "documentation": "Email" } ] } }, "com.amazonaws.opensearchserverless#Index": { "type": "resource", "identifiers": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId" }, "indexName": { "target": "com.amazonaws.opensearchserverless#IndexName" } }, "put": { "target": "com.amazonaws.opensearchserverless#CreateIndex" }, "read": { "target": "com.amazonaws.opensearchserverless#GetIndex" }, "update": { "target": "com.amazonaws.opensearchserverless#UpdateIndex" }, "delete": { "target": "com.amazonaws.opensearchserverless#DeleteIndex" }, "traits": { "aws.cloudformation#cfnResource": { "name": "Index" } } }, "com.amazonaws.opensearchserverless#IndexName": { "type": "string" }, "com.amazonaws.opensearchserverless#IndexSchema": { "type": "document" }, "com.amazonaws.opensearchserverless#IndexingCapacityValue": { "type": "integer", "traits": { "smithy.api#range": { "min": 2 } } }, "com.amazonaws.opensearchserverless#IngestionAlert": { "type": "structure", "members": { "code": { "target": "com.amazonaws.opensearchserverless#IngestionAlertCode", "traits": { "smithy.api#documentation": "The code that identifies the alert.
" } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the alert.
" } } }, "traits": { "smithy.api#documentation": "An active alert about a running ingestion \u2014 operational issues\nor updates to processing state. Cleared when the issue resolves." } }, "com.amazonaws.opensearchserverless#IngestionAlertCode": { "type": "string", "traits": { "smithy.api#documentation": "Codes for active operational issues affecting a running ingestion.", "smithy.api#enum": [ { "name": "SOURCE_ACCESS_DENIED", "value": "SOURCE_ACCESS_DENIED" }, { "name": "SOURCE_RESOURCE_NOT_FOUND", "value": "SOURCE_RESOURCE_NOT_FOUND" }, { "name": "DESTINATION_ACCESS_DENIED", "value": "DESTINATION_ACCESS_DENIED" }, { "name": "DESTINATION_RESOURCE_NOT_FOUND", "value": "DESTINATION_RESOURCE_NOT_FOUND" }, { "name": "INTERNAL_SERVER_ERROR", "value": "INTERNAL_SERVER_ERROR" } ] } }, "com.amazonaws.opensearchserverless#IngestionAlerts": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#IngestionAlert" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.opensearchserverless#IngestionFailureCode": { "type": "string", "traits": { "smithy.api#documentation": "Codes explaining why an ingestion reached a terminal failure state.", "smithy.api#enum": [ { "name": "SOURCE_ACCESS_DENIED", "value": "SOURCE_ACCESS_DENIED" }, { "name": "SOURCE_RESOURCE_NOT_FOUND", "value": "SOURCE_RESOURCE_NOT_FOUND" }, { "name": "DESTINATION_ACCESS_DENIED", "value": "DESTINATION_ACCESS_DENIED" }, { "name": "DESTINATION_RESOURCE_NOT_FOUND", "value": "DESTINATION_RESOURCE_NOT_FOUND" }, { "name": "INTERNAL_SERVER_ERROR", "value": "INTERNAL_SERVER_ERROR" } ] } }, "com.amazonaws.opensearchserverless#IngestionFailureReason": { "type": "structure", "members": { "code": { "target": "com.amazonaws.opensearchserverless#IngestionFailureCode", "traits": { "smithy.api#documentation": "The code that identifies the reason for the failure.
" } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the reason for the failure.
" } } }, "traits": { "smithy.api#documentation": "A terminal failure reason explaining why an ingestion stopped." } }, "com.amazonaws.opensearchserverless#IngestionFailureReasons": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#IngestionFailureReason" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.opensearchserverless#IngestionIndexName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-z0-9.][a-z0-9._-]*$" } }, "com.amazonaws.opensearchserverless#IngestionJob": { "type": "resource", "identifiers": { "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId" }, "ingestionJobId": { "target": "com.amazonaws.opensearchserverless#IngestionJobId" } }, "create": { "target": "com.amazonaws.opensearchserverless#CreateIngestionJob" }, "read": { "target": "com.amazonaws.opensearchserverless#GetIngestionJob" }, "list": { "target": "com.amazonaws.opensearchserverless#ListIngestionJobs" }, "operations": [ { "target": "com.amazonaws.opensearchserverless#CancelIngestionJob" } ], "traits": { "aws.api#arn": { "template": "collection/{collectionId}/ingestion-job/{ingestionJobId}" } } }, "com.amazonaws.opensearchserverless#IngestionJobDetail": { "type": "structure", "members": { "ingestionJobId": { "target": "com.amazonaws.opensearchserverless#IngestionJobId", "traits": { "smithy.api#documentation": "The unique identifier of the ingestion job.
" } }, "arn": { "target": "com.amazonaws.opensearchserverless#IngestionJobResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ingestion job.
" } }, "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection that the ingestion job belongs to.
" } }, "ingestionJobName": { "target": "com.amazonaws.opensearchserverless#IngestionJobName", "traits": { "smithy.api#documentation": "The name of the ingestion job.
" } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index that documents are ingested into.
" } }, "failureIndexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index where documents that fail to be ingested are recorded.
" } }, "source": { "target": "com.amazonaws.opensearchserverless#IngestionJobSource", "traits": { "smithy.api#documentation": "The Amazon S3 source that the ingestion job ingests data from.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#IngestionJobStatus", "traits": { "smithy.api#documentation": "The current lifecycle status of the ingestion job. For example, CREATING, ACTIVE, COMPLETED, or CANCELLED.
The current processing state of the ingestion job. For example, SCANNING, INGESTION_IN_PROGRESS, or INGESTION_COMPLETE.
Processing statistics for the ingestion job, such as the number of Amazon S3 objects discovered, ingested, and failed.
" } }, "revision": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The revision number of the ingestion job.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the ingestion job was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the ingestion job was last updated.
" } }, "failureReasons": { "target": "com.amazonaws.opensearchserverless#IngestionFailureReasons", "traits": { "smithy.api#documentation": "The reasons that the ingestion job reached a terminal failure state, if applicable.
" } }, "activeAlerts": { "target": "com.amazonaws.opensearchserverless#IngestionAlerts", "traits": { "smithy.api#documentation": "Active alerts about operational issues that currently affect the ingestion job. Alerts are cleared when the issue is resolved.
" } } }, "traits": { "smithy.api#documentation": "Details about an ingestion job.
" } }, "com.amazonaws.opensearchserverless#IngestionJobId": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+$" } }, "com.amazonaws.opensearchserverless#IngestionJobName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 32 }, "smithy.api#pattern": "^[a-z][a-z0-9-]*$" } }, "com.amazonaws.opensearchserverless#IngestionJobResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):aoss:[a-z0-9-]+:\\d{12}:collection/[a-z0-9]{3,40}/ingestion-job/[a-z0-9]{20,64}$" } }, "com.amazonaws.opensearchserverless#IngestionJobS3Source": { "type": "structure", "members": { "bucket": { "target": "com.amazonaws.opensearchserverless#S3BucketNameOrArn", "traits": { "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.
" } }, "bucketOwnerAccountId": { "target": "com.amazonaws.opensearchserverless#BucketOwnerAccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket.
" } }, "keyPrefix": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A key prefix that limits ingestion to objects in the Amazon S3 bucket whose keys begin with the prefix.
", "smithy.api#length": { "max": 1024 } } } }, "traits": { "smithy.api#documentation": "The Amazon S3 source configuration for an ingestion job.
" } }, "com.amazonaws.opensearchserverless#IngestionJobSource": { "type": "structure", "members": { "s3": { "target": "com.amazonaws.opensearchserverless#IngestionJobS3Source", "traits": { "smithy.api#documentation": "The Amazon S3 source configuration for the ingestion job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The source that an ingestion job ingests data from.
" } }, "com.amazonaws.opensearchserverless#IngestionJobStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "CREATING", "value": "CREATING", "documentation": "Ingestion job is being created" }, { "name": "ACTIVE", "value": "ACTIVE", "documentation": "Ingestion job is provisioned and ingesting" }, { "name": "COMPLETED", "value": "COMPLETED", "documentation": "Bulk ingestion finished; job is complete" }, { "name": "CANCELLING", "value": "CANCELLING", "documentation": "Ingestion job is being cancelled" }, { "name": "CANCELLED", "value": "CANCELLED", "documentation": "Ingestion job was cancelled" }, { "name": "FAILED", "value": "FAILED", "documentation": "Ingestion job failed terminally (no retry)" }, { "name": "CREATE_FAILED", "value": "CREATE_FAILED", "documentation": "Ingestion job creation failed" }, { "name": "CANCEL_FAILED", "value": "CANCEL_FAILED", "documentation": "Ingestion job cancellation failed" } ] } }, "com.amazonaws.opensearchserverless#IngestionJobSummaries": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#IngestionJobSummary" } }, "com.amazonaws.opensearchserverless#IngestionJobSummary": { "type": "structure", "members": { "ingestionJobId": { "target": "com.amazonaws.opensearchserverless#IngestionJobId", "traits": { "smithy.api#documentation": "The unique identifier of the ingestion job.
" } }, "arn": { "target": "com.amazonaws.opensearchserverless#IngestionJobResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ingestion job.
" } }, "ingestionJobName": { "target": "com.amazonaws.opensearchserverless#IngestionJobName", "traits": { "smithy.api#documentation": "The name of the ingestion job.
" } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index that documents are ingested into.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#IngestionJobStatus", "traits": { "smithy.api#documentation": "The current lifecycle status of the ingestion job.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the ingestion job was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the ingestion job was last updated.
" } } }, "traits": { "smithy.api#documentation": "Summary information about an ingestion job.
" } }, "com.amazonaws.opensearchserverless#IngestionState": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "STARTING", "value": "STARTING", "documentation": "Ingestion is initializing" }, { "name": "SCANNING", "value": "SCANNING", "documentation": "Bulk source scan in progress" }, { "name": "INGESTION_IN_PROGRESS", "value": "INGESTION_IN_PROGRESS", "documentation": "Documents are being read, chunked and indexed" }, { "name": "INGESTION_COMPLETE", "value": "INGESTION_COMPLETE", "documentation": "Bulk ingestion finished" }, { "name": "STOPPED", "value": "STOPPED", "documentation": "Ingestion halted (recoverable)" }, { "name": "FAILED", "value": "FAILED", "documentation": "Ingestion runtime failure (terminal)" } ] } }, "com.amazonaws.opensearchserverless#IngestionStatistics": { "type": "structure", "members": { "s3": { "target": "com.amazonaws.opensearchserverless#S3Statistics", "traits": { "smithy.api#documentation": "Processing statistics for the Amazon S3 source.
" } } }, "traits": { "smithy.api#documentation": "Processing statistics for an ingestion job or ingestion stream.
" } }, "com.amazonaws.opensearchserverless#IngestionStream": { "type": "resource", "identifiers": { "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId" }, "ingestionStreamId": { "target": "com.amazonaws.opensearchserverless#IngestionStreamId" } }, "create": { "target": "com.amazonaws.opensearchserverless#CreateIngestionStream" }, "read": { "target": "com.amazonaws.opensearchserverless#GetIngestionStream" }, "delete": { "target": "com.amazonaws.opensearchserverless#DeleteIngestionStream" }, "list": { "target": "com.amazonaws.opensearchserverless#ListIngestionStreams" }, "traits": { "aws.api#arn": { "template": "collection/{collectionId}/ingestion-stream/{ingestionStreamId}" } } }, "com.amazonaws.opensearchserverless#IngestionStreamDetail": { "type": "structure", "members": { "ingestionStreamId": { "target": "com.amazonaws.opensearchserverless#IngestionStreamId", "traits": { "smithy.api#documentation": "The unique identifier of the ingestion stream.
" } }, "arn": { "target": "com.amazonaws.opensearchserverless#IngestionStreamResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ingestion stream.
" } }, "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection that the ingestion stream belongs to.
" } }, "ingestionStreamName": { "target": "com.amazonaws.opensearchserverless#IngestionStreamName", "traits": { "smithy.api#documentation": "The name of the ingestion stream.
" } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index that documents are ingested into.
" } }, "failureIndexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index where documents that fail to be ingested are recorded.
" } }, "source": { "target": "com.amazonaws.opensearchserverless#IngestionStreamSource", "traits": { "smithy.api#documentation": "The Amazon S3 source that the ingestion stream ingests data from.
" } }, "roleArn": { "target": "com.amazonaws.opensearchserverless#RoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#IngestionStreamStatus", "traits": { "smithy.api#documentation": "The current lifecycle status of the ingestion stream. For example, CREATING, ACTIVE, or DELETING.
The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.
Processing statistics for the ingestion stream, such as the number of Amazon S3 objects discovered, ingested, and failed.
" } }, "revision": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The revision number of the ingestion stream.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the ingestion stream was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the ingestion stream was last updated.
" } }, "failureReasons": { "target": "com.amazonaws.opensearchserverless#IngestionFailureReasons", "traits": { "smithy.api#documentation": "The reasons that the ingestion stream reached a terminal failure state, if applicable.
" } }, "activeAlerts": { "target": "com.amazonaws.opensearchserverless#IngestionAlerts", "traits": { "smithy.api#documentation": "Active alerts about operational issues that currently affect the ingestion stream. Alerts are cleared when the issue is resolved.
" } } }, "traits": { "smithy.api#documentation": "Details about an ingestion stream.
" } }, "com.amazonaws.opensearchserverless#IngestionStreamId": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+$" } }, "com.amazonaws.opensearchserverless#IngestionStreamName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 32 }, "smithy.api#pattern": "^[a-z][a-z0-9-]*$" } }, "com.amazonaws.opensearchserverless#IngestionStreamResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):aoss:[a-z0-9-]+:\\d{12}:collection/[a-z0-9]{3,40}/ingestion-stream/[a-z0-9]{20,64}$" } }, "com.amazonaws.opensearchserverless#IngestionStreamS3Source": { "type": "structure", "members": { "sqsArn": { "target": "com.amazonaws.opensearchserverless#SqsArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SQS queue that receives Amazon S3 event notifications for the source buckets.
", "smithy.api#required": {} } }, "buckets": { "target": "com.amazonaws.opensearchserverless#StreamBucketConfigs", "traits": { "smithy.api#documentation": "The configuration for each Amazon S3 bucket that the ingestion stream ingests data from.
" } } }, "traits": { "smithy.api#documentation": "The Amazon S3 source configuration for an ingestion stream.
" } }, "com.amazonaws.opensearchserverless#IngestionStreamSource": { "type": "structure", "members": { "s3": { "target": "com.amazonaws.opensearchserverless#IngestionStreamS3Source", "traits": { "smithy.api#documentation": "The Amazon S3 source configuration for the ingestion stream.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The source that an ingestion stream ingests data from.
" } }, "com.amazonaws.opensearchserverless#IngestionStreamStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "CREATING", "value": "CREATING", "documentation": "Ingestion stream is being created" }, { "name": "ACTIVE", "value": "ACTIVE", "documentation": "Ingestion stream is provisioned and ingesting" }, { "name": "DELETING", "value": "DELETING", "documentation": "Ingestion stream is being deleted" }, { "name": "DELETED", "value": "DELETED", "documentation": "Ingestion stream was deleted" }, { "name": "CREATE_FAILED", "value": "CREATE_FAILED", "documentation": "Ingestion stream creation failed" }, { "name": "DELETE_FAILED", "value": "DELETE_FAILED", "documentation": "Ingestion stream deletion failed" } ] } }, "com.amazonaws.opensearchserverless#IngestionStreamSummaries": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#IngestionStreamSummary" } }, "com.amazonaws.opensearchserverless#IngestionStreamSummary": { "type": "structure", "members": { "ingestionStreamId": { "target": "com.amazonaws.opensearchserverless#IngestionStreamId", "traits": { "smithy.api#documentation": "The unique identifier of the ingestion stream.
" } }, "arn": { "target": "com.amazonaws.opensearchserverless#IngestionStreamResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ingestion stream.
" } }, "ingestionStreamName": { "target": "com.amazonaws.opensearchserverless#IngestionStreamName", "traits": { "smithy.api#documentation": "The name of the ingestion stream.
" } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IngestionIndexName", "traits": { "smithy.api#documentation": "The name of the index that documents are ingested into.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#IngestionStreamStatus", "traits": { "smithy.api#documentation": "The current lifecycle status of the ingestion stream.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the ingestion stream was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the ingestion stream was last updated.
" } } }, "traits": { "smithy.api#documentation": "Summary information about an ingestion stream.
" } }, "com.amazonaws.opensearchserverless#InitialScan": { "type": "string", "traits": { "smithy.api#documentation": "Controls whether to perform a one-time delta scan of existing S3 objects before\ncontinuous ingestion processes SQS notifications.", "smithy.api#enum": [ { "name": "ENABLED", "value": "ENABLED", "documentation": "Perform a one-time delta scan of existing S3 objects before processing SQS notifications" }, { "name": "DISABLED", "value": "DISABLED", "documentation": "Skip the one-time delta scan and process SQS notifications only" } ] } }, "com.amazonaws.opensearchserverless#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "Thrown when an error internal to the service occurs while processing a request.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.opensearchserverless#LifecyclePolicy": { "type": "resource", "identifiers": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType" }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName" } }, "update": { "target": "com.amazonaws.opensearchserverless#UpdateLifecyclePolicy" }, "delete": { "target": "com.amazonaws.opensearchserverless#DeleteLifecyclePolicy" }, "list": { "target": "com.amazonaws.opensearchserverless#ListLifecyclePolicies" }, "traits": { "aws.cloudformation#cfnResource": { "name": "LifecyclePolicy" } } }, "com.amazonaws.opensearchserverless#LifecyclePolicyDetail": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the lifecycle policy.
" } }, "policyVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the lifecycle policy.
" } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "The description of the lifecycle policy.
" } }, "policy": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The JSON policy document without any whitespaces.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date the lifecycle policy was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp of when the lifecycle policy was last modified.
" } } }, "traits": { "smithy.api#documentation": "Details about an OpenSearch Serverless lifecycle policy.
" } }, "com.amazonaws.opensearchserverless#LifecyclePolicyDetails": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyDetail" } }, "com.amazonaws.opensearchserverless#LifecyclePolicyErrorDetail": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the lifecycle policy.
" } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the error. For example, The specified Lifecycle Policy is not found.
The error code for the request. For example, NOT_FOUND.
Error information for an OpenSearch Serverless request.
" } }, "com.amazonaws.opensearchserverless#LifecyclePolicyErrorDetails": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyErrorDetail" } }, "com.amazonaws.opensearchserverless#LifecyclePolicyIdentifier": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the lifecycle policy.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The unique identifiers of policy types and policy names.
" } }, "com.amazonaws.opensearchserverless#LifecyclePolicyIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 40 } } }, "com.amazonaws.opensearchserverless#LifecyclePolicyResourceIdentifier": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
", "smithy.api#required": {} } }, "resource": { "target": "com.amazonaws.opensearchserverless#ResourceName", "traits": { "smithy.api#documentation": "The name of the OpenSearch Serverless ilndex resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The unique identifiers of policy types and resource names.
" } }, "com.amazonaws.opensearchserverless#LifecyclePolicyResourceIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyResourceIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.opensearchserverless#LifecyclePolicyStats": { "type": "structure", "members": { "RetentionPolicyCount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of retention lifecycle policies in the current account.
" } } }, "traits": { "smithy.api#documentation": "Statistics for an OpenSearch Serverless lifecycle policy.
" } }, "com.amazonaws.opensearchserverless#LifecyclePolicySummaries": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicySummary" } }, "com.amazonaws.opensearchserverless#LifecyclePolicySummary": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the lifecycle policy.
" } }, "policyVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the lifecycle policy.
" } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "The description of the lifecycle policy.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The Epoch time when the lifecycle policy was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date and time when the lifecycle policy was last modified.
" } } }, "traits": { "smithy.api#documentation": "A summary of the lifecycle policy.
" } }, "com.amazonaws.opensearchserverless#LifecyclePolicyType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "retention", "value": "retention", "documentation": "retention policy type" } ] } }, "com.amazonaws.opensearchserverless#LifecycleResource": { "type": "string" }, "com.amazonaws.opensearchserverless#LifecycleResourceFilter": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#LifecycleResource" } }, "com.amazonaws.opensearchserverless#ListAccessPolicies": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#ListAccessPoliciesRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#ListAccessPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a list of OpenSearch Serverless access policies.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "maxResults": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#ListAccessPoliciesRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#AccessPolicyType", "traits": { "smithy.api#documentation": "The type of access policy.
", "smithy.api#required": {} } }, "resource": { "target": "com.amazonaws.opensearchserverless#ResourceFilter", "traits": { "smithy.api#documentation": "Resource filters (can be collections or indexes) that policies can apply to.
", "smithy.api#length": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
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.
Details about the requested access policies.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
Returns a list of collection groups. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "maxResults": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#ListCollectionGroupsRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.
Details about each collection group.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
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.
A list of filter names and values that you can use for requests.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.
Details about each collection.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
Returns a list of ingestion jobs in a collection.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "maxResults": "maxResults", "items": "ingestionJobSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#ListIngestionJobsRequest": { "type": "structure", "members": { "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection to list ingestion jobs for.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
The maximum number of results to return. Valid values are 1\u2013100. 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.
Summary information about each ingestion job.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
Returns a list of ingestion streams in a collection.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "maxResults": "maxResults", "items": "ingestionStreamSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#ListIngestionStreamsRequest": { "type": "structure", "members": { "collectionId": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection to list ingestion streams for.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
The maximum number of results to return. Valid values are 1\u2013100. 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.
Summary information about each ingestion stream.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "maxResults": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#ListLifecyclePoliciesRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
", "smithy.api#required": {} } }, "resources": { "target": "com.amazonaws.opensearchserverless#LifecycleResourceFilter", "traits": { "smithy.api#documentation": "Resource filters that policies can apply to. Currently, the only supported resource type is index.
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.
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.
Details about the requested lifecycle policies.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "maxResults": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#ListSecurityConfigsRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityConfigType", "traits": { "smithy.api#documentation": "The type of security configuration.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
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.
Details about the security configurations in your account.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
Returns information about configured OpenSearch Serverless security policies.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "maxResults": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#ListSecurityPoliciesRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyType", "traits": { "smithy.api#documentation": "The type of policy.
", "smithy.api#required": {} } }, "resource": { "target": "com.amazonaws.opensearchserverless#ResourceFilter", "traits": { "smithy.api#documentation": "Resource filters (can be collection or indexes) that policies can apply to.
", "smithy.api#length": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
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.
Details about the security policies in your account.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
" } }, "com.amazonaws.opensearchserverless#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.opensearchserverless#Arn", "traits": { "smithy.api#documentation": "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 tags associated with the resource.
" } } } }, "com.amazonaws.opensearchserverless#ListVpcEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#ListVpcEndpointsRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#ListVpcEndpointsResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "maxResults": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearchserverless#ListVpcEndpointsRequest": { "type": "structure", "members": { "vpcEndpointFilters": { "target": "com.amazonaws.opensearchserverless#VpcEndpointFilters", "traits": { "smithy.api#documentation": "Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.
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.
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.
Details about each VPC endpoint, including the name and current status.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.opensearchserverless#OpenSearchServerless": { "type": "service", "version": "2021-11-01", "operations": [ { "target": "com.amazonaws.opensearchserverless#BatchGetCollection" }, { "target": "com.amazonaws.opensearchserverless#BatchGetCollectionGroup" }, { "target": "com.amazonaws.opensearchserverless#BatchGetEffectiveLifecyclePolicy" }, { "target": "com.amazonaws.opensearchserverless#BatchGetLifecyclePolicy" }, { "target": "com.amazonaws.opensearchserverless#BatchGetVpcEndpoint" }, { "target": "com.amazonaws.opensearchserverless#CreateLifecyclePolicy" }, { "target": "com.amazonaws.opensearchserverless#CreateSecurityPolicy" }, { "target": "com.amazonaws.opensearchserverless#GetAccountSettings" }, { "target": "com.amazonaws.opensearchserverless#GetPoliciesStats" }, { "target": "com.amazonaws.opensearchserverless#ListTagsForResource" }, { "target": "com.amazonaws.opensearchserverless#TagResource" }, { "target": "com.amazonaws.opensearchserverless#UntagResource" }, { "target": "com.amazonaws.opensearchserverless#UpdateAccountSettings" }, { "target": "com.amazonaws.opensearchserverless#UpdateVpcEndpoint" } ], "resources": [ { "target": "com.amazonaws.opensearchserverless#AccessPolicy" }, { "target": "com.amazonaws.opensearchserverless#Collection" }, { "target": "com.amazonaws.opensearchserverless#CollectionGroup" }, { "target": "com.amazonaws.opensearchserverless#Index" }, { "target": "com.amazonaws.opensearchserverless#IngestionJob" }, { "target": "com.amazonaws.opensearchserverless#IngestionStream" }, { "target": "com.amazonaws.opensearchserverless#LifecyclePolicy" }, { "target": "com.amazonaws.opensearchserverless#SecurityConfig" }, { "target": "com.amazonaws.opensearchserverless#SecurityPolicy" }, { "target": "com.amazonaws.opensearchserverless#VpcEndpoint" } ], "traits": { "aws.api#service": { "sdkId": "OpenSearchServerless", "arnNamespace": "aoss" }, "aws.auth#sigv4": { "name": "aoss" }, "aws.protocols#awsJson1_0": {}, "smithy.api#cors": {}, "smithy.api#documentation": "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?
", "smithy.api#title": "OpenSearch Service Serverless", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://aoss-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://aoss-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://aoss.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://aoss.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://aoss-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://aoss-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://aoss.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://aoss.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://aoss-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://aoss.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://aoss-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://aoss.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://aoss-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://aoss.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://aoss.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.opensearchserverless#PolicyDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.opensearchserverless#PolicyDocument": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20480 }, "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" } }, "com.amazonaws.opensearchserverless#PolicyName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 32 }, "smithy.api#pattern": "^[a-z][a-z0-9-]+$" } }, "com.amazonaws.opensearchserverless#PolicyVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 36 }, "smithy.api#pattern": "^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$" } }, "com.amazonaws.opensearchserverless#Resource": { "type": "string" }, "com.amazonaws.opensearchserverless#ResourceFilter": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#Resource" } }, "com.amazonaws.opensearchserverless#ResourceName": { "type": "string", "traits": { "smithy.api#pattern": "^index/[a-z][a-z0-9-]{3,63}/([a-z;0-9&$%][+.~=\\-_a-z;0-9&$%]*)$" } }, "com.amazonaws.opensearchserverless#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "Thrown when accessing or deleting a resource that does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.opensearchserverless#ResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "index", "value": "index", "documentation": "index resource type" } ] } }, "com.amazonaws.opensearchserverless#RoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):iam::\\d{12}:role/.+$" } }, "com.amazonaws.opensearchserverless#S3BucketNameOrArn": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 2048 }, "smithy.api#pattern": "^(arn:[a-z0-9\\-]+:s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]|[a-z0-9][a-z0-9.-]{1,61}[a-z0-9])$" } }, "com.amazonaws.opensearchserverless#S3Statistics": { "type": "structure", "members": { "objectsDiscovered": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of Amazon S3 objects discovered for ingestion.
" } }, "objectsIngested": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of Amazon S3 objects successfully ingested.
" } }, "objectsFailed": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of Amazon S3 objects that failed to be ingested.
" } } }, "traits": { "smithy.api#documentation": "Processing statistics for the Amazon S3 objects in an ingestion source.
" } }, "com.amazonaws.opensearchserverless#SamlConfigOptions": { "type": "structure", "members": { "metadata": { "target": "com.amazonaws.opensearchserverless#samlMetadata", "traits": { "smithy.api#documentation": "The XML IdP metadata file generated from your identity provider.
", "smithy.api#required": {} } }, "userAttribute": { "target": "com.amazonaws.opensearchserverless#samlUserAttribute", "traits": { "smithy.api#documentation": "A user attribute for this SAML integration.
" } }, "groupAttribute": { "target": "com.amazonaws.opensearchserverless#samlGroupAttribute", "traits": { "smithy.api#documentation": "The group attribute for this SAML integration.
" } }, "openSearchServerlessEntityId": { "target": "com.amazonaws.opensearchserverless#openSearchServerlessEntityId", "traits": { "smithy.api#documentation": "Custom entity ID attribute to override the default entity ID for this SAML integration.
" } }, "sessionTimeout": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The session timeout, in minutes. Default is 60 minutes (12 hours).
", "smithy.api#range": { "min": 5, "max": 720 } } } }, "traits": { "smithy.api#documentation": "Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.
" } }, "com.amazonaws.opensearchserverless#SearchCapacityValue": { "type": "integer", "traits": { "smithy.api#range": { "min": 2 } } }, "com.amazonaws.opensearchserverless#SecurityConfig": { "type": "resource", "identifiers": { "id": { "target": "com.amazonaws.opensearchserverless#SecurityConfigId" } }, "create": { "target": "com.amazonaws.opensearchserverless#CreateSecurityConfig" }, "read": { "target": "com.amazonaws.opensearchserverless#GetSecurityConfig" }, "update": { "target": "com.amazonaws.opensearchserverless#UpdateSecurityConfig" }, "delete": { "target": "com.amazonaws.opensearchserverless#DeleteSecurityConfig" }, "list": { "target": "com.amazonaws.opensearchserverless#ListSecurityConfigs" }, "traits": { "aws.cloudformation#cfnResource": { "name": "SecurityConfig" } } }, "com.amazonaws.opensearchserverless#SecurityConfigDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#SecurityConfigId", "traits": { "smithy.api#documentation": "The unique identifier of the security configuration.
" } }, "type": { "target": "com.amazonaws.opensearchserverless#SecurityConfigType", "traits": { "smithy.api#documentation": "The type of security configuration.
" } }, "configVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the security configuration.
" } }, "description": { "target": "com.amazonaws.opensearchserverless#ConfigDescription", "traits": { "smithy.api#documentation": "The description of the security configuration.
" } }, "samlOptions": { "target": "com.amazonaws.opensearchserverless#SamlConfigOptions", "traits": { "smithy.api#documentation": "SAML options for the security configuration in the form of a key-value map.
" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterConfigOptions", "traits": { "smithy.api#documentation": "Describes IAM Identity Center options in the form of a key-value map.
" } }, "iamFederationOptions": { "target": "com.amazonaws.opensearchserverless#IamFederationConfigOptions", "traits": { "smithy.api#documentation": "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.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date the configuration was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp of when the configuration was last modified.
" } } }, "traits": { "smithy.api#documentation": "Details about a security configuration for OpenSearch Serverless.
" } }, "com.amazonaws.opensearchserverless#SecurityConfigId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.opensearchserverless#SecurityConfigStats": { "type": "structure", "members": { "SamlConfigCount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of security configurations in the current account.
" } } }, "traits": { "smithy.api#documentation": "Statistics for an OpenSearch Serverless security configuration.
" } }, "com.amazonaws.opensearchserverless#SecurityConfigSummaries": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#SecurityConfigSummary" } }, "com.amazonaws.opensearchserverless#SecurityConfigSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#SecurityConfigId", "traits": { "smithy.api#documentation": "The unique identifier of the security configuration.
" } }, "type": { "target": "com.amazonaws.opensearchserverless#SecurityConfigType", "traits": { "smithy.api#documentation": "The type of security configuration.
" } }, "configVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the security configuration.
" } }, "description": { "target": "com.amazonaws.opensearchserverless#ConfigDescription", "traits": { "smithy.api#documentation": "The description of the security configuration.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The Epoch time when the security configuration was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp of when the configuration was last modified.
" } } }, "traits": { "smithy.api#documentation": "A summary of a security configuration for OpenSearch Serverless.
" } }, "com.amazonaws.opensearchserverless#SecurityConfigType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "saml", "value": "saml", "documentation": "saml provider" }, { "name": "iamidentitycenter", "value": "iamidentitycenter", "documentation": "iam identity center" }, { "name": "iamfederation", "value": "iamfederation", "documentation": "iam federation" } ] } }, "com.amazonaws.opensearchserverless#SecurityGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+\\-]+$" } }, "com.amazonaws.opensearchserverless#SecurityGroupIds": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#SecurityGroupId" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.opensearchserverless#SecurityPolicy": { "type": "resource", "identifiers": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyType" }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName" } }, "read": { "target": "com.amazonaws.opensearchserverless#GetSecurityPolicy" }, "update": { "target": "com.amazonaws.opensearchserverless#UpdateSecurityPolicy" }, "delete": { "target": "com.amazonaws.opensearchserverless#DeleteSecurityPolicy" }, "list": { "target": "com.amazonaws.opensearchserverless#ListSecurityPolicies" }, "traits": { "aws.cloudformation#cfnResource": { "name": "SecurityPolicy" } } }, "com.amazonaws.opensearchserverless#SecurityPolicyDetail": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyType", "traits": { "smithy.api#documentation": "The type of security policy.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
" } }, "policyVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the policy.
" } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "The description of the security policy.
" } }, "policy": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The JSON policy document without any whitespaces.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date the policy was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp of when the policy was last modified.
" } } }, "traits": { "smithy.api#documentation": "Details about an OpenSearch Serverless security policy.
" } }, "com.amazonaws.opensearchserverless#SecurityPolicyStats": { "type": "structure", "members": { "EncryptionPolicyCount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of encryption policies in the current account.
" } }, "NetworkPolicyCount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of network policies in the current account.
" } } }, "traits": { "smithy.api#documentation": "Statistics for an OpenSearch Serverless security policy.
" } }, "com.amazonaws.opensearchserverless#SecurityPolicySummaries": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#SecurityPolicySummary" } }, "com.amazonaws.opensearchserverless#SecurityPolicySummary": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyType", "traits": { "smithy.api#documentation": "The type of security policy.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
" } }, "policyVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the policy.
" } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "The description of the security policy.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date the policy was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp of when the policy was last modified.
" } } }, "traits": { "smithy.api#documentation": "A summary of a security policy for OpenSearch Serverless.
" } }, "com.amazonaws.opensearchserverless#SecurityPolicyType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "encryption", "value": "encryption", "documentation": "encryption policy type" }, { "name": "network", "value": "network", "documentation": "network policy type" } ] } }, "com.amazonaws.opensearchserverless#ServerlessGeneration": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "CLASSIC", "value": "CLASSIC" }, { "name": "NEXTGEN", "value": "NEXTGEN" } ] } }, "com.amazonaws.opensearchserverless#ServerlessVectorAccelerationStatus": { "type": "string", "traits": { "smithy.api#documentation": "Specifies whether serverless vector acceleration is enabled for the collection.
", "smithy.api#enum": [ { "name": "ENABLED", "value": "ENABLED", "documentation": "Serverless vector acceleration is enabled by default" }, { "name": "DISABLED", "value": "DISABLED", "documentation": "Serverless vector acceleration is disabled" }, { "name": "ALLOWED", "value": "ALLOWED", "documentation": "Serverless vector acceleration is allowed but not enabled by default" } ] } }, "com.amazonaws.opensearchserverless#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Description of the error.", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Identifier of the resource affected." } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Type of the resource affected." } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Service Quotas requirement to identify originating service.", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Service Quotas requirement to identify originating quota." } } }, "traits": { "smithy.api#documentation": "Thrown when you attempt to create more resources than the service allows based on service quotas.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.opensearchserverless#SqsArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):sqs:[a-z0-9-]+:\\d{12}:.+$" } }, "com.amazonaws.opensearchserverless#StandbyReplicas": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ENABLED", "value": "ENABLED", "documentation": "Standby replicas enabled" }, { "name": "DISABLED", "value": "DISABLED", "documentation": "Standby replicas disabled" } ] } }, "com.amazonaws.opensearchserverless#StreamBucketConfig": { "type": "structure", "members": { "bucket": { "target": "com.amazonaws.opensearchserverless#S3BucketNameOrArn", "traits": { "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.
", "smithy.api#required": {} } }, "bucketOwnerAccountId": { "target": "com.amazonaws.opensearchserverless#BucketOwnerAccountId", "traits": { "smithy.api#documentation": "The AWS account ID that owns the S3 bucket. Optional. If omitted, the\ncontrol plane derives it from the account segment of sqsArn." } }, "initialScan": { "target": "com.amazonaws.opensearchserverless#InitialScan", "traits": { "smithy.api#documentation": "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 key to use in the tag.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.opensearchserverless#TagValue", "traits": { "smithy.api#documentation": "The value of the tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A map of key-value pairs associated to an OpenSearch Serverless resource.
" } }, "com.amazonaws.opensearchserverless#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.opensearchserverless#TagKeys": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.opensearchserverless#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#TagResourceRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
" } }, "com.amazonaws.opensearchserverless#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.opensearchserverless#Arn", "traits": { "smithy.api#documentation": "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.
A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.
", "smithy.api#required": {} } } } }, "com.amazonaws.opensearchserverless#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.opensearchserverless#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.opensearchserverless#Tags": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.opensearchserverless#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UntagResourceRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
" } }, "com.amazonaws.opensearchserverless#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.opensearchserverless#Arn", "traits": { "smithy.api#documentation": "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 tag or set of tags to remove from the resource. All tag keys in the request must be unique.
", "smithy.api#required": {} } } } }, "com.amazonaws.opensearchserverless#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.opensearchserverless#UpdateAccessPolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UpdateAccessPolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UpdateAccessPolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#UpdateAccessPolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#AccessPolicyType", "traits": { "smithy.api#documentation": "The type of policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "policyVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the policy being updated.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "A description of the policy. Typically used to store information about the permissions defined in the policy.
" } }, "policy": { "target": "com.amazonaws.opensearchserverless#PolicyDocument", "traits": { "smithy.api#documentation": "The JSON policy document to use as the content for the policy.
" } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#UpdateAccessPolicyResponse": { "type": "structure", "members": { "accessPolicyDetail": { "target": "com.amazonaws.opensearchserverless#AccessPolicyDetail", "traits": { "smithy.api#documentation": "Details about the updated access policy.
" } } } }, "com.amazonaws.opensearchserverless#UpdateAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UpdateAccountSettingsRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UpdateAccountSettingsResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
" } }, "com.amazonaws.opensearchserverless#UpdateAccountSettingsRequest": { "type": "structure", "members": { "capacityLimits": { "target": "com.amazonaws.opensearchserverless#CapacityLimits" } } }, "com.amazonaws.opensearchserverless#UpdateAccountSettingsResponse": { "type": "structure", "members": { "accountSettingsDetail": { "target": "com.amazonaws.opensearchserverless#AccountSettingsDetail", "traits": { "smithy.api#documentation": "OpenSearch Serverless-related settings for the current Amazon Web Services account.
" } } } }, "com.amazonaws.opensearchserverless#UpdateCollection": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UpdateCollectionRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UpdateCollectionResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an OpenSearch Serverless collection.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#UpdateCollectionDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionName", "traits": { "smithy.api#documentation": "The name of the collection.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#CollectionStatus", "traits": { "smithy.api#documentation": "The current status of the collection.
" } }, "type": { "target": "com.amazonaws.opensearchserverless#CollectionType", "traits": { "smithy.api#documentation": "The collection type.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the collection.
" } }, "vectorOptions": { "target": "com.amazonaws.opensearchserverless#VectorOptions", "traits": { "smithy.api#documentation": "Configuration options for vector search capabilities in the collection.
" } }, "kmsKeyArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key used to encrypt the collection.
" } }, "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collection.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date and time when the collection was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date and time when the collection was last modified.
" } }, "deletionProtection": { "target": "com.amazonaws.opensearchserverless#DeletionProtection", "traits": { "smithy.api#documentation": "Indicates whether deletion protection is ENABLED or DISABLED for the collection.
Details about an updated OpenSearch Serverless collection.
" } }, "com.amazonaws.opensearchserverless#UpdateCollectionGroup": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UpdateCollectionGroupRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UpdateCollectionGroupResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the description and capacity limits of a collection group.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#UpdateCollectionGroupDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionGroupId", "traits": { "smithy.api#documentation": "The unique identifier of the collection group.
" } }, "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collection group.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionGroupName", "traits": { "smithy.api#documentation": "The name of the collection group.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the collection group.
" } }, "capacityLimits": { "target": "com.amazonaws.opensearchserverless#CollectionGroupCapacityLimits", "traits": { "smithy.api#documentation": "The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The Epoch time when the collection group was created.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date and time when the collection group was last modified.
" } }, "generation": { "target": "com.amazonaws.opensearchserverless#ServerlessGeneration", "traits": { "smithy.api#documentation": "The generation of Amazon OpenSearch Serverless for the collection group.
" } } }, "traits": { "smithy.api#documentation": "Details about the updated collection group.
" } }, "com.amazonaws.opensearchserverless#UpdateCollectionGroupRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionGroupId", "traits": { "smithy.api#documentation": "The unique identifier of the collection group to update.
", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A new description for the collection group.
", "smithy.api#length": { "max": 1000 } } }, "capacityLimits": { "target": "com.amazonaws.opensearchserverless#CollectionGroupCapacityLimits", "traits": { "smithy.api#documentation": "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.
" } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#UpdateCollectionGroupResponse": { "type": "structure", "members": { "updateCollectionGroupDetail": { "target": "com.amazonaws.opensearchserverless#UpdateCollectionGroupDetail", "traits": { "smithy.api#documentation": "Details about the updated collection group.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#UpdateCollectionRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection.
", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the collection.
", "smithy.api#length": { "max": 1000 } } }, "vectorOptions": { "target": "com.amazonaws.opensearchserverless#VectorOptions", "traits": { "smithy.api#documentation": "Configuration options for vector search capabilities in the collection.
" } }, "deletionProtection": { "target": "com.amazonaws.opensearchserverless#DeletionProtection", "traits": { "smithy.api#documentation": "Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.
Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#UpdateCollectionResponse": { "type": "structure", "members": { "updateCollectionDetail": { "target": "com.amazonaws.opensearchserverless#UpdateCollectionDetail", "traits": { "smithy.api#documentation": "Details about the updated collection.
" } } } }, "com.amazonaws.opensearchserverless#UpdateIamIdentityCenterConfigOptions": { "type": "structure", "members": { "userAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", "traits": { "smithy.api#documentation": "The user attribute for this IAM Identity Center integration. Defaults to UserId.
The group attribute for this IAM Identity Center integration. Defaults to GroupId.
Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.
" } }, "com.amazonaws.opensearchserverless#UpdateIndex": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UpdateIndexRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UpdateIndexResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#UpdateIndexRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { "smithy.api#documentation": "The unique identifier of the collection containing the index to update.
", "smithy.api#required": {} } }, "indexName": { "target": "com.amazonaws.opensearchserverless#IndexName", "traits": { "smithy.api#documentation": "The name of the index to update.
", "smithy.api#required": {} } }, "indexSchema": { "target": "com.amazonaws.opensearchserverless#IndexSchema", "traits": { "smithy.api#documentation": "The updated JSON schema definition for the index, including field mappings and settings.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#UpdateIndexResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#UpdateLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UpdateLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UpdateLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#UpdateLifecyclePolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { "smithy.api#documentation": "The type of lifecycle policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "policyVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the policy being updated.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "A description of the lifecycle policy.
" } }, "policy": { "target": "com.amazonaws.opensearchserverless#PolicyDocument", "traits": { "smithy.api#documentation": "The JSON policy document to use as the content for the lifecycle policy.
" } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchserverless#UpdateLifecyclePolicyResponse": { "type": "structure", "members": { "lifecyclePolicyDetail": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyDetail", "traits": { "smithy.api#documentation": "Details about the updated lifecycle policy.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#UpdateSecurityConfig": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UpdateSecurityConfigRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UpdateSecurityConfigResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#UpdateSecurityConfigRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#SecurityConfigId", "traits": { "smithy.api#documentation": "The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.
A description of the security configuration.
" } }, "samlOptions": { "target": "com.amazonaws.opensearchserverless#SamlConfigOptions", "traits": { "smithy.api#documentation": "SAML options in in the form of a key-value map.
" } }, "iamIdentityCenterOptionsUpdates": { "target": "com.amazonaws.opensearchserverless#UpdateIamIdentityCenterConfigOptions", "traits": { "smithy.api#documentation": "Describes IAM Identity Center options in the form of a key-value map.
" } }, "iamFederationOptions": { "target": "com.amazonaws.opensearchserverless#IamFederationConfigOptions", "traits": { "smithy.api#documentation": "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.
" } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#UpdateSecurityConfigResponse": { "type": "structure", "members": { "securityConfigDetail": { "target": "com.amazonaws.opensearchserverless#SecurityConfigDetail", "traits": { "smithy.api#documentation": "Details about the updated security configuration.
" } } } }, "com.amazonaws.opensearchserverless#UpdateSecurityPolicy": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UpdateSecurityPolicyRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UpdateSecurityPolicyResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#UpdateSecurityPolicyRequest": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyType", "traits": { "smithy.api#documentation": "The type of access policy.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchserverless#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "policyVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { "smithy.api#documentation": "The version of the policy being updated.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { "smithy.api#documentation": "A description of the policy. Typically used to store information about the permissions defined in the policy.
" } }, "policy": { "target": "com.amazonaws.opensearchserverless#PolicyDocument", "traits": { "smithy.api#documentation": "The JSON policy document to use as the content for the new policy.
" } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#UpdateSecurityPolicyResponse": { "type": "structure", "members": { "securityPolicyDetail": { "target": "com.amazonaws.opensearchserverless#SecurityPolicyDetail", "traits": { "smithy.api#documentation": "Details about the updated security policy.
" } } } }, "com.amazonaws.opensearchserverless#UpdateVpcEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.opensearchserverless#UpdateVpcEndpointRequest" }, "output": { "target": "com.amazonaws.opensearchserverless#UpdateVpcEndpointResponse" }, "errors": [ { "target": "com.amazonaws.opensearchserverless#ConflictException" }, { "target": "com.amazonaws.opensearchserverless#InternalServerException" }, { "target": "com.amazonaws.opensearchserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchserverless#UpdateVpcEndpointDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#VpcEndpointId", "traits": { "smithy.api#documentation": "The unique identifier of the endpoint.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#VpcEndpointName", "traits": { "smithy.api#documentation": "The name of the endpoint.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#VpcEndpointStatus", "traits": { "smithy.api#documentation": "The current status of the endpoint update process.
" } }, "subnetIds": { "target": "com.amazonaws.opensearchserverless#SubnetIds", "traits": { "smithy.api#documentation": "The ID of the subnets from which you access OpenSearch Serverless.
" } }, "securityGroupIds": { "target": "com.amazonaws.opensearchserverless#SecurityGroupIds", "traits": { "smithy.api#documentation": "The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" } }, "lastModifiedDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp of when the endpoint was last modified.
" } } }, "traits": { "smithy.api#documentation": "Update details for an OpenSearch Serverless-managed interface endpoint.
" } }, "com.amazonaws.opensearchserverless#UpdateVpcEndpointRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#VpcEndpointId", "traits": { "smithy.api#documentation": "The unique identifier of the interface endpoint to update.
", "smithy.api#required": {} } }, "addSubnetIds": { "target": "com.amazonaws.opensearchserverless#SubnetIds", "traits": { "smithy.api#documentation": "The ID of one or more subnets to add to the endpoint.
" } }, "removeSubnetIds": { "target": "com.amazonaws.opensearchserverless#SubnetIds", "traits": { "smithy.api#documentation": "The unique identifiers of the subnets to remove from the endpoint.
" } }, "addSecurityGroupIds": { "target": "com.amazonaws.opensearchserverless#SecurityGroupIds", "traits": { "smithy.api#documentation": "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.
" } }, "removeSecurityGroupIds": { "target": "com.amazonaws.opensearchserverless#SecurityGroupIds", "traits": { "smithy.api#documentation": "The unique identifiers of the security groups to remove from the endpoint.
" } }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "Unique, case-sensitive identifier to ensure idempotency of the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.opensearchserverless#UpdateVpcEndpointResponse": { "type": "structure", "members": { "UpdateVpcEndpointDetail": { "target": "com.amazonaws.opensearchserverless#UpdateVpcEndpointDetail", "traits": { "smithy.api#documentation": "Details about the updated VPC endpoint.
" } } } }, "com.amazonaws.opensearchserverless#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "Thrown when the HTTP request contains invalid input or is missing required input.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.opensearchserverless#VectorOptions": { "type": "structure", "members": { "ServerlessVectorAcceleration": { "target": "com.amazonaws.opensearchserverless#ServerlessVectorAccelerationStatus", "traits": { "smithy.api#documentation": "Specifies whether serverless vector acceleration is enabled for the collection.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration options for vector search capabilities in an OpenSearch Serverless collection.
" } }, "com.amazonaws.opensearchserverless#VpcEndpoint": { "type": "resource", "identifiers": { "id": { "target": "com.amazonaws.opensearchserverless#VpcEndpointId" } }, "create": { "target": "com.amazonaws.opensearchserverless#CreateVpcEndpoint" }, "delete": { "target": "com.amazonaws.opensearchserverless#DeleteVpcEndpoint" }, "list": { "target": "com.amazonaws.opensearchserverless#ListVpcEndpoints" }, "traits": { "aws.cloudformation#cfnResource": { "name": "VpcEndpoint" } } }, "com.amazonaws.opensearchserverless#VpcEndpointDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#VpcEndpointId", "traits": { "smithy.api#documentation": "The unique identifier of the endpoint.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#VpcEndpointName", "traits": { "smithy.api#documentation": "The name of the endpoint.
" } }, "vpcId": { "target": "com.amazonaws.opensearchserverless#VpcId", "traits": { "smithy.api#documentation": "The ID of the VPC from which you access OpenSearch Serverless.
" } }, "subnetIds": { "target": "com.amazonaws.opensearchserverless#SubnetIds", "traits": { "smithy.api#documentation": "The ID of the subnets from which you access OpenSearch Serverless.
" } }, "securityGroupIds": { "target": "com.amazonaws.opensearchserverless#SecurityGroupIds", "traits": { "smithy.api#documentation": "The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#VpcEndpointStatus", "traits": { "smithy.api#documentation": "The current status of the endpoint.
" } }, "createdDate": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The date the endpoint was created.
" } }, "failureCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A failure code associated with the request.
" } }, "failureMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message associated with the failure code.
" } } }, "traits": { "smithy.api#documentation": "Details about an OpenSearch Serverless-managed interface endpoint.
" } }, "com.amazonaws.opensearchserverless#VpcEndpointDetails": { "type": "list", "member": { "target": "com.amazonaws.opensearchserverless#VpcEndpointDetail" } }, "com.amazonaws.opensearchserverless#VpcEndpointErrorDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearchserverless#VpcEndpointId", "traits": { "smithy.api#documentation": "The unique identifier of the VPC endpoint.
" } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An error message describing the reason for the failure.
" } }, "errorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The error code for the failed request.
" } } }, "traits": { "smithy.api#documentation": "Error information for a failed BatchGetVpcEndpoint request.
The current status of the endpoint.
" } } }, "traits": { "smithy.api#documentation": "Filter the results of a ListVpcEndpoints request.
The unique identifier of the endpoint.
" } }, "name": { "target": "com.amazonaws.opensearchserverless#VpcEndpointName", "traits": { "smithy.api#documentation": "The name of the endpoint.
" } }, "status": { "target": "com.amazonaws.opensearchserverless#VpcEndpointStatus", "traits": { "smithy.api#documentation": "The current status of the endpoint.
" } } }, "traits": { "smithy.api#documentation": "The VPC endpoint object.
" } }, "com.amazonaws.opensearchserverless#VpcId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^vpc-[0-9a-z]*$" } }, "com.amazonaws.opensearchserverless#iamFederationGroupAttribute": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_.:/=+\\-@]*$" } }, "com.amazonaws.opensearchserverless#iamFederationUserAttribute": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_.:/=+\\-@]*$" } }, "com.amazonaws.opensearchserverless#openSearchServerlessEntityId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^aws:opensearch:[0-9]{12}:*" } }, "com.amazonaws.opensearchserverless#samlGroupAttribute": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "[\\w+=,.@-]+" } }, "com.amazonaws.opensearchserverless#samlMetadata": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 51200 }, "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" } }, "com.amazonaws.opensearchserverless#samlUserAttribute": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "[\\w+=,.@-]+" } } } }