1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2026-05-22 10:05:29 +02:00
Files
OpenIntegrations/docs/en/md/S3/Buckets-managment/Check-bucket-availability.mdx
T
Vitaly the Alpaca (bot) 30fe461abe Main build (Jenkins)
2024-11-14 11:10:08 +03:00

52 lines
1.5 KiB
Plaintext

---
sidebar_position: 3
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Check bucket availability
Checks if the bucket is available for the current account or account by ID
`Function CheckBucketAvailability(Val Name, Val BasicData, Val Directory = True, Val AccountID = "", Val Headers = Undefined) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Name | --name | String | ✔ | Bucket name |
| BasicData | --data | Structure of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
| Directory | --dir | Boolean | ✖ | True > Directory Bucket, False > General Purpose Bucket |
| AccountID | --account | String | ✖ | Account ID to verify that hes the bucket owner |
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
Returns: Map Of KeyAndValue - serialized JSON response from storage
<br/>
:::tip
Method at AWS documentation: [HeadBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
Region = "BTC";
BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
Name = "opi-dirbucket1";
Result = OPI_S3.CheckBucketAvailability(Name, BasicData, True);
Result = OPI_S3.CheckBucketAvailability(Name, BasicData, True, "1234");
```