PackageDetails ¶

class PackageDetails(TypedDict, closed=True):
    package_id: NotRequired["capo_opensearch.types.package_id.PackageID"]
    """<p>The unique identifier of the package.</p>"""
    package_name: NotRequired["capo_opensearch.types.package_name.PackageName"]
    """<p>The user-specified name of the package.</p>"""
    package_type: NotRequired["capo_opensearch.types.package_type.PackageType"]
    """<p>The type of package.</p>"""
    package_description: NotRequired[
        "capo_opensearch.types.package_description.PackageDescription"
    ]
    """<p>User-specified description of the package.</p>"""
    package_status: NotRequired["capo_opensearch.types.package_status.PackageStatus"]
    """<p>The current status of the package. The available options are <code>AVAILABLE</code>, <code>COPYING</code>, <code>COPY_FAILED</code>, <code>VALIDATNG</code>, <code>VALIDATION_FAILED</code>, <code>DELETING</code>, and <code>DELETE_FAILED</code>.</p>"""
    created_at: NotRequired["capo_opensearch.types.created_at.CreatedAt"]
    """<p>The timestamp when the package was created.</p>"""
    last_updated_at: NotRequired["capo_opensearch.types.last_updated.LastUpdated"]
    """<p>Date and time when the package was last updated.</p>"""
    available_package_version: NotRequired[
        "capo_opensearch.types.package_version.PackageVersion"
    ]
    """<p>The package version.</p>"""
    error_details: NotRequired["capo_opensearch.types.error_details.ErrorDetails"]
    """<p>Additional information if the package is in an error state. Null otherwise.</p>"""
    engine_version: NotRequired["capo_opensearch.types.engine_version.EngineVersion"]
    """<p>Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.</p>"""
    available_plugin_properties: NotRequired[
        "capo_opensearch.types.plugin_properties.PluginProperties"
    ]
    """<p>If the package is a <code>ZIP-PLUGIN</code> package, additional information about plugin properties.</p>"""
    available_package_configuration: NotRequired[
        "capo_opensearch.types.package_configuration.PackageConfiguration"
    ]
    """<p>This represents the available configuration parameters for the package.</p>"""
    allow_listed_user_list: NotRequired[
        "capo_opensearch.types.package_user_list.PackageUserList"
    ]
    """<p> A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.</p>"""
    package_owner: NotRequired["capo_opensearch.types.package_owner.PackageOwner"]
    """<p>The owner of the package who is allowed to create and update a package and add users to the package scope.</p>"""
    package_vending_options: NotRequired[
        "capo_opensearch.types.package_vending_options.PackageVendingOptions"
    ]
    """<p>Package Vending Options for a package.</p>"""
    package_encryption_options: NotRequired[
        "capo_opensearch.types.package_encryption_options.PackageEncryptionOptions"
    ]
    """<p>Encryption options for a package.</p>"""