Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that OpenSearch Service Serverless can respond with.

Structs

AccessPolicyDetail

Details about an OpenSearch Serverless access policy.

AccessPolicyStats

Statistics for an OpenSearch Serverless access policy.

AccessPolicySummary

A summary of the data access policy.

AccountSettingsDetail

OpenSearch Serverless-related information for the current account.

CapacityLimits

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.

CollectionDetail

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

CollectionErrorDetail

Error information for an OpenSearch Serverless request.

CollectionFilters

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

CollectionSummary

Details about each OpenSearch Serverless collection.

CreateCollectionDetail

Details about the created OpenSearch Serverless collection.

CreateIamIdentityCenterConfigOptions

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

CreateVpcEndpointDetail

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

DeleteCollectionDetail

Details about a deleted OpenSearch Serverless collection.

DeleteVpcEndpointDetail

Deletion details for an OpenSearch Serverless-managed interface endpoint.

EffectiveLifecyclePolicyDetail

Error information for an OpenSearch Serverless request.

EffectiveLifecyclePolicyErrorDetail

Error information for an OpenSearch Serverless request.

FipsEndpoints

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.

IamFederationConfigOptions

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.

IamIdentityCenterConfigOptions

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

LifecyclePolicyDetail

Details about an OpenSearch Serverless lifecycle policy.

LifecyclePolicyErrorDetail

Error information for an OpenSearch Serverless request.

LifecyclePolicyIdentifier

The unique identifiers of policy types and policy names.

LifecyclePolicyResourceIdentifier

The unique identifiers of policy types and resource names.

LifecyclePolicyStats

Statistics for an OpenSearch Serverless lifecycle policy.

LifecyclePolicySummary

A summary of the lifecycle policy.

SamlConfigOptions

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

SecurityConfigDetail

Details about a security configuration for OpenSearch Serverless.

SecurityConfigStats

Statistics for an OpenSearch Serverless security configuration.

SecurityConfigSummary

A summary of a security configuration for OpenSearch Serverless.

SecurityPolicyDetail

Details about an OpenSearch Serverless security policy.

SecurityPolicyStats

Statistics for an OpenSearch Serverless security policy.

SecurityPolicySummary

A summary of a security policy for OpenSearch Serverless.

Tag

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

UpdateCollectionDetail

Details about an updated OpenSearch Serverless collection.

UpdateIamIdentityCenterConfigOptions

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

UpdateVpcEndpointDetail

Update details for an OpenSearch Serverless-managed interface endpoint.

VpcEndpointDetail

Details about an OpenSearch Serverless-managed interface endpoint.

VpcEndpointErrorDetail

Error information for a failed BatchGetVpcEndpoint request.

VpcEndpointFilters

Filter the results of a ListVpcEndpoints request.

VpcEndpointSummary

The VPC endpoint object.

Enums

AccessPolicyType

When writing a match expression against AccessPolicyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CollectionStatus

When writing a match expression against CollectionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CollectionType

When writing a match expression against CollectionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IamIdentityCenterGroupAttribute

When writing a match expression against IamIdentityCenterGroupAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IamIdentityCenterUserAttribute

When writing a match expression against IamIdentityCenterUserAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

LifecyclePolicyType

When writing a match expression against LifecyclePolicyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResourceType

When writing a match expression against ResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SecurityConfigType

When writing a match expression against SecurityConfigType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SecurityPolicyType

When writing a match expression against SecurityPolicyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StandbyReplicas

When writing a match expression against StandbyReplicas, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VpcEndpointStatus

When writing a match expression against VpcEndpointStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.