label-studio-sdk 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

label_studio_sdk/export_storage/s3/client.py

@@ -66,6 +66,9 @@ class S3Client:
     def create(
         self,
         *,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
@@ -86,6 +89,15 @@ class S3Client:
 
         Parameters
         ----------
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -134,6 +146,9 @@ class S3Client:
             "api/storages/export/s3",
             method="POST",
             json={
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
@@ -156,42 +171,106 @@ class S3Client:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def validate(
-        self, *, request: S3ExportStorage, request_options: typing.Optional[RequestOptions] = None
-    ) -> S3ExportStorage:
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        bucket: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        aws_access_key_id: typing.Optional[str] = OMIT,
+        aws_secret_access_key: typing.Optional[str] = OMIT,
+        aws_session_token: typing.Optional[str] = OMIT,
+        aws_sse_kms_key_id: typing.Optional[str] = OMIT,
+        region_name: typing.Optional[str] = OMIT,
+        s3endpoint: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific S3 export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
         ----------
-        request : S3ExportStorage
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        bucket : typing.Optional[str]
+            S3 bucket name
+
+        prefix : typing.Optional[str]
+            S3 bucket prefix
+
+        aws_access_key_id : typing.Optional[str]
+            AWS_ACCESS_KEY_ID
+
+        aws_secret_access_key : typing.Optional[str]
+            AWS_SECRET_ACCESS_KEY
+
+        aws_session_token : typing.Optional[str]
+            AWS_SESSION_TOKEN
+
+        aws_sse_kms_key_id : typing.Optional[str]
+            AWS SSE KMS Key ID
+
+        region_name : typing.Optional[str]
+            AWS Region
+
+        s3endpoint : typing.Optional[str]
+            S3 Endpoint
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        S3ExportStorage
-
+        None
 
         Examples
         --------
-        from label_studio_sdk import S3ExportStorage
         from label_studio_sdk.client import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.export_storage.s3.validate(
-            request=S3ExportStorage(
-                project=1,
-            ),
-        )
+        client.export_storage.s3.validate()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/s3/validate", method="POST", json=request, request_options=request_options, omit=OMIT
+            "api/storages/export/s3/validate",
+            method="POST",
+            json={
+                "id": id,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "bucket": bucket,
+                "prefix": prefix,
+                "aws_access_key_id": aws_access_key_id,
+                "aws_secret_access_key": aws_secret_access_key,
+                "aws_session_token": aws_session_token,
+                "aws_sse_kms_key_id": aws_sse_kms_key_id,
+                "region_name": region_name,
+                "s3_endpoint": s3endpoint,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(S3ExportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -283,6 +362,9 @@ class S3Client:
         self,
         id: int,
         *,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
@@ -304,6 +386,15 @@ class S3Client:
         id : int
             A unique integer value identifying this s3 export storage.
 
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -354,6 +445,9 @@ class S3Client:
             f"api/storages/export/s3/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
@@ -468,6 +562,9 @@ class AsyncS3Client:
     async def create(
         self,
         *,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
@@ -488,6 +585,15 @@ class AsyncS3Client:
 
         Parameters
         ----------
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -536,6 +642,9 @@ class AsyncS3Client:
             "api/storages/export/s3",
             method="POST",
             json={
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
@@ -558,42 +667,106 @@ class AsyncS3Client:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def validate(
-        self, *, request: S3ExportStorage, request_options: typing.Optional[RequestOptions] = None
-    ) -> S3ExportStorage:
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        bucket: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        aws_access_key_id: typing.Optional[str] = OMIT,
+        aws_secret_access_key: typing.Optional[str] = OMIT,
+        aws_session_token: typing.Optional[str] = OMIT,
+        aws_sse_kms_key_id: typing.Optional[str] = OMIT,
+        region_name: typing.Optional[str] = OMIT,
+        s3endpoint: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific S3 export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
         ----------
-        request : S3ExportStorage
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        bucket : typing.Optional[str]
+            S3 bucket name
+
+        prefix : typing.Optional[str]
+            S3 bucket prefix
+
+        aws_access_key_id : typing.Optional[str]
+            AWS_ACCESS_KEY_ID
+
+        aws_secret_access_key : typing.Optional[str]
+            AWS_SECRET_ACCESS_KEY
+
+        aws_session_token : typing.Optional[str]
+            AWS_SESSION_TOKEN
+
+        aws_sse_kms_key_id : typing.Optional[str]
+            AWS SSE KMS Key ID
+
+        region_name : typing.Optional[str]
+            AWS Region
+
+        s3endpoint : typing.Optional[str]
+            S3 Endpoint
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        S3ExportStorage
-
+        None
 
         Examples
         --------
-        from label_studio_sdk import S3ExportStorage
         from label_studio_sdk.client import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.export_storage.s3.validate(
-            request=S3ExportStorage(
-                project=1,
-            ),
-        )
+        await client.export_storage.s3.validate()
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/s3/validate", method="POST", json=request, request_options=request_options, omit=OMIT
+            "api/storages/export/s3/validate",
+            method="POST",
+            json={
+                "id": id,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "bucket": bucket,
+                "prefix": prefix,
+                "aws_access_key_id": aws_access_key_id,
+                "aws_secret_access_key": aws_secret_access_key,
+                "aws_session_token": aws_session_token,
+                "aws_sse_kms_key_id": aws_sse_kms_key_id,
+                "region_name": region_name,
+                "s3_endpoint": s3endpoint,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(S3ExportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -685,6 +858,9 @@ class AsyncS3Client:
         self,
         id: int,
         *,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
@@ -706,6 +882,15 @@ class AsyncS3Client:
         id : int
             A unique integer value identifying this s3 export storage.
 
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -756,6 +941,9 @@ class AsyncS3Client:
             f"api/storages/export/s3/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,

label_studio_sdk/export_storage/s3/types/s3create_response.py

@@ -8,6 +8,21 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class S3CreateResponse(pydantic_v1.BaseModel):
+    can_delete_objects: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Deletion from storage enabled.
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage description
+    """
+
     project: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
     Project ID

label_studio_sdk/export_storage/s3/types/s3update_response.py

@@ -8,6 +8,21 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class S3UpdateResponse(pydantic_v1.BaseModel):
+    can_delete_objects: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Deletion from storage enabled.
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage description
+    """
+
     project: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
     Project ID