Skip to content

describe_object async

describe_object(
    path: PathNaming,
    *,
    config_overrides: Optional[AsyncMediaStoreDataClientConfig] = None,
) -> DescribeObjectResponse

Gets the headers for an object at the specified path.

Parameters:

  • path (PathNaming) –

    The path (including the file name) where the object is stored in the container. Format: //

Raises:

Source code in docs_src/capo_mediastore_data/_services/async_media_store_data.py
async def describe_object(
    self,
    path: "capo_mediastore_data.types.path_naming.PathNaming",
    *,
    config_overrides: Optional[AsyncMediaStoreDataClientConfig] = None,
) -> "capo_mediastore_data.types.describe_object_response.DescribeObjectResponse":
    """<p>Gets the headers for an object at the specified path.</p>

    Args:
        path: <p>The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name></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.object_not_found_exception.ObjectNotFoundException: <p>Could not perform an operation on an object that does not exist.</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.describe_object_request.DescribeObjectRequest]",
    ) -> AsyncOperationResponse[
        "capo_mediastore_data.types.describe_object_response.DescribeObjectResponse"
    ]:
        import capo_mediastore_data._operations.media_store_object_20170901.describe_object

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeObject")
    )
    input_: capo_mediastore_data.types.describe_object_request.DescribeObjectRequest = {
        "path": path
    }

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