{ "version":"2.0", "metadata":{ "apiVersion":"2021-11-01", "endpointPrefix":"aoss", "jsonVersion":"1.0", "protocol":"json", "serviceFullName":"OpenSearch Service Serverless", "serviceId":"OpenSearchServerless", "signatureVersion":"v4", "signingName":"aoss", "targetPrefix":"OpenSearchServerless", "uid":"opensearchserverless-2021-11-01" }, "operations":{ "BatchGetCollection":{ "name":"BatchGetCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetCollectionRequest"}, "output":{"shape":"BatchGetCollectionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

" }, "BatchGetEffectiveLifecyclePolicy":{ "name":"BatchGetEffectiveLifecyclePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetEffectiveLifecyclePolicyRequest"}, "output":{"shape":"BatchGetEffectiveLifecyclePolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.

" }, "BatchGetLifecyclePolicy":{ "name":"BatchGetLifecyclePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetLifecyclePolicyRequest"}, "output":{"shape":"BatchGetLifecyclePolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

" }, "BatchGetVpcEndpoint":{ "name":"BatchGetVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetVpcEndpointRequest"}, "output":{"shape":"BatchGetVpcEndpointResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "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.

" }, "CreateAccessPolicy":{ "name":"CreateAccessPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAccessPolicyRequest"}, "output":{"shape":"CreateAccessPolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "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.

", "idempotent":true }, "CreateCollection":{ "name":"CreateCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCollectionRequest"}, "output":{"shape":"CreateCollectionResponse"}, "errors":[ {"shape":"OcuLimitExceededException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

", "idempotent":true }, "CreateLifecyclePolicy":{ "name":"CreateLifecyclePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLifecyclePolicyRequest"}, "output":{"shape":"CreateLifecyclePolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "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.

", "idempotent":true }, "CreateSecurityConfig":{ "name":"CreateSecurityConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityConfigRequest"}, "output":{"shape":"CreateSecurityConfigResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

", "idempotent":true }, "CreateSecurityPolicy":{ "name":"CreateSecurityPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityPolicyRequest"}, "output":{"shape":"CreateSecurityPolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "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.

", "idempotent":true }, "CreateVpcEndpoint":{ "name":"CreateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcEndpointRequest"}, "output":{"shape":"CreateVpcEndpointResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

", "idempotent":true }, "DeleteAccessPolicy":{ "name":"DeleteAccessPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAccessPolicyRequest"}, "output":{"shape":"DeleteAccessPolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

", "idempotent":true }, "DeleteCollection":{ "name":"DeleteCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCollectionRequest"}, "output":{"shape":"DeleteCollectionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

", "idempotent":true }, "DeleteLifecyclePolicy":{ "name":"DeleteLifecyclePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLifecyclePolicyRequest"}, "output":{"shape":"DeleteLifecyclePolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.

", "idempotent":true }, "DeleteSecurityConfig":{ "name":"DeleteSecurityConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityConfigRequest"}, "output":{"shape":"DeleteSecurityConfigResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

", "idempotent":true }, "DeleteSecurityPolicy":{ "name":"DeleteSecurityPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityPolicyRequest"}, "output":{"shape":"DeleteSecurityPolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Deletes an OpenSearch Serverless security policy.

", "idempotent":true }, "DeleteVpcEndpoint":{ "name":"DeleteVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcEndpointRequest"}, "output":{"shape":"DeleteVpcEndpointResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

", "idempotent":true }, "GetAccessPolicy":{ "name":"GetAccessPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAccessPolicyRequest"}, "output":{"shape":"GetAccessPolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

" }, "GetAccountSettings":{ "name":"GetAccountSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAccountSettingsRequest"}, "output":{"shape":"GetAccountSettingsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns account-level settings related to OpenSearch Serverless.

" }, "GetPoliciesStats":{ "name":"GetPoliciesStats", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPoliciesStatsRequest"}, "output":{"shape":"GetPoliciesStatsResponse"}, "errors":[ {"shape":"InternalServerException"} ], "documentation":"

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

" }, "GetSecurityConfig":{ "name":"GetSecurityConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSecurityConfigRequest"}, "output":{"shape":"GetSecurityConfigResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

" }, "GetSecurityPolicy":{ "name":"GetSecurityPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSecurityPolicyRequest"}, "output":{"shape":"GetSecurityPolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "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.

" }, "ListAccessPolicies":{ "name":"ListAccessPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAccessPoliciesRequest"}, "output":{"shape":"ListAccessPoliciesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns information about a list of OpenSearch Serverless access policies.

" }, "ListCollections":{ "name":"ListCollections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCollectionsRequest"}, "output":{"shape":"ListCollectionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

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.

" }, "ListLifecyclePolicies":{ "name":"ListLifecyclePolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListLifecyclePoliciesRequest"}, "output":{"shape":"ListLifecyclePoliciesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

" }, "ListSecurityConfigs":{ "name":"ListSecurityConfigs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSecurityConfigsRequest"}, "output":{"shape":"ListSecurityConfigsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.

" }, "ListSecurityPolicies":{ "name":"ListSecurityPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSecurityPoliciesRequest"}, "output":{"shape":"ListSecurityPoliciesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns information about configured OpenSearch Serverless security policies.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

" }, "ListVpcEndpoints":{ "name":"ListVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListVpcEndpointsRequest"}, "output":{"shape":"ListVpcEndpointsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "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.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

" }, "UpdateAccessPolicy":{ "name":"UpdateAccessPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAccessPolicyRequest"}, "output":{"shape":"UpdateAccessPolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

", "idempotent":true }, "UpdateAccountSettings":{ "name":"UpdateAccountSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAccountSettingsRequest"}, "output":{"shape":"UpdateAccountSettingsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

" }, "UpdateCollection":{ "name":"UpdateCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateCollectionRequest"}, "output":{"shape":"UpdateCollectionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Updates an OpenSearch Serverless collection.

", "idempotent":true }, "UpdateLifecyclePolicy":{ "name":"UpdateLifecyclePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateLifecyclePolicyRequest"}, "output":{"shape":"UpdateLifecyclePolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.

", "idempotent":true }, "UpdateSecurityConfig":{ "name":"UpdateSecurityConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSecurityConfigRequest"}, "output":{"shape":"UpdateSecurityConfigResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

", "idempotent":true }, "UpdateSecurityPolicy":{ "name":"UpdateSecurityPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSecurityPolicyRequest"}, "output":{"shape":"UpdateSecurityPolicyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "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.

", "idempotent":true }, "UpdateVpcEndpoint":{ "name":"UpdateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateVpcEndpointRequest"}, "output":{"shape":"UpdateVpcEndpointResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"} ], "documentation":"

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

", "idempotent":true } }, "shapes":{ "AccessPolicyDetail":{ "type":"structure", "members":{ "createdDate":{ "shape":"Long", "documentation":"

The date the policy was created.

" }, "description":{ "shape":"PolicyDescription", "documentation":"

The description of the policy.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The timestamp of when the policy was last modified.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" }, "policy":{ "shape":"Document", "documentation":"

The JSON policy document without any whitespaces.

" }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the policy.

" }, "type":{ "shape":"AccessPolicyType", "documentation":"

The type of access policy.

" } }, "documentation":"

Details about an OpenSearch Serverless access policy.

" }, "AccessPolicyStats":{ "type":"structure", "members":{ "DataPolicyCount":{ "shape":"Long", "documentation":"

The number of data access policies in the current account.

" } }, "documentation":"

Statistics for an OpenSearch Serverless access policy.

" }, "AccessPolicySummaries":{ "type":"list", "member":{"shape":"AccessPolicySummary"} }, "AccessPolicySummary":{ "type":"structure", "members":{ "createdDate":{ "shape":"Long", "documentation":"

The Epoch time when the access policy was created.

" }, "description":{ "shape":"PolicyDescription", "documentation":"

The description of the access policy.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The date and time when the collection was last modified.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the access policy.

" }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the policy.

" }, "type":{ "shape":"AccessPolicyType", "documentation":"

The type of access policy. Currently, the only available type is `data`.

" } }, "documentation":"

A summary of the data access policy.

" }, "AccessPolicyType":{ "type":"string", "enum":["data"] }, "AccountSettingsDetail":{ "type":"structure", "members":{ "capacityLimits":{"shape":"CapacityLimits"} }, "documentation":"

OpenSearch Serverless-related information for the current account.

" }, "Arn":{ "type":"string", "max":1011, "min":1 }, "BatchGetCollectionRequest":{ "type":"structure", "members":{ "ids":{ "shape":"CollectionIds", "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":{ "shape":"CollectionNames", "documentation":"

A list of collection names. You can't provide names and IDs in the same request.

" } } }, "BatchGetCollectionResponse":{ "type":"structure", "members":{ "collectionDetails":{ "shape":"CollectionDetails", "documentation":"

Details about each collection.

" }, "collectionErrorDetails":{ "shape":"CollectionErrorDetails", "documentation":"

Error information for the request.

" } } }, "BatchGetEffectiveLifecyclePolicyRequest":{ "type":"structure", "required":["resourceIdentifiers"], "members":{ "resourceIdentifiers":{ "shape":"LifecyclePolicyResourceIdentifiers", "documentation":"

The unique identifiers of policy types and resource names.

" } } }, "BatchGetEffectiveLifecyclePolicyResponse":{ "type":"structure", "members":{ "effectiveLifecyclePolicyDetails":{ "shape":"EffectiveLifecyclePolicyDetails", "documentation":"

A list of lifecycle policies applied to the OpenSearch Serverless indexes.

" }, "effectiveLifecyclePolicyErrorDetails":{ "shape":"EffectiveLifecyclePolicyErrorDetails", "documentation":"

A list of resources for which retrieval failed.

" } } }, "BatchGetLifecyclePolicyRequest":{ "type":"structure", "required":["identifiers"], "members":{ "identifiers":{ "shape":"LifecyclePolicyIdentifiers", "documentation":"

The unique identifiers of policy types and policy names.

" } } }, "BatchGetLifecyclePolicyResponse":{ "type":"structure", "members":{ "lifecyclePolicyDetails":{ "shape":"LifecyclePolicyDetails", "documentation":"

A list of lifecycle policies matched to the input policy name and policy type.

" }, "lifecyclePolicyErrorDetails":{ "shape":"LifecyclePolicyErrorDetails", "documentation":"

A list of lifecycle policy names and policy types for which retrieval failed.

" } } }, "BatchGetVpcEndpointRequest":{ "type":"structure", "required":["ids"], "members":{ "ids":{ "shape":"VpcEndpointIds", "documentation":"

A list of VPC endpoint identifiers.

" } } }, "BatchGetVpcEndpointResponse":{ "type":"structure", "members":{ "vpcEndpointDetails":{ "shape":"VpcEndpointDetails", "documentation":"

Details about the specified VPC endpoint.

" }, "vpcEndpointErrorDetails":{ "shape":"VpcEndpointErrorDetails", "documentation":"

Error information for a failed request.

" } } }, "Boolean":{ "type":"boolean", "box":true }, "CapacityLimits":{ "type":"structure", "members":{ "maxIndexingCapacityInOCU":{ "shape":"IndexingCapacityValue", "documentation":"

The maximum indexing capacity for collections.

" }, "maxSearchCapacityInOCU":{ "shape":"SearchCapacityValue", "documentation":"

The maximum search capacity for collections.

" } }, "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.

" }, "ClientToken":{ "type":"string", "max":512, "min":1 }, "CollectionDetail":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the collection.

" }, "collectionEndpoint":{ "shape":"String", "documentation":"

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

" }, "createdDate":{ "shape":"Long", "documentation":"

The Epoch time when the collection was created.

" }, "dashboardEndpoint":{ "shape":"String", "documentation":"

Collection-specific endpoint used to access OpenSearch Dashboards.

" }, "description":{ "shape":"String", "documentation":"

A description of the collection.

" }, "id":{ "shape":"CollectionId", "documentation":"

A unique identifier for the collection.

" }, "kmsKeyArn":{ "shape":"String", "documentation":"

The ARN of the Amazon Web Services KMS key used to encrypt the collection.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The date and time when the collection was last modified.

" }, "name":{ "shape":"CollectionName", "documentation":"

The name of the collection.

" }, "standbyReplicas":{ "shape":"StandbyReplicas", "documentation":"

Details about an OpenSearch Serverless collection.

" }, "status":{ "shape":"CollectionStatus", "documentation":"

The current status of the collection.

" }, "type":{ "shape":"CollectionType", "documentation":"

The type of collection.

" } }, "documentation":"

Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.

" }, "CollectionDetails":{ "type":"list", "member":{"shape":"CollectionDetail"} }, "CollectionErrorDetail":{ "type":"structure", "members":{ "errorCode":{ "shape":"String", "documentation":"

The error code for the request. For example, `NOT_FOUND`.

" }, "errorMessage":{ "shape":"String", "documentation":"

A description of the error. For example, `The specified Collection is not found.`

" }, "id":{ "shape":"CollectionId", "documentation":"

If the request contains collection IDs, the response includes the IDs provided in the request.

" }, "name":{ "shape":"CollectionName", "documentation":"

If the request contains collection names, the response includes the names provided in the request.

" } }, "documentation":"

Error information for an OpenSearch Serverless request.

" }, "CollectionErrorDetails":{ "type":"list", "member":{"shape":"CollectionErrorDetail"} }, "CollectionFilters":{ "type":"structure", "members":{ "name":{ "shape":"CollectionName", "documentation":"

The name of the collection.

" }, "status":{ "shape":"CollectionStatus", "documentation":"

The current status of the collection.

" } }, "documentation":"

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

" }, "CollectionId":{ "type":"string", "max":40, "min":3, "pattern":"^[a-z0-9]{3,40}$" }, "CollectionIds":{ "type":"list", "member":{"shape":"CollectionId"}, "max":100, "min":1 }, "CollectionName":{ "type":"string", "max":32, "min":3, "pattern":"^[a-z][a-z0-9-]+$" }, "CollectionNames":{ "type":"list", "member":{"shape":"CollectionName"}, "max":100, "min":1 }, "CollectionStatus":{ "type":"string", "enum":[ "CREATING", "DELETING", "ACTIVE", "FAILED" ] }, "CollectionSummaries":{ "type":"list", "member":{"shape":"CollectionSummary"} }, "CollectionSummary":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the collection.

" }, "id":{ "shape":"CollectionId", "documentation":"

The unique identifier of the collection.

" }, "name":{ "shape":"CollectionName", "documentation":"

The name of the collection.

" }, "status":{ "shape":"CollectionStatus", "documentation":"

The current status of the collection.

" } }, "documentation":"

Details about each OpenSearch Serverless collection.

" }, "CollectionType":{ "type":"string", "enum":[ "SEARCH", "TIMESERIES", "VECTORSEARCH" ] }, "ConfigDescription":{ "type":"string", "max":1000, "min":1 }, "ConfigName":{ "type":"string", "max":32, "min":3, "pattern":"^[a-z][a-z0-9-]+$" }, "ConflictException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "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 or FAILED state.

", "exception":true }, "CreateAccessPolicyRequest":{ "type":"structure", "required":[ "name", "policy", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "description":{ "shape":"PolicyDescription", "documentation":"

A description of the policy. Typically used to store information about the permissions defined in the policy.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" }, "policy":{ "shape":"PolicyDocument", "documentation":"

The JSON policy document to use as the content for the policy.

" }, "type":{ "shape":"AccessPolicyType", "documentation":"

The type of policy.

" } } }, "CreateAccessPolicyResponse":{ "type":"structure", "members":{ "accessPolicyDetail":{ "shape":"AccessPolicyDetail", "documentation":"

Details about the created access policy.

" } } }, "CreateCollectionDetail":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the collection.

" }, "createdDate":{ "shape":"Long", "documentation":"

The Epoch time when the collection was created.

" }, "description":{ "shape":"String", "documentation":"

A description of the collection.

" }, "id":{ "shape":"CollectionId", "documentation":"

The unique identifier of the collection.

" }, "kmsKeyArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The date and time when the collection was last modified.

" }, "name":{ "shape":"CollectionName", "documentation":"

The name of the collection.

" }, "standbyReplicas":{ "shape":"StandbyReplicas", "documentation":"

Creates details about an OpenSearch Serverless collection.

" }, "status":{ "shape":"CollectionStatus", "documentation":"

The current status of the collection.

" }, "type":{ "shape":"CollectionType", "documentation":"

The type of collection.

" } }, "documentation":"

Details about the created OpenSearch Serverless collection.

" }, "CreateCollectionRequest":{ "type":"structure", "required":["name"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "description":{ "shape":"CreateCollectionRequestDescriptionString", "documentation":"

Description of the collection.

" }, "name":{ "shape":"CollectionName", "documentation":"

Name of the collection.

" }, "standbyReplicas":{ "shape":"StandbyReplicas", "documentation":"

Indicates whether standby replicas should be used for a collection.

" }, "tags":{ "shape":"Tags", "documentation":"

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

" }, "type":{ "shape":"CollectionType", "documentation":"

The type of collection.

" } } }, "CreateCollectionRequestDescriptionString":{ "type":"string", "max":1000, "min":0 }, "CreateCollectionResponse":{ "type":"structure", "members":{ "createCollectionDetail":{ "shape":"CreateCollectionDetail", "documentation":"

Details about the collection.

" } } }, "CreateLifecyclePolicyRequest":{ "type":"structure", "required":[ "name", "policy", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "description":{ "shape":"PolicyDescription", "documentation":"

A description of the lifecycle policy.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the lifecycle policy.

" }, "policy":{ "shape":"PolicyDocument", "documentation":"

The JSON policy document to use as the content for the lifecycle policy.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } } }, "CreateLifecyclePolicyResponse":{ "type":"structure", "members":{ "lifecyclePolicyDetail":{ "shape":"LifecyclePolicyDetail", "documentation":"

Details about the created lifecycle policy.

" } } }, "CreateSecurityConfigRequest":{ "type":"structure", "required":[ "name", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "description":{ "shape":"ConfigDescription", "documentation":"

A description of the security configuration.

" }, "name":{ "shape":"ConfigName", "documentation":"

The name of the security configuration.

" }, "samlOptions":{ "shape":"SamlConfigOptions", "documentation":"

Describes SAML options in in the form of a key-value map. This field is required if you specify `saml` for the `type` parameter.

" }, "type":{ "shape":"SecurityConfigType", "documentation":"

The type of security configuration.

" } } }, "CreateSecurityConfigResponse":{ "type":"structure", "members":{ "securityConfigDetail":{ "shape":"SecurityConfigDetail", "documentation":"

Details about the created security configuration.

" } } }, "CreateSecurityPolicyRequest":{ "type":"structure", "required":[ "name", "policy", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "description":{ "shape":"PolicyDescription", "documentation":"

A description of the policy. Typically used to store information about the permissions defined in the policy.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" }, "policy":{ "shape":"PolicyDocument", "documentation":"

The JSON policy document to use as the content for the new policy.

" }, "type":{ "shape":"SecurityPolicyType", "documentation":"

The type of security policy.

" } } }, "CreateSecurityPolicyResponse":{ "type":"structure", "members":{ "securityPolicyDetail":{ "shape":"SecurityPolicyDetail", "documentation":"

Details about the created security policy.

" } } }, "CreateVpcEndpointDetail":{ "type":"structure", "members":{ "id":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

" }, "name":{ "shape":"VpcEndpointName", "documentation":"

The name of the endpoint.

" }, "status":{ "shape":"VpcEndpointStatus", "documentation":"

The current status in the endpoint creation process.

" } }, "documentation":"

Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

" }, "CreateVpcEndpointRequest":{ "type":"structure", "required":[ "name", "subnetIds", "vpcId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "name":{ "shape":"VpcEndpointName", "documentation":"

The name of the interface endpoint.

" }, "securityGroupIds":{ "shape":"SecurityGroupIds", "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.

" }, "subnetIds":{ "shape":"SubnetIds", "documentation":"

The ID of one or more subnets from which you'll access OpenSearch Serverless.

" }, "vpcId":{ "shape":"VpcId", "documentation":"

The ID of the VPC from which you'll access OpenSearch Serverless.

" } } }, "CreateVpcEndpointResponse":{ "type":"structure", "members":{ "createVpcEndpointDetail":{ "shape":"CreateVpcEndpointDetail", "documentation":"

Details about the created interface VPC endpoint.

" } } }, "DeleteAccessPolicyRequest":{ "type":"structure", "required":[ "name", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy to delete.

" }, "type":{ "shape":"AccessPolicyType", "documentation":"

The type of policy.

" } } }, "DeleteAccessPolicyResponse":{ "type":"structure", "members":{ } }, "DeleteCollectionDetail":{ "type":"structure", "members":{ "id":{ "shape":"CollectionId", "documentation":"

The unique identifier of the collection.

" }, "name":{ "shape":"CollectionName", "documentation":"

The name of the collection.

" }, "status":{ "shape":"CollectionStatus", "documentation":"

The current status of the collection.

" } }, "documentation":"

Details about a deleted OpenSearch Serverless collection.

" }, "DeleteCollectionRequest":{ "type":"structure", "required":["id"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "id":{ "shape":"CollectionId", "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.

" } } }, "DeleteCollectionResponse":{ "type":"structure", "members":{ "deleteCollectionDetail":{ "shape":"DeleteCollectionDetail", "documentation":"

Details of the deleted collection.

" } } }, "DeleteLifecyclePolicyRequest":{ "type":"structure", "required":[ "name", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy to delete.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } } }, "DeleteLifecyclePolicyResponse":{ "type":"structure", "members":{ } }, "DeleteSecurityConfigRequest":{ "type":"structure", "required":["id"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "id":{ "shape":"SecurityConfigId", "documentation":"

The security configuration identifier. For SAML the ID will be `saml/<accountId>/<idpProviderName>`. For example, `saml/123456789123/OKTADev`.

" } } }, "DeleteSecurityConfigResponse":{ "type":"structure", "members":{ } }, "DeleteSecurityPolicyRequest":{ "type":"structure", "required":[ "name", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy to delete.

" }, "type":{ "shape":"SecurityPolicyType", "documentation":"

The type of policy.

" } } }, "DeleteSecurityPolicyResponse":{ "type":"structure", "members":{ } }, "DeleteVpcEndpointDetail":{ "type":"structure", "members":{ "id":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

" }, "name":{ "shape":"VpcEndpointName", "documentation":"

The name of the endpoint.

" }, "status":{ "shape":"VpcEndpointStatus", "documentation":"

The current status of the endpoint deletion process.

" } }, "documentation":"

Deletion details for an OpenSearch Serverless-managed interface endpoint.

" }, "DeleteVpcEndpointRequest":{ "type":"structure", "required":["id"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "id":{ "shape":"VpcEndpointId", "documentation":"

The VPC endpoint identifier.

" } } }, "DeleteVpcEndpointResponse":{ "type":"structure", "members":{ "deleteVpcEndpointDetail":{ "shape":"DeleteVpcEndpointDetail", "documentation":"

Details about the deleted endpoint.

" } } }, "Document":{ "type":"structure", "members":{ }, "document":true }, "EffectiveLifecyclePolicyDetail":{ "type":"structure", "members":{ "noMinRetentionPeriod":{ "shape":"Boolean", "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.

" }, "policyName":{ "shape":"PolicyName", "documentation":"

The name of the lifecycle policy.

" }, "resource":{ "shape":"Resource", "documentation":"

The name of the OpenSearch Serverless index resource.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The type of OpenSearch Serverless resource. Currently, the only supported resource is `index`.

" }, "retentionPeriod":{ "shape":"String", "documentation":"

The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } }, "documentation":"

Error information for an OpenSearch Serverless request.

" }, "EffectiveLifecyclePolicyDetails":{ "type":"list", "member":{"shape":"EffectiveLifecyclePolicyDetail"} }, "EffectiveLifecyclePolicyErrorDetail":{ "type":"structure", "members":{ "errorCode":{ "shape":"String", "documentation":"

The error code for the request.

" }, "errorMessage":{ "shape":"String", "documentation":"

A description of the error. For example, `The specified Index resource is not found`.

" }, "resource":{ "shape":"Resource", "documentation":"

The name of OpenSearch Serverless index resource.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } }, "documentation":"

Error information for an OpenSearch Serverless request.

" }, "EffectiveLifecyclePolicyErrorDetails":{ "type":"list", "member":{"shape":"EffectiveLifecyclePolicyErrorDetail"} }, "GetAccessPolicyRequest":{ "type":"structure", "required":[ "name", "type" ], "members":{ "name":{ "shape":"PolicyName", "documentation":"

The name of the access policy.

" }, "type":{ "shape":"AccessPolicyType", "documentation":"

Tye type of policy. Currently, the only supported value is `data`.

" } } }, "GetAccessPolicyResponse":{ "type":"structure", "members":{ "accessPolicyDetail":{ "shape":"AccessPolicyDetail", "documentation":"

Details about the requested access policy.

" } } }, "GetAccountSettingsRequest":{ "type":"structure", "members":{ } }, "GetAccountSettingsResponse":{ "type":"structure", "members":{ "accountSettingsDetail":{ "shape":"AccountSettingsDetail", "documentation":"

OpenSearch Serverless-related details for the current account.

" } } }, "GetPoliciesStatsRequest":{ "type":"structure", "members":{ } }, "GetPoliciesStatsResponse":{ "type":"structure", "members":{ "AccessPolicyStats":{ "shape":"AccessPolicyStats", "documentation":"

Information about the data access policies in your account.

" }, "LifecyclePolicyStats":{ "shape":"LifecyclePolicyStats", "documentation":"

Information about the lifecycle policies in your account.

" }, "SecurityConfigStats":{ "shape":"SecurityConfigStats", "documentation":"

Information about the security configurations in your account.

" }, "SecurityPolicyStats":{ "shape":"SecurityPolicyStats", "documentation":"

Information about the security policies in your account.

" }, "TotalPolicyCount":{ "shape":"Long", "documentation":"

The total number of OpenSearch Serverless security policies and configurations in your account.

" } } }, "GetSecurityConfigRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"SecurityConfigId", "documentation":"

The unique identifier of the security configuration.

" } } }, "GetSecurityConfigResponse":{ "type":"structure", "members":{ "securityConfigDetail":{ "shape":"SecurityConfigDetail", "documentation":"

Details of the requested security configuration.

" } } }, "GetSecurityPolicyRequest":{ "type":"structure", "required":[ "name", "type" ], "members":{ "name":{ "shape":"PolicyName", "documentation":"

The name of the security policy.

" }, "type":{ "shape":"SecurityPolicyType", "documentation":"

The type of security policy.

" } } }, "GetSecurityPolicyResponse":{ "type":"structure", "members":{ "securityPolicyDetail":{ "shape":"SecurityPolicyDetail", "documentation":"

Details about the requested security policy.

" } } }, "IndexingCapacityValue":{ "type":"integer", "box":true, "min":2 }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

Thrown when an error internal to the service occurs while processing a request.

", "exception":true, "fault":true }, "LifecyclePolicyDetail":{ "type":"structure", "members":{ "createdDate":{ "shape":"Long", "documentation":"

The date the lifecycle policy was created.

" }, "description":{ "shape":"PolicyDescription", "documentation":"

The description of the lifecycle policy.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The timestamp of when the lifecycle policy was last modified.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the lifecycle policy.

" }, "policy":{ "shape":"Document", "documentation":"

The JSON policy document without any whitespaces.

" }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the lifecycle policy.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } }, "documentation":"

Details about an OpenSearch Serverless lifecycle policy.

" }, "LifecyclePolicyDetails":{ "type":"list", "member":{"shape":"LifecyclePolicyDetail"} }, "LifecyclePolicyErrorDetail":{ "type":"structure", "members":{ "errorCode":{ "shape":"String", "documentation":"

The error code for the request. For example, `NOT_FOUND`.

" }, "errorMessage":{ "shape":"String", "documentation":"

A description of the error. For example, `The specified Lifecycle Policy is not found`.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the lifecycle policy.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } }, "documentation":"

Error information for an OpenSearch Serverless request.

" }, "LifecyclePolicyErrorDetails":{ "type":"list", "member":{"shape":"LifecyclePolicyErrorDetail"} }, "LifecyclePolicyIdentifier":{ "type":"structure", "required":[ "name", "type" ], "members":{ "name":{ "shape":"PolicyName", "documentation":"

The name of the lifecycle policy.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } }, "documentation":"

The unique identifiers of policy types and policy names.

" }, "LifecyclePolicyIdentifiers":{ "type":"list", "member":{"shape":"LifecyclePolicyIdentifier"}, "max":40, "min":1 }, "LifecyclePolicyResourceIdentifier":{ "type":"structure", "required":[ "resource", "type" ], "members":{ "resource":{ "shape":"ResourceName", "documentation":"

The name of the OpenSearch Serverless ilndex resource.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } }, "documentation":"

The unique identifiers of policy types and resource names.

" }, "LifecyclePolicyResourceIdentifiers":{ "type":"list", "member":{"shape":"LifecyclePolicyResourceIdentifier"}, "max":100, "min":1 }, "LifecyclePolicyStats":{ "type":"structure", "members":{ "RetentionPolicyCount":{ "shape":"Long", "documentation":"

The number of retention lifecycle policies in the current account.

" } }, "documentation":"

Statistics for an OpenSearch Serverless lifecycle policy.

" }, "LifecyclePolicySummaries":{ "type":"list", "member":{"shape":"LifecyclePolicySummary"} }, "LifecyclePolicySummary":{ "type":"structure", "members":{ "createdDate":{ "shape":"Long", "documentation":"

The Epoch time when the lifecycle policy was created.

" }, "description":{ "shape":"PolicyDescription", "documentation":"

The description of the lifecycle policy.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The date and time when the lifecycle policy was last modified.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the lifecycle policy.

" }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the lifecycle policy.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } }, "documentation":"

A summary of the lifecycle policy.

" }, "LifecyclePolicyType":{ "type":"string", "enum":["retention"] }, "LifecycleResource":{"type":"string"}, "ListAccessPoliciesRequest":{ "type":"structure", "required":["type"], "members":{ "maxResults":{ "shape":"ListAccessPoliciesRequestMaxResultsInteger", "documentation":"

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.

" }, "nextToken":{ "shape":"String", "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.

" }, "resource":{ "shape":"ListAccessPoliciesRequestResourceList", "documentation":"

Resource filters (can be collections or indexes) that policies can apply to.

" }, "type":{ "shape":"AccessPolicyType", "documentation":"

The type of access policy.

" } } }, "ListAccessPoliciesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListAccessPoliciesRequestResourceList":{ "type":"list", "member":{"shape":"Resource"}, "max":1000, "min":1 }, "ListAccessPoliciesResponse":{ "type":"structure", "members":{ "accessPolicySummaries":{ "shape":"AccessPolicySummaries", "documentation":"

Details about the requested access policies.

" }, "nextToken":{ "shape":"String", "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.

" } } }, "ListCollectionsRequest":{ "type":"structure", "members":{ "collectionFilters":{ "shape":"CollectionFilters", "documentation":"

A list of filter names and values that you can use for requests.

" }, "maxResults":{ "shape":"ListCollectionsRequestMaxResultsInteger", "documentation":"

The maximum number of results to return. Default is 20. You can use `nextToken` to get the next page of results.

" }, "nextToken":{ "shape":"String", "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.

" } } }, "ListCollectionsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListCollectionsResponse":{ "type":"structure", "members":{ "collectionSummaries":{ "shape":"CollectionSummaries", "documentation":"

Details about each collection.

" }, "nextToken":{ "shape":"String", "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.

" } } }, "ListLifecyclePoliciesRequest":{ "type":"structure", "required":["type"], "members":{ "maxResults":{ "shape":"ListLifecyclePoliciesRequestMaxResultsInteger", "documentation":"

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.

" }, "nextToken":{ "shape":"String", "documentation":"

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.

" }, "resources":{ "shape":"ListLifecyclePoliciesRequestResourcesList", "documentation":"

Resource filters that policies can apply to. Currently, the only supported resource type is `index`.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } } }, "ListLifecyclePoliciesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListLifecyclePoliciesRequestResourcesList":{ "type":"list", "member":{"shape":"LifecycleResource"}, "max":1000, "min":1 }, "ListLifecyclePoliciesResponse":{ "type":"structure", "members":{ "lifecyclePolicySummaries":{ "shape":"LifecyclePolicySummaries", "documentation":"

Details about the requested lifecycle policies.

" }, "nextToken":{ "shape":"String", "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.

" } } }, "ListSecurityConfigsRequest":{ "type":"structure", "required":["type"], "members":{ "maxResults":{ "shape":"ListSecurityConfigsRequestMaxResultsInteger", "documentation":"

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.

" }, "nextToken":{ "shape":"String", "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.

" }, "type":{ "shape":"SecurityConfigType", "documentation":"

The type of security configuration.

" } } }, "ListSecurityConfigsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListSecurityConfigsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "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.

" }, "securityConfigSummaries":{ "shape":"SecurityConfigSummaries", "documentation":"

Details about the security configurations in your account.

" } } }, "ListSecurityPoliciesRequest":{ "type":"structure", "required":["type"], "members":{ "maxResults":{ "shape":"ListSecurityPoliciesRequestMaxResultsInteger", "documentation":"

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.

" }, "nextToken":{ "shape":"String", "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.

" }, "resource":{ "shape":"ListSecurityPoliciesRequestResourceList", "documentation":"

Resource filters (can be collection or indexes) that policies can apply to.

" }, "type":{ "shape":"SecurityPolicyType", "documentation":"

The type of policy.

" } } }, "ListSecurityPoliciesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListSecurityPoliciesRequestResourceList":{ "type":"list", "member":{"shape":"Resource"}, "max":1000, "min":1 }, "ListSecurityPoliciesResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "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.

" }, "securityPolicySummaries":{ "shape":"SecurityPolicySummaries", "documentation":"

Details about the security policies in your account.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "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.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"Tags", "documentation":"

The tags associated with the resource.

" } } }, "ListVpcEndpointsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListVpcEndpointsRequestMaxResultsInteger", "documentation":"

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.

" }, "nextToken":{ "shape":"String", "documentation":"

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.

" }, "vpcEndpointFilters":{ "shape":"VpcEndpointFilters", "documentation":"

Filter the results according to the current status of the VPC endpoint. Possible statuses are `CREATING`, `DELETING`, `UPDATING`, `ACTIVE`, and `FAILED`.

" } } }, "ListVpcEndpointsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListVpcEndpointsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "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.

" }, "vpcEndpointSummaries":{ "shape":"VpcEndpointSummaries", "documentation":"

Details about each VPC endpoint, including the name and current status.

" } } }, "Long":{ "type":"long", "box":true }, "OcuLimitExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"

Description of the error.

" } }, "documentation":"

Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.

", "exception":true }, "PolicyDescription":{ "type":"string", "max":1000, "min":0 }, "PolicyDocument":{ "type":"string", "max":20480, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" }, "PolicyName":{ "type":"string", "max":32, "min":3, "pattern":"^[a-z][a-z0-9-]+$" }, "PolicyVersion":{ "type":"string", "max":36, "min":20, "pattern":"^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$" }, "Resource":{"type":"string"}, "ResourceName":{ "type":"string", "pattern":"^index/[a-z][a-z0-9-]{3,32}/([a-z;0-9&$%][+.~=\\-_a-z;0-9&$%]*|\\*)$" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

Thrown when accessing or deleting a resource that does not exist.

", "exception":true }, "ResourceType":{ "type":"string", "enum":["index"] }, "SamlConfigOptions":{ "type":"structure", "required":["metadata"], "members":{ "groupAttribute":{ "shape":"samlGroupAttribute", "documentation":"

The group attribute for this SAML integration.

" }, "metadata":{ "shape":"samlMetadata", "documentation":"

The XML IdP metadata file generated from your identity provider.

" }, "sessionTimeout":{ "shape":"SamlConfigOptionsSessionTimeoutInteger", "documentation":"

The session timeout, in minutes. Default is 60 minutes (12 hours).

" }, "userAttribute":{ "shape":"samlUserAttribute", "documentation":"

A user attribute for this SAML integration.

" } }, "documentation":"

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

" }, "SamlConfigOptionsSessionTimeoutInteger":{ "type":"integer", "box":true, "max":720, "min":5 }, "SearchCapacityValue":{ "type":"integer", "box":true, "min":2 }, "SecurityConfigDetail":{ "type":"structure", "members":{ "configVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the security configuration.

" }, "createdDate":{ "shape":"Long", "documentation":"

The date the configuration was created.

" }, "description":{ "shape":"ConfigDescription", "documentation":"

The description of the security configuration.

" }, "id":{ "shape":"SecurityConfigId", "documentation":"

The unique identifier of the security configuration.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The timestamp of when the configuration was last modified.

" }, "samlOptions":{ "shape":"SamlConfigOptions", "documentation":"

SAML options for the security configuration in the form of a key-value map.

" }, "type":{ "shape":"SecurityConfigType", "documentation":"

The type of security configuration.

" } }, "documentation":"

Details about a security configuration for OpenSearch Serverless.

" }, "SecurityConfigId":{ "type":"string", "max":100, "min":1 }, "SecurityConfigStats":{ "type":"structure", "members":{ "SamlConfigCount":{ "shape":"Long", "documentation":"

The number of security configurations in the current account.

" } }, "documentation":"

Statistics for an OpenSearch Serverless security configuration.

" }, "SecurityConfigSummaries":{ "type":"list", "member":{"shape":"SecurityConfigSummary"} }, "SecurityConfigSummary":{ "type":"structure", "members":{ "configVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the security configuration.

" }, "createdDate":{ "shape":"Long", "documentation":"

The Epoch time when the security configuration was created.

" }, "description":{ "shape":"ConfigDescription", "documentation":"

The description of the security configuration.

" }, "id":{ "shape":"SecurityConfigId", "documentation":"

The unique identifier of the security configuration.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The timestamp of when the configuration was last modified.

" }, "type":{ "shape":"SecurityConfigType", "documentation":"

The type of security configuration.

" } }, "documentation":"

A summary of a security configuration for OpenSearch Serverless.

" }, "SecurityConfigType":{ "type":"string", "enum":["saml"] }, "SecurityGroupId":{ "type":"string", "max":128, "min":1, "pattern":"^[\\w+\\-]+$" }, "SecurityGroupIds":{ "type":"list", "member":{"shape":"SecurityGroupId"}, "max":5, "min":1 }, "SecurityPolicyDetail":{ "type":"structure", "members":{ "createdDate":{ "shape":"Long", "documentation":"

The date the policy was created.

" }, "description":{ "shape":"PolicyDescription", "documentation":"

The description of the security policy.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The timestamp of when the policy was last modified.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" }, "policy":{ "shape":"Document", "documentation":"

The JSON policy document without any whitespaces.

" }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the policy.

" }, "type":{ "shape":"SecurityPolicyType", "documentation":"

The type of security policy.

" } }, "documentation":"

Details about an OpenSearch Serverless security policy.

" }, "SecurityPolicyStats":{ "type":"structure", "members":{ "EncryptionPolicyCount":{ "shape":"Long", "documentation":"

The number of encryption policies in the current account.

" }, "NetworkPolicyCount":{ "shape":"Long", "documentation":"

The number of network policies in the current account.

" } }, "documentation":"

Statistics for an OpenSearch Serverless security policy.

" }, "SecurityPolicySummaries":{ "type":"list", "member":{"shape":"SecurityPolicySummary"} }, "SecurityPolicySummary":{ "type":"structure", "members":{ "createdDate":{ "shape":"Long", "documentation":"

The date the policy was created.

" }, "description":{ "shape":"PolicyDescription", "documentation":"

The description of the security policy.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The timestamp of when the policy was last modified.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the policy.

" }, "type":{ "shape":"SecurityPolicyType", "documentation":"

The type of security policy.

" } }, "documentation":"

A summary of a security policy for OpenSearch Serverless.

" }, "SecurityPolicyType":{ "type":"string", "enum":[ "encryption", "network" ] }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "message", "serviceCode" ], "members":{ "message":{ "shape":"String", "documentation":"

Description of the error.

" }, "quotaCode":{ "shape":"String", "documentation":"

Service Quotas requirement to identify originating quota.

" }, "resourceId":{ "shape":"String", "documentation":"

Identifier of the resource affected.

" }, "resourceType":{ "shape":"String", "documentation":"

Type of the resource affected.

" }, "serviceCode":{ "shape":"String", "documentation":"

Service Quotas requirement to identify originating service.

" } }, "documentation":"

Thrown when you attempt to create more resources than the service allows based on service quotas.

", "exception":true }, "StandbyReplicas":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "String":{"type":"string"}, "SubnetId":{ "type":"string", "max":32, "min":1, "pattern":"^subnet-([0-9a-f]{8}|[0-9a-f]{17})$" }, "SubnetIds":{ "type":"list", "member":{"shape":"SubnetId"}, "max":6, "min":1 }, "Tag":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"TagKey", "documentation":"

The key to use in the tag.

" }, "value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

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

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "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.

" }, "tags":{ "shape":"Tags", "documentation":"

A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "Tags":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":0 }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "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.

" }, "tagKeys":{ "shape":"TagKeys", "documentation":"

The tag or set of tags to remove from the resource. All tag keys in the request must be unique.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateAccessPolicyRequest":{ "type":"structure", "required":[ "name", "policyVersion", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "description":{ "shape":"PolicyDescription", "documentation":"

A description of the policy. Typically used to store information about the permissions defined in the policy.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" }, "policy":{ "shape":"PolicyDocument", "documentation":"

The JSON policy document to use as the content for the policy.

" }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the policy being updated.

" }, "type":{ "shape":"AccessPolicyType", "documentation":"

The type of policy.

" } } }, "UpdateAccessPolicyResponse":{ "type":"structure", "members":{ "accessPolicyDetail":{ "shape":"AccessPolicyDetail", "documentation":"

Details about the updated access policy.

" } } }, "UpdateAccountSettingsRequest":{ "type":"structure", "members":{ "capacityLimits":{"shape":"CapacityLimits"} } }, "UpdateAccountSettingsResponse":{ "type":"structure", "members":{ "accountSettingsDetail":{ "shape":"AccountSettingsDetail", "documentation":"

OpenSearch Serverless-related settings for the current Amazon Web Services account.

" } } }, "UpdateCollectionDetail":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the collection.

" }, "createdDate":{ "shape":"Long", "documentation":"

The date and time when the collection was created.

" }, "description":{ "shape":"String", "documentation":"

The description of the collection.

" }, "id":{ "shape":"CollectionId", "documentation":"

The unique identifier of the collection.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The date and time when the collection was last modified.

" }, "name":{ "shape":"CollectionName", "documentation":"

The name of the collection.

" }, "status":{ "shape":"CollectionStatus", "documentation":"

The current status of the collection.

" }, "type":{ "shape":"CollectionType", "documentation":"

The collection type.

" } }, "documentation":"

Details about an updated OpenSearch Serverless collection.

" }, "UpdateCollectionRequest":{ "type":"structure", "required":["id"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "description":{ "shape":"UpdateCollectionRequestDescriptionString", "documentation":"

A description of the collection.

" }, "id":{ "shape":"CollectionId", "documentation":"

The unique identifier of the collection.

" } } }, "UpdateCollectionRequestDescriptionString":{ "type":"string", "max":1000, "min":0 }, "UpdateCollectionResponse":{ "type":"structure", "members":{ "updateCollectionDetail":{ "shape":"UpdateCollectionDetail", "documentation":"

Details about the updated collection.

" } } }, "UpdateLifecyclePolicyRequest":{ "type":"structure", "required":[ "name", "policyVersion", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "description":{ "shape":"PolicyDescription", "documentation":"

A description of the lifecycle policy.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" }, "policy":{ "shape":"PolicyDocument", "documentation":"

The JSON policy document to use as the content for the lifecycle policy.

" }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the policy being updated.

" }, "type":{ "shape":"LifecyclePolicyType", "documentation":"

The type of lifecycle policy.

" } } }, "UpdateLifecyclePolicyResponse":{ "type":"structure", "members":{ "lifecyclePolicyDetail":{ "shape":"LifecyclePolicyDetail", "documentation":"

Details about the updated lifecycle policy.

" } } }, "UpdateSecurityConfigRequest":{ "type":"structure", "required":[ "configVersion", "id" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "configVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the security configuration to be updated. You can find the most recent version of a security configuration using the `GetSecurityPolicy` command.

" }, "description":{ "shape":"ConfigDescription", "documentation":"

A description of the security configuration.

" }, "id":{ "shape":"SecurityConfigId", "documentation":"

The security configuration identifier. For SAML the ID will be `saml/<accountId>/<idpProviderName>`. For example, `saml/123456789123/OKTADev`.

" }, "samlOptions":{ "shape":"SamlConfigOptions", "documentation":"

SAML options in in the form of a key-value map.

" } } }, "UpdateSecurityConfigResponse":{ "type":"structure", "members":{ "securityConfigDetail":{ "shape":"SecurityConfigDetail", "documentation":"

Details about the updated security configuration.

" } } }, "UpdateSecurityPolicyRequest":{ "type":"structure", "required":[ "name", "policyVersion", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "description":{ "shape":"PolicyDescription", "documentation":"

A description of the policy. Typically used to store information about the permissions defined in the policy.

" }, "name":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" }, "policy":{ "shape":"PolicyDocument", "documentation":"

The JSON policy document to use as the content for the new policy.

" }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"

The version of the policy being updated.

" }, "type":{ "shape":"SecurityPolicyType", "documentation":"

The type of access policy.

" } } }, "UpdateSecurityPolicyResponse":{ "type":"structure", "members":{ "securityPolicyDetail":{ "shape":"SecurityPolicyDetail", "documentation":"

Details about the updated security policy.

" } } }, "UpdateVpcEndpointDetail":{ "type":"structure", "members":{ "id":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

" }, "lastModifiedDate":{ "shape":"Long", "documentation":"

The timestamp of when the endpoint was last modified.

" }, "name":{ "shape":"VpcEndpointName", "documentation":"

The name of the endpoint.

" }, "securityGroupIds":{ "shape":"SecurityGroupIds", "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":{ "shape":"VpcEndpointStatus", "documentation":"

The current status of the endpoint update process.

" }, "subnetIds":{ "shape":"SubnetIds", "documentation":"

The ID of the subnets from which you access OpenSearch Serverless.

" } }, "documentation":"

Update details for an OpenSearch Serverless-managed interface endpoint.

" }, "UpdateVpcEndpointRequest":{ "type":"structure", "required":["id"], "members":{ "addSecurityGroupIds":{ "shape":"SecurityGroupIds", "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.

" }, "addSubnetIds":{ "shape":"SubnetIds", "documentation":"

The ID of one or more subnets to add to the endpoint.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

", "idempotencyToken":true }, "id":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the interface endpoint to update.

" }, "removeSecurityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"

The unique identifiers of the security groups to remove from the endpoint.

" }, "removeSubnetIds":{ "shape":"SubnetIds", "documentation":"

The unique identifiers of the subnets to remove from the endpoint.

" } } }, "UpdateVpcEndpointResponse":{ "type":"structure", "members":{ "UpdateVpcEndpointDetail":{ "shape":"UpdateVpcEndpointDetail", "documentation":"

Details about the updated VPC endpoint.

" } } }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

Thrown when the HTTP request contains invalid input or is missing required input.

", "exception":true }, "VpcEndpointDetail":{ "type":"structure", "members":{ "createdDate":{ "shape":"Long", "documentation":"

The date the endpoint was created.

" }, "id":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

" }, "name":{ "shape":"VpcEndpointName", "documentation":"

The name of the endpoint.

" }, "securityGroupIds":{ "shape":"SecurityGroupIds", "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":{ "shape":"VpcEndpointStatus", "documentation":"

The current status of the endpoint.

" }, "subnetIds":{ "shape":"SubnetIds", "documentation":"

The ID of the subnets from which you access OpenSearch Serverless.

" }, "vpcId":{ "shape":"VpcId", "documentation":"

The ID of the VPC from which you access OpenSearch Serverless.

" } }, "documentation":"

Details about an OpenSearch Serverless-managed interface endpoint.

" }, "VpcEndpointDetails":{ "type":"list", "member":{"shape":"VpcEndpointDetail"} }, "VpcEndpointErrorDetail":{ "type":"structure", "members":{ "errorCode":{ "shape":"String", "documentation":"

The error code for the failed request.

" }, "errorMessage":{ "shape":"String", "documentation":"

An error message describing the reason for the failure.

" }, "id":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the VPC endpoint.

" } }, "documentation":"

Error information for a failed `BatchGetVpcEndpoint` request.

" }, "VpcEndpointErrorDetails":{ "type":"list", "member":{"shape":"VpcEndpointErrorDetail"} }, "VpcEndpointFilters":{ "type":"structure", "members":{ "status":{ "shape":"VpcEndpointStatus", "documentation":"

The current status of the endpoint.

" } }, "documentation":"

Filter the results of a `ListVpcEndpoints` request.

" }, "VpcEndpointId":{ "type":"string", "max":255, "min":1, "pattern":"^vpce-[0-9a-z]*$" }, "VpcEndpointIds":{ "type":"list", "member":{"shape":"VpcEndpointId"}, "min":1 }, "VpcEndpointName":{ "type":"string", "max":32, "min":3, "pattern":"^[a-z][a-z0-9-]+$" }, "VpcEndpointStatus":{ "type":"string", "enum":[ "PENDING", "DELETING", "ACTIVE", "FAILED" ] }, "VpcEndpointSummaries":{ "type":"list", "member":{"shape":"VpcEndpointSummary"} }, "VpcEndpointSummary":{ "type":"structure", "members":{ "id":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

" }, "name":{ "shape":"VpcEndpointName", "documentation":"

The name of the endpoint.

" }, "status":{ "shape":"VpcEndpointStatus", "documentation":"

The current status of the endpoint.

" } }, "documentation":"

The VPC endpoint object.

" }, "VpcId":{ "type":"string", "max":255, "min":1, "pattern":"^vpc-[0-9a-z]*$" }, "samlGroupAttribute":{ "type":"string", "max":2048, "min":1, "pattern":"[\\w+=,.@-]+" }, "samlMetadata":{ "type":"string", "max":51200, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" }, "samlUserAttribute":{ "type":"string", "max":2048, "min":1, "pattern":"[\\w+=,.@-]+" } }, "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?

" }