Skip to content

DomainPackageDetails

Source code in docs_src/capo_elasticsearch_service/types/domain_package_details.py
class DomainPackageDetails(TypedDict, closed=True):
    package_id: NotRequired["capo_elasticsearch_service.types.package_id.PackageID"]
    """<p>Internal ID of the package.</p>"""
    package_name: NotRequired[
        "capo_elasticsearch_service.types.package_name.PackageName"
    ]
    """<p>User specified name of the package.</p>"""
    package_type: NotRequired[
        "capo_elasticsearch_service.types.package_type.PackageType"
    ]
    """<p>Currently supports only TXT-DICTIONARY.</p>"""
    last_updated: NotRequired[
        "capo_elasticsearch_service.types.last_updated.LastUpdated"
    ]
    """<p>Timestamp of the most-recent update to the association status.</p>"""
    domain_name: NotRequired["capo_elasticsearch_service.types.domain_name.DomainName"]
    """<p>Name of the domain you've associated a package with.</p>"""
    domain_package_status: NotRequired[
        "capo_elasticsearch_service.types.domain_package_status.DomainPackageStatus"
    ]
    """<p>State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.</p>"""
    package_version: NotRequired[
        "capo_elasticsearch_service.types.package_version.PackageVersion"
    ]
    reference_path: NotRequired[
        "capo_elasticsearch_service.types.reference_path.ReferencePath"
    ]
    """<p>The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.</p>"""
    error_details: NotRequired[
        "capo_elasticsearch_service.types.error_details.ErrorDetails"
    ]
    """<p>Additional information if the package is in an error state. Null otherwise.</p>"""

domain_name instance-attribute

domain_name: NotRequired[DomainName]

Name of the domain you've associated a package with.

domain_package_status instance-attribute

domain_package_status: NotRequired[DomainPackageStatus]

State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

error_details instance-attribute

error_details: NotRequired[ErrorDetails]

Additional information if the package is in an error state. Null otherwise.

last_updated instance-attribute

last_updated: NotRequired[LastUpdated]

Timestamp of the most-recent update to the association status.

package_id instance-attribute

package_id: NotRequired[PackageID]

Internal ID of the package.

package_name instance-attribute

package_name: NotRequired[PackageName]

User specified name of the package.

package_type instance-attribute

package_type: NotRequired[PackageType]

Currently supports only TXT-DICTIONARY.

package_version instance-attribute

package_version: NotRequired[PackageVersion]

reference_path instance-attribute

reference_path: NotRequired[ReferencePath]

The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.