Skip to content

DescribeIndexFieldsRequest

Source code in docs_src/capo_cloudsearch/types/describe_index_fields_request.py 
16
17
18
19
20
21
22
23
24
class DescribeIndexFieldsRequest(TypedDict, closed=True):
    domain_name: "capo_cloudsearch.types.domain_name.DomainName"
    """<p>The name of the domain you want to describe.</p>"""
    field_names: NotRequired[
        "capo_cloudsearch.types.dynamic_field_name_list.DynamicFieldNameList"
    ]
    """<p>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</p>"""
    deployed: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>"""

deployed instance-attribute 

deployed: NotRequired[Boolean]

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

domain_name instance-attribute 

domain_name: DomainName

The name of the domain you want to describe.

field_names instance-attribute 

field_names: NotRequired[DynamicFieldNameList]

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.