create_package ¶

create_package(
    package_name: PackageName,
    package_type: PackageType,
    package_source: PackageSource,
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
    package_description: Optional[PackageDescription] = None,
) -> CreatePackageResponse

Create a package for use with Amazon ES domains.

Parameters:

package_name (PackageName) –

Unique identifier for the package.
package_type (PackageType) –

Type of package. Currently supports only TXT-DICTIONARY.
package_description (Optional[PackageDescription], default: None ) –

Description of the package.
package_source (PackageSource) –

The customer S3 location PackageSource for importing the package.

Raises:

AccessDeniedException –

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
BaseException –

An error occurred while processing the request.
InternalException –

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
InvalidTypeException –

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
LimitExceededException –

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
ResourceAlreadyExistsException –

An exception for creating a resource that already exists. Gives http status code of 400.
ValidationException –

An exception for missing / invalid input fields. Gives http status code of 400.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_elasticsearch_service/_services/elasticsearch_service.py

def create_package(
    self,
    package_name: "capo_elasticsearch_service.types.package_name.PackageName",
    package_type: "capo_elasticsearch_service.types.package_type.PackageType",
    package_source: "capo_elasticsearch_service.types.package_source.PackageSource",
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
    package_description: Optional[
        "capo_elasticsearch_service.types.package_description.PackageDescription"
    ] = None,
) -> (
    "capo_elasticsearch_service.types.create_package_response.CreatePackageResponse"
):
    """<p>Create a package for use with Amazon ES domains.</p>

    Args:
        package_name: <p>Unique identifier for the package.</p>
        package_type: <p>Type of package. Currently supports only TXT-DICTIONARY.</p>
        package_description: <p>Description of the package.</p>
        package_source: <p>The customer S3 location <code>PackageSource</code> for importing the package.</p>

    Raises:
        capo_elasticsearch_service.errors.access_denied_exception.AccessDeniedException: <p>An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.</p>
        capo_elasticsearch_service.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_elasticsearch_service.errors.internal_exception.InternalException: <p>The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.</p>
        capo_elasticsearch_service.errors.invalid_type_exception.InvalidTypeException: <p>An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.</p>
        capo_elasticsearch_service.errors.limit_exceeded_exception.LimitExceededException: <p>An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.</p>
        capo_elasticsearch_service.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>An exception for creating a resource that already exists. Gives http status code of 400.</p>
        capo_elasticsearch_service.errors.validation_exception.ValidationException: <p>An exception for missing / invalid input fields. Gives http status code of 400.</p>
        capo_elasticsearch_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_elasticsearch_service.types.create_package_request.CreatePackageRequest]",
    ) -> OperationResponse[
        "capo_elasticsearch_service.types.create_package_response.CreatePackageResponse"
    ]:
        import capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.create_package

        output, http_response = (
            capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.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_elasticsearch_service.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

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