AWSConfig is used to configure an AWS service client instance, such as S3Client or SecretsManagerClient. It effectively allows the user to select a region they wish to interact with, and the AWS credentials they wish to use to authenticate.
AWSConfig is included in the aws.js bundle, which includes all the content of the library. It is also included in the various services clients dedicated bundles such as s3.js and secrets-manager.js.
It takes an options object as its single parameter, with the following properties:
|region||string||the AWS region to connect to. As described by Amazon AWS docs|
|accessKeyID||string||The AWS access key ID credential to use for authentication.|
|secretAccessKey||string||The AWS secret access credential to use for authentication.|
|sessionToken (optional)||string||The AWS secret access token to use for authentication.|
|fromEnvironment()||Creates an AWSConfig using the AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN environment variables.|
S3 Client methods will throw errors in case of failure.
|InvalidArgumentException||when an invalid region name or credentials were used.|