Custom API Action
Use the Custom API Action to make an authenticated custom API request to the AWS S3 REST API. See Amazon S3 Rest API overview
Options
Field | Definition | Type | Required |
---|---|---|---|
Request Type |
These are supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).
|
Dropdown | TRUE |
Region | Region for your Amazon S3 bucket. Choose a region for your Amazon S3 bucket. | Dropdown | TRUE |
Input
Field | Definition | Type | Required |
---|---|---|---|
Request | |||
Bucket |
Name of the bucket to reference in the request. For example: GET /?list-type=2 HTTP/1.1 Host: <Bucket>.s3.amazonaws.com |
String | FALSE |
Relative URL |
URL address on the web server to which you are attempting to interact. Specify the relative URL as /{insert_remaining_URL}. Use a leading slash at the beginning of the relative URL. You can specify query parameters in the relative URL using "?", or specify the query parameters as an object key pair in the Query input. For example, for the AWS S3 API endpoint http://aws.s3.<region>.amazonaws.com/listobjects the relative URL is /listobjects. |
String | TRUE |
Query | Specify any additional query parameters that should be included in object format (key value pairs). | Object | FALSE |
Body |
Specify a request body in JSON format. |
Object | FALSE |
Headers | Specify any headers required in addition to authorization or content-type (these are already handled by this connector). | Object | FALSE |
Output
Field | Definition | Type |
---|---|---|
Response | ||
Status Code | Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:
For a full list of possible status codes, see HTTP status codes. |
Number |
Headers | Detailed context for the status code, unrelated to the output body. Response headers depend on your selected HTTP request option. Not all headers are response headers. This is similar to {"Content-type":"application/json"}. | Object |
Body |
Data returned from your selected HTTP request.
For example, the data from a GET request. |
Object |