CollectionErrorDetail

Error information for an OpenSearch Serverless request.

errorCode

The error code for the request. For example, NOT_FOUND, INTERNAL_FAILURE, or OCU_LIMIT_EXCEEDED.

INTERNAL_FAILURE - Indicates that an internal server error occurred. This error generally indicates that your OpenSearch compute units (OCUs) are overloaded by the volume or complexity of your requests. Although OpenSearch Serverless scales automatically to manage the load, there can be a delay in deploying additional resources.

To mitigate this error, implement an exponential backoff retry policy. This approach temporarily reduces the request rate to effectively manage the load. For more details, refer to Retry behavior in the AWS SDKs and Tools Reference Guide.
NOT_FOUND - Indicates that the specified collection doesn't exist.
OCU_LIMIT_EXCEEDED - Indicates that you reached the maximum OpenSearch compute unit (OCU) capacity limit. Optimize your workload to reduce the OCU usage or request a quota increase.

Type: String

Required: No

errorMessage

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

Type: String

Required: No

id

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: [a-z0-9]{3,40}

Required: No

name

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 32.

Pattern: [a-z][a-z0-9-]+

Required: No

Contents