Buckets

BucketsService

Bases: FolderContext, BaseService

Service for managing UiPath storage buckets.

Buckets are cloud storage containers that can be used to store and manage files used by automation processes.

download(bucket_key, blob_file_path, destination_path)

Download a file from a bucket.

Parameters:

Name	Type	Description	Default
bucket_key	str	The key of the bucket	required
blob_file_path	str	The path to the file in the bucket	required
destination_path	str	The local path where the file will be saved	required

retrieve(name)

Retrieve bucket information by its name.

Parameters:

Name	Type	Description	Default
name	str	The name of the bucket to retrieve.	required

Returns:

Name	Type	Description
Response	Any	The HTTP response containing the bucket details, including its ID, name, and configuration.

retrieve_async(name) async

Asynchronously retrieve bucket information by its name.

Parameters:

Name	Type	Description	Default
name	str	The name of the bucket to retrieve.	required

Returns:

Name	Type	Description
Response	Any	The HTTP response containing the bucket details, including its ID, name, and configuration.

retrieve_by_key(key)

Retrieve bucket information by its key.

Parameters:

Name	Type	Description	Default
key	str	The key of the bucket	required

Returns:

Name	Type	Description
Response	Any	The HTTP response containing the bucket details, including its ID, name, and configuration.

retrieve_by_key_async(key) async

Asynchronously retrieve bucket information by its key.

Parameters:

Name	Type	Description	Default
key	str	The key of the bucket	required

Returns:

Name	Type	Description
Response	Any	The HTTP response containing the bucket details, including its ID, name, and configuration.

upload(*, bucket_key=None, bucket_name=None, blob_file_path, content_type, source_path)

Upload a file to a bucket.

Parameters:

Name	Type	Description	Default
bucket_key	Optional[str]	The key of the bucket	None
bucket_name	Optional[str]	The name of the bucket	None
blob_file_path	str	The path where the file will be stored in the bucket	required
content_type	str	The MIME type of the file	required
source_path	str	The local path of the file to upload	required

upload_from_memory(*, bucket_key=None, bucket_name=None, blob_file_path, content_type, content)

Upload content from memory to a bucket.

Parameters:

Name	Type	Description	Default
bucket_key	Optional[str]	The key of the bucket	None
bucket_name	Optional[str]	The name of the bucket	None
blob_file_path	str	The path where the content will be stored in the bucket	required
content_type	str	The MIME type of the content	required
content	Union[str, bytes]	The content to upload (string or bytes)	required