put_object async ¶

async def put_object(
    self,
    body: Body[AsyncIterator[bytes]] | AsyncIterator[bytes] | bytes,
    path: "capo_mediastore_data.types.path_naming.PathNaming",
    *,
    config_overrides: Optional[AsyncMediaStoreDataClientConfig] = None,
    content_type: Optional[
        "capo_mediastore_data.types.content_type.ContentType"
    ] = None,
    cache_control: Optional[
        "capo_mediastore_data.types.string_primitive.StringPrimitive"
    ] = None,
    storage_class: Optional[
        "capo_mediastore_data.types.storage_class.StorageClass"
    ] = None,
    upload_availability: Optional[
        "capo_mediastore_data.types.upload_availability.UploadAvailability"
    ] = None,
) -> "capo_mediastore_data.types.put_object_response.PutObjectResponse":
    r"""<p>Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.</p>

    Args:
        body: <p>The bytes to be stored. </p>
        path: <p>The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name></p> <p>For example, to upload the file <code>mlaw.avi</code> to the folder path <code>premium\canada</code> in the container <code>movies</code>, enter the path <code>premium/canada/mlaw.avi</code>.</p> <p>Do not include the container name in this path.</p> <p>If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing <code>premium/usa</code> subfolder. If you specify <code>premium/canada</code>, the service creates a <code>canada</code> subfolder in the <code>premium</code> folder. You then have two subfolders, <code>usa</code> and <code>canada</code>, in the <code>premium</code> folder. </p> <p>There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.</p> <p>For more information about folders and how they exist in a container, see the <a href="http://docs.aws.amazon.com/mediastore/latest/ug/">AWS Elemental MediaStore User Guide</a>.</p> <p>The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension. </p>
        content_type: <p>The content type of the object.</p>
        cache_control: <p>An optional <code>CacheControl</code> header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9</a>.</p> <p>Headers with a custom user-defined value are also accepted.</p>
        storage_class: <p>Indicates the storage class of a <code>Put</code> request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.</p>
        upload_availability: <p>Indicates the availability of an object while it is still uploading. If the value is set to <code>streaming</code>, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to <code>standard</code>, the object is available for downloading only when it is uploaded completely. The default value for this header is <code>standard</code>.</p> <p>To use this header, you must also set the HTTP <code>Transfer-Encoding</code> header to <code>chunked</code>.</p>

    Raises:
        capo_mediastore_data.errors.container_not_found_exception.ContainerNotFoundException: <p>The specified container was not found for the specified account.</p>
        capo_mediastore_data.errors.internal_server_error.InternalServerError: <p>The service is temporarily unavailable.</p>
        capo_mediastore_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mediastore_data.types.put_object_request.PutObjectRequest]",
    ) -> AsyncOperationResponse[
        "capo_mediastore_data.types.put_object_response.PutObjectResponse"
    ]:
        import capo_mediastore_data._operations.media_store_object_20170901.put_object

        (
            output,
            http_response,
        ) = await capo_mediastore_data._operations.media_store_object_20170901.put_object.async_put_object(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_mediastore_data.types.put_object_request.PutObjectRequest",
    ) -> dict[str, Any]:
        import capo_mediastore_data.types.put_object_request

        return capo_mediastore_data.types.put_object_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutObject", redact_input=_redact_input)
    )
    input_: capo_mediastore_data.types.put_object_request.PutObjectRequest = {
        "body": ensure_async_iterator(body),
        "path": path,
    }
    if content_type is not None:
        input_["content_type"] = content_type
    if cache_control is not None:
        input_["cache_control"] = cache_control
    if storage_class is not None:
        input_["storage_class"] = storage_class
    if upload_availability is not None:
        input_["upload_availability"] = upload_availability

    async with aclosing_bodies(input_):
        response = await aexecute_pipeline(
            AsyncOperationRequest(input=input_, options=options_),
            handler=_handler,
            interceptors=list(interceptors_),
        )
        await response.response.aclose()
        return response.output