Skip to content

DomainPackageDetails

Source code in docs_src/capo_opensearch/types/domain_package_details.py
class DomainPackageDetails(TypedDict, closed=True):
    package_id: NotRequired["capo_opensearch.types.package_id.PackageID"]
    """<p>Internal ID of the package.</p>"""
    package_name: NotRequired["capo_opensearch.types.package_name.PackageName"]
    """<p>User-specified name of the package.</p>"""
    package_type: NotRequired["capo_opensearch.types.package_type.PackageType"]
    """<p>The type of package.</p>"""
    last_updated: NotRequired["capo_opensearch.types.last_updated.LastUpdated"]
    """<p>Timestamp of the most recent update to the package association status.</p>"""
    domain_name: NotRequired["capo_opensearch.types.domain_name.DomainName"]
    """<p>Name of the domain that the package is associated with.</p>"""
    domain_package_status: NotRequired[
        "capo_opensearch.types.domain_package_status.DomainPackageStatus"
    ]
    """<p>State of the association.</p>"""
    package_version: NotRequired["capo_opensearch.types.package_version.PackageVersion"]
    """<p>The current version of the package.</p>"""
    prerequisite_package_id_list: NotRequired[
        "capo_opensearch.types.package_id_list.PackageIDList"
    ]
    """<p>A list of package IDs that must be associated with the domain before or with the package can be associated.</p>"""
    reference_path: NotRequired["capo_opensearch.types.reference_path.ReferencePath"]
    """<p>The relative path of the package on the OpenSearch Service cluster nodes. This is <code>synonym_path</code> when the package is for synonym files.</p>"""
    error_details: NotRequired["capo_opensearch.types.error_details.ErrorDetails"]
    """<p>Additional information if the package is in an error state. Null otherwise.</p>"""
    association_configuration: NotRequired[
        "capo_opensearch.types.package_association_configuration.PackageAssociationConfiguration"
    ]
    """<p>The configuration for associating a package with an Amazon OpenSearch Service domain.</p>"""

association_configuration instance-attribute

association_configuration: NotRequired[PackageAssociationConfiguration]

The configuration for associating a package with an Amazon OpenSearch Service domain.

domain_name instance-attribute

domain_name: NotRequired[DomainName]

Name of the domain that the package is associated with.

domain_package_status instance-attribute

domain_package_status: NotRequired[DomainPackageStatus]

State of the association.

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 package 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]

The type of package.

package_version instance-attribute

package_version: NotRequired[PackageVersion]

The current version of the package.

prerequisite_package_id_list instance-attribute

prerequisite_package_id_list: NotRequired[PackageIDList]

A list of package IDs that must be associated with the domain before or with the package can be associated.

reference_path instance-attribute

reference_path: NotRequired[ReferencePath]

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.