Skip to content

CollectionErrorDetail

Source code in docs_src/capo_opensearchserverless/types/collection_error_detail.py
class CollectionErrorDetail(TypedDict, closed=True):
    id: NotRequired["capo_opensearchserverless.types.collection_id.CollectionId"]
    """<p>If the request contains collection IDs, the response includes the IDs provided in the request.</p>"""
    name: NotRequired["capo_opensearchserverless.types.collection_name.CollectionName"]
    """<p>If the request contains collection names, the response includes the names provided in the request.</p>"""
    error_message: NotRequired["str"]
    """<p>A description of the error. For example, <code>The specified Collection is not found.</code> </p>"""
    error_code: NotRequired["str"]
    """<p>The error code for the request. For example, <code>NOT_FOUND</code>.</p>"""

error_code instance-attribute

error_code: NotRequired[str]

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

error_message instance-attribute

error_message: NotRequired[str]

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

id instance-attribute

id: NotRequired[CollectionId]

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

name instance-attribute

name: NotRequired[CollectionName]

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