Amazon S3 - list objects
Search form
Description - Returns some or all (up to 1000) of the objects in a bucket.
Runtime Class - com.ibi.agents.XDListObjectsAgent
Configuration
This action requires a Amazon S3 Generic as well as the following required parameters.
Parameter Groups
Parameter Type Description * Name string The name of the bucket whose objects are to be listed.
* - denotes required
Parameter Type Description Delimiter: string A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response. Also, see prefix.
Key Marker: string Specifies the key in the bucket that you want to start listing from. Also, see version-id-marker.
* - denotes required
Parameter Type Description Max Results: integer Indicating the maximum number of results to include in the response.
Next Batch: boolean If the result is truncated, this check provides an easy way to continue a truncated object listing and retrieve the next page of results.
Encoding Type: string Requests Amazon S3 to encode the response and specifies the encoding method to use.An object key can contain any Unicode character. However, XML 1.0 parsers cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
Select from one of the following options:
- url
* - denotes required
Parameter Type Description Output Document: string Document returned by object
Select from one of the following options:
- Results Document {result} - Returns the result or status document of the execution.
- Input Document {input} - Returns the input document of the object.
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDListObjectsAgent
Configuration
This action requires a Amazon S3 Generic as well as the following required parameters.
Parameter Groups
Parameter Type Description * Name string The name of the bucket whose objects are to be listed.
* - denotes required
Parameter Type Description Delimiter: string A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response. Also, see prefix.
Key Marker: string Specifies the key in the bucket that you want to start listing from. Also, see version-id-marker.
* - denotes required
Parameter Type Description Max Results: integer Indicating the maximum number of results to include in the response.
Next Batch: boolean If the result is truncated, this check provides an easy way to continue a truncated object listing and retrieve the next page of results.
Encoding Type: string Requests Amazon S3 to encode the response and specifies the encoding method to use.An object key can contain any Unicode character. However, XML 1.0 parsers cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
Select from one of the following options:
- url
* - denotes required
Parameter Type Description Output Document: string Document returned by object
Select from one of the following options:
- Results Document {result} - Returns the result or status document of the execution.
- Input Document {input} - Returns the input document of the object.
* - denotes required
Output Events
Configuration
This action requires a Amazon S3 Generic as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | Name | string | The name of the bucket whose objects are to be listed. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Delimiter: | string | A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response. Also, see prefix. | Key Marker: | string | Specifies the key in the bucket that you want to start listing from. Also, see version-id-marker. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Max Results: | integer | Indicating the maximum number of results to include in the response. | Next Batch: | boolean | If the result is truncated, this check provides an easy way to continue a truncated object listing and retrieve the next page of results. | Encoding Type: | string | Requests Amazon S3 to encode the response and specifies the encoding method to use.An object key can contain any Unicode character. However, XML 1.0 parsers cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
Select from one of the following options:
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Output Document: | string | Document returned by object
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| no_such_bucket | no_such_bucket |
| success | The operation was successful. |
| fail_unreachable | The host was located but cannot be reached. |
| fail_connect | Could not connect to the external system. |
| invalid_version | invalid_version |
| fail_timeout | The operation timed out. |
| no_such_key | no_such_key |
| invalid_accessKey_id | invalid_accessKey_id |