AWS SDK Wrapper icon

AWS SDK Wrapper

Implements the NPM AWS SDK packages; starts with V2 for all services and migrating to V3 for each service over time.

Overview

This node acts as a generic wrapper for AWS SDK service requests, allowing users to interact with any AWS service supported by the AWS SDK v2. It enables executing various operations on AWS services by specifying the service name, operation, and input parameters dynamically.

A common use case is when you want to perform AWS API calls that are not covered by dedicated n8n nodes or need to access specific AWS service operations directly. For example, you can describe an ACM certificate, list S3 buckets, or invoke Lambda functions by configuring this node accordingly.

Specifically, for the DescribeCertificate operation under the Default resource (which corresponds to the ACM service), this node will call the describeCertificate method of the ACM client to retrieve detailed information about a specified ACM certificate.

Properties

Name Meaning
Region The AWS region where the service request will be sent. Options include all standard AWS regions such as "US East (N. Virginia)", "EU (Frankfurt)", "Asia Pacific (Tokyo)", etc. Defaults to "us-east-1".
Service The AWS service to use for the request. This is a dropdown listing all AWS services supported by the AWS SDK v2, e.g., ACM, S3, Lambda, EC2, etc. Defaults to "S3".
Version for ACM The API version to use for the ACM service. For ACM, only "2015-12-08" is available. This property is shown only if the selected service is ACM.
Request Has Input Boolean flag indicating whether the request requires input parameters. For operations like listBuckets which do not require input, this should be set to false. Defaults to true.
Request Input JSON string representing the input parameters for the AWS SDK operation. This must be correctly formatted according to the AWS SDK API for the chosen operation. Only shown if "Request Has Input" is true.

Output

The node outputs an array of items, each containing a json field with the response from the AWS SDK operation. For the DescribeCertificate operation, the output JSON will contain the detailed description of the specified ACM certificate as returned by the AWS SDK's describeCertificate method.

If the operation returns binary data (not typical for DescribeCertificate), it would be included in the output accordingly, but this operation primarily returns JSON metadata.

Dependencies

  • Requires valid AWS credentials with appropriate permissions for the selected service and operation.
  • Uses AWS SDK for JavaScript v2 internally.
  • The node expects the user to provide correct input parameters in JSON format matching the AWS SDK API specification.
  • No additional environment variables are explicitly required beyond AWS credentials.

Troubleshooting

  • Invalid Service Error: If the specified service name does not match any AWS SDK service, the node throws an error stating the service is invalid. Ensure the service name matches exactly one of the AWS SDK v2 service names.
  • Invalid Operation Error: If the operation name is not valid for the selected service, an error is thrown. Verify the operation name corresponds to a valid method of the AWS SDK service client.
  • Credential Errors: If AWS credentials are missing or incomplete (missing access key or secret), the node will throw an error. Make sure to configure valid AWS credentials with necessary permissions.
  • Malformed Input: The Request Input JSON must be well-formed and conform to the expected input structure for the AWS operation. Invalid JSON or incorrect parameters will cause the AWS SDK call to fail.
  • No Input Required: For operations that do not require input parameters, set "Request Has Input" to false to avoid parsing errors.
  • API Version Mismatch: Selecting an unsupported API version for a service may cause failures. Use the default or recommended versions unless you have a specific reason to change.

Links and References

Discussion