Getting Started with AWS S3
Install the Package
Run the following command from your project directory to install the package from npm:
npm install apimatic-aws-s3-sdk@1.0.0
For additional package details, see the Npm page for the apimatic-aws-s3-sdk@1.0.0 npm.
Test the SDK
To validate the functionality of this SDK, you can execute all tests located in the test
directory. This SDK utilizes Jest
as both the testing framework and test runner.
To run the tests, navigate to the root directory of the SDK and execute the following command:
npm run test
Or you can also run tests with coverage report:
npm run test:coverage
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
environment | Environment | The API environment. Default: Environment.Production |
timeout | number | Timeout for API calls. Default: 0 |
httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. |
unstableHttpClientOptions | any | Unstable configurable http client options. |
The API client can be initialized as follows:
import { Client, Environment } from 'apimatic-aws-s3-sdk';
const client = new Client({
timeout: 0,
environment: Environment.Production,
});
List of APIs
SDK Infrastructure
Configuration
HTTP
Utilities