update_package ¶

def update_package(
    self,
    package_id: "capo_opensearch.types.package_id.PackageID",
    package_source: "capo_opensearch.types.package_source.PackageSource",
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
    package_description: Optional[
        "capo_opensearch.types.package_description.PackageDescription"
    ] = None,
    commit_message: Optional[
        "capo_opensearch.types.commit_message.CommitMessage"
    ] = None,
    package_configuration: Optional[
        "capo_opensearch.types.package_configuration.PackageConfiguration"
    ] = None,
    package_encryption_options: Optional[
        "capo_opensearch.types.package_encryption_options.PackageEncryptionOptions"
    ] = None,
) -> "capo_opensearch.types.update_package_response.UpdatePackageResponse":
    """<p>Updates a package for use with Amazon OpenSearch Service domains. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>.</p>

    Args:
        package_id: <p>The unique identifier for the package.</p>
        package_source: <p>Amazon S3 bucket and key for the package.</p>
        package_description: <p>A new description of the package.</p>
        commit_message: <p>Commit message for the updated file, which is shown as part of <code>GetPackageVersionHistoryResponse</code>.</p>
        package_configuration: <p>The updated configuration details for a package.</p>
        package_encryption_options: <p>Encryption options for a package.</p>

    Raises:
        capo_opensearch.errors.access_denied_exception.AccessDeniedException: <p>An error occurred because you don't have permissions to access the resource.</p>
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.limit_exceeded_exception.LimitExceededException: <p>An exception for trying to create more than the allowed number of resources or sub-resources.</p>
        capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_opensearch.types.update_package_request.UpdatePackageRequest]",
    ) -> OperationResponse[
        "capo_opensearch.types.update_package_response.UpdatePackageResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.update_package

        output, http_response = (
            capo_opensearch._operations.amazon_open_search_service.update_package.update_package(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePackage")
    )
    input_: capo_opensearch.types.update_package_request.UpdatePackageRequest = {
        "package_id": package_id,
        "package_source": package_source,
    }
    if package_description is not None:
        input_["package_description"] = package_description
    if commit_message is not None:
        input_["commit_message"] = commit_message
    if package_configuration is not None:
        input_["package_configuration"] = package_configuration
    if package_encryption_options is not None:
        input_["package_encryption_options"] = package_encryption_options

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output