Skip to content

UpgradeDomainResponse

Source code in docs_src/capo_opensearch/types/upgrade_domain_response.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class UpgradeDomainResponse(TypedDict, closed=True):
    upgrade_id: NotRequired["capo_opensearch.types.string.String"]
    """<p>The unique identifier of the domain upgrade.</p>"""
    domain_name: NotRequired["capo_opensearch.types.domain_name.DomainName"]
    """<p>The name of the domain that was upgraded.</p>"""
    target_version: NotRequired["capo_opensearch.types.version_string.VersionString"]
    """<p>OpenSearch or Elasticsearch version that the domain was upgraded to.</p>"""
    perform_check_only: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>When true, indicates that an upgrade eligibility check was performed.</p>"""
    advanced_options: NotRequired[
        "capo_opensearch.types.advanced_options.AdvancedOptions"
    ]
    """<p>The advanced options configuration for the domain.</p>"""
    change_progress_details: NotRequired[
        "capo_opensearch.types.change_progress_details.ChangeProgressDetails"
    ]
    """<p>Container for information about a configuration change happening on a domain.</p>"""

advanced_options instance-attribute 

advanced_options: NotRequired[AdvancedOptions]

The advanced options configuration for the domain.

change_progress_details instance-attribute 

change_progress_details: NotRequired[ChangeProgressDetails]

Container for information about a configuration change happening on a domain.

domain_name instance-attribute 

domain_name: NotRequired[DomainName]

The name of the domain that was upgraded.

perform_check_only instance-attribute 

perform_check_only: NotRequired[Boolean]

When true, indicates that an upgrade eligibility check was performed.

target_version instance-attribute 

target_version: NotRequired[VersionString]

OpenSearch or Elasticsearch version that the domain was upgraded to.

upgrade_id instance-attribute 

upgrade_id: NotRequired[String]

The unique identifier of the domain upgrade.