Skip to content

create_package

create_package(
    package_name: PackageName,
    package_type: PackageType,
    package_source: PackageSource,
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
    package_description: Optional[PackageDescription] = None,
    package_configuration: Optional[PackageConfiguration] = None,
    engine_version: Optional[EngineVersion] = None,
    package_vending_options: Optional[PackageVendingOptions] = None,
    package_encryption_options: Optional[PackageEncryptionOptions] = None,
) -> CreatePackageResponse

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

Parameters:

  • package_name (PackageName) –

    Unique name for the package.

  • package_type (PackageType) –

    The type of package.

  • package_description (Optional[PackageDescription], default: None ) –

    Description of the package.

  • package_source (PackageSource) –

    The Amazon S3 location from which to import the package.

  • package_configuration (Optional[PackageConfiguration], default: None ) –

    The configuration parameters for the package being created.

  • engine_version (Optional[EngineVersion], default: None ) –

    The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN

  • package_vending_options (Optional[PackageVendingOptions], default: None ) –

    The vending options for the package being created. They determine if the package can be vended to other users.

  • package_encryption_options (Optional[PackageEncryptionOptions], default: None ) –

    The encryption parameters for the package being created.

Raises:

Source code in docs_src/capo_opensearch/_services/open_search.py
def create_package(
    self,
    package_name: "capo_opensearch.types.package_name.PackageName",
    package_type: "capo_opensearch.types.package_type.PackageType",
    package_source: "capo_opensearch.types.package_source.PackageSource",
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
    package_description: Optional[
        "capo_opensearch.types.package_description.PackageDescription"
    ] = None,
    package_configuration: Optional[
        "capo_opensearch.types.package_configuration.PackageConfiguration"
    ] = None,
    engine_version: Optional[
        "capo_opensearch.types.engine_version.EngineVersion"
    ] = None,
    package_vending_options: Optional[
        "capo_opensearch.types.package_vending_options.PackageVendingOptions"
    ] = None,
    package_encryption_options: Optional[
        "capo_opensearch.types.package_encryption_options.PackageEncryptionOptions"
    ] = None,
) -> "capo_opensearch.types.create_package_response.CreatePackageResponse":
    """<p>Creates 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_name: <p>Unique name for the package.</p>
        package_type: <p>The type of package.</p>
        package_description: <p>Description of the package.</p>
        package_source: <p>The Amazon S3 location from which to import the package.</p>
        package_configuration: <p> The configuration parameters for the package being created.</p>
        engine_version: <p>The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type <code>ZIP-PLUGIN</code> </p>
        package_vending_options: <p> The vending options for the package being created. They determine if the package can be vended to other users.</p>
        package_encryption_options: <p>The encryption parameters for the package being created.</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.invalid_type_exception.InvalidTypeException: <p>An exception for trying to create or access a sub-resource that's either invalid or not supported.</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_already_exists_exception.ResourceAlreadyExistsException: <p>An exception for creating a resource that already exists.</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.create_package_request.CreatePackageRequest]",
    ) -> OperationResponse[
        "capo_opensearch.types.create_package_response.CreatePackageResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.create_package

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreatePackage")
    )
    input_: capo_opensearch.types.create_package_request.CreatePackageRequest = {
        "package_name": package_name,
        "package_type": package_type,
        "package_source": package_source,
    }
    if package_description is not None:
        input_["package_description"] = package_description
    if package_configuration is not None:
        input_["package_configuration"] = package_configuration
    if engine_version is not None:
        input_["engine_version"] = engine_version
    if package_vending_options is not None:
        input_["package_vending_options"] = package_vending_options
    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