You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-07-15 01:34:30 +02:00
Main build (Jenkins)
This commit is contained in:
79
docs/en/md/S3/Objects-management/List-objects.mdx
Normal file
79
docs/en/md/S3/Objects-management/List-objects.mdx
Normal file
@ -0,0 +1,79 @@
|
||||
---
|
||||
sidebar_position: 13
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# List objects
|
||||
Gets the list of objects in the selected bucket
|
||||
|
||||
|
||||
|
||||
`Function ListObjects(Val Bucket, Val BasicData, Val Prefix = "", Val PageToken = "", Val Headers = Undefined) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Bucket | --bucket | String | ✔ | Bucket name |
|
||||
| BasicData | --basic | Structure of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
|
||||
| Prefix | --prefix | String | ✖ | Filtering by prefix, if necessary |
|
||||
| PageToken | --ctoken | String | ✖ | Page token if pagination is used |
|
||||
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
|
||||
|
||||
|
||||
Returns: Structure of KeyAndValue - serialized JSON response from storage
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at AWS documentation: [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.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);
|
||||
|
||||
Bucket = "opi-gpbucket3";
|
||||
Result = OPI_S3.ListObjects(Bucket, BasicData);
|
||||
```
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
# JSON data can also be passed as a path to a .json file
|
||||
|
||||
oint s3 ListObjects \
|
||||
--url "storage-155.s3hoster.by" \
|
||||
--access "BRN5RKJE67YCVDZRRQVI" \
|
||||
--secret "***" \
|
||||
--region "BTC" \
|
||||
--bucket "opi-gpbucket3" \
|
||||
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
:: JSON data can also be passed as a path to a .json file
|
||||
|
||||
oint s3 ListObjects ^
|
||||
--url "storage-155.s3hoster.by" ^
|
||||
--access "BRN5RKJE67YCVDZRRQVI" ^
|
||||
--secret "***" ^
|
||||
--region "BTC" ^
|
||||
--bucket "opi-gpbucket3" ^
|
||||
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user