AWS Service¶

On this page

Overview
Configuration Parameters
Service Actions
AWS Service Rules
Rule Conditions
- Example
Usage
- Call an AWS Service from a Stitch Function
- Calling an AWS Service from the SDKs
Supported AWS Services

Overview¶

Amazon Web Services (AWS) provides an extensive collection of cloud-based services. Stitch provides a generic AWS service that enables you to connect to many of these services.

Configuration Parameters¶

You will need to provide values for the following parameters when you create an AWS service interface:

Stitch UI
Import/Export

copy

<Service Name>/config.json¶

{
  "name": "<Service Name>",
  "type": "aws",
  "config": {
    "accessKeyId": <Access Key ID>,
    "region": "us-east-1"
  },
  "secret_config": {
    "secretAccessKey": "<Secret Name>"
  }
}

Parameter	Description
Service Name config.name	A unique name for the service.
Access Key ID config.accessKeyId	The access key ID for an AWS IAM user. The user should have programmatic access and appropriate permissions for all AWS services that you plan to interact with.
Secret Access Key secret_config.secretAccessKey	The name of a Secret that stores a secret access key for the IAM user whose ID is specified in Access Key ID. You can find this value next to the Access key ID when you create a new IAM user or create a new access key for an existing IAM user.

Service Actions¶

Each AWS service has different actions that you can perform on that service. Stitch uses the action names specified in the AWS SDK for Go for each service.

Note

Stitch uses the same names (and casing) for the AWS services and actions as the AWS Go SDK.

For each supported AWS service, Stitch supports any action that:

Takes a single input parameter.
Returns one of two objects: an output object, or an error.

For example, the S3 service includes a PutObject action. Stitch supports this action because it takes a single input type of PutObjectInput, and returns either a PutObjectOutput or an error.

AWS Service Rules¶

You must specify rules to enable the AWS services and actions. Each rule applies to a single service API, plus one or all actions on that service. As with other service rules in Stitch, a rule must evaluate to true to enable the action.

For example, the following rule enables all actions on the Kinesis service:

Note

The default value of the When field contains only empty brackets, which means the rule will always evaluate to true, and therefore all calls to the action are valid.

This rule can also be expressed as the following JSON expression. Note that in the array of actions, the asterisk (*) after the service name indicates that all actions of that service are enabled:

copy

{
   "name": "kinesis",
   "actions": [
      "kinesis:*"
   ]
}

Rule Conditions¶

For each service action, the rule you create may include any of the properties of the input object for that action as a condition for validating the rule. The %%args expansion provides access to these properties.

Example¶

`S3 PutObject`¶

The S3 service includes the PutObject action, which takes an input object of type of PutObjectInput. You can reference any of the properties on the PutObjectInput object in a rule’s When expression with the %%args expansion.

Using the Bucket property of the PutObjectInput object, you can create a rule that enables the PutObject action on the S3 service, but restricts the action to a list of approved buckets. In this example, we use a user-defined constant called myS3Buckets for the list of approved bucket names:

This can also be expressed as the following JSON:

copy

{
   "name": "s3",
   "actions": [
      "s3:PutObject"
   ],
   "when": {
      "%%args.Bucket": {
            "%in": "%%values.myS3Buckets"
      }
   }
}

`S3 GetObject`¶

The S3 service includes the GetObject action, which takes an input object of type of GetObjectInput. You can reference any of the properties on the GetObjectInput object in a rule’s When expression with the %%args expansion.

In the following example, we create a rule that enables the GetObject action on a specific bucket called stitchReadWritableBucket:

This can also be expressed as the following JSON:

copy

{
   "name": "s3",
   "actions": [
      "s3:GetObject"
   ],
   "when": {
      "%%args.Bucket": {
            "%in": "stitchReadWritableBucket"
      }
   }
}

Usage¶

You can call an AWS service from a Stitch function and from the SDKs. The following sections show each of these processes.

Call an AWS Service from a Stitch Function¶

The following examples show how to call various AWS services from within a Stitch function. In each example, it is assumed the named service has already been created.

S3 Service¶

`S3 PutObject`¶

copy

exports = async function() {
  const s3 = context.services.get('MyAwsService').s3("us-east-1");
  const result = await s3.PutObject({
    "Bucket": "my-bucket",
    "Key": "example",
    "Body": "hello there"
  });
  console.log(EJSON.stringify(result));
  return result;
};

`S3 GetObject`¶

copy

exports = async function(arg) {
   const s3 = context.services.get('MyAwsService').s3("us-east-1");
   const result = await s3.GetObject({
      "Bucket": "stitchReadWritableBucket",
      "Key": "coffee.jpeg"
   });

   console.log(EJSON.stringify(result));
   return result;
};

`S3 PresignURL`¶

copy

exports = function(){
  const s3 = context.services.get("MyAwsService").s3("us-east-1");
  const presignedUrl = s3.PresignURL({
   "Bucket": "my-s3-bucket-name",
   "Key": "/some/path",
   // HTTP method that is valid for this signed URL. Can use PUT for uploads, or GET for downloads.
   "Method": "GET",
   // Duration of the lifetime of the signed url, in milliseconds
   "ExpirationMS": 30000,
  })
  return presignedUrl
};

Refer to the S3 API Reference for implementation details.

Object Size Limitation

Stitch supports a maximum file size of 4 Megabytes when working with AWS S3 objects.

Kinesis Service¶

copy

exports = async function(event) {
  const kinesis = context.services.get('MyAwsService').kinesis("us-east-1");
  const result = await kinesis.PutRecord({
    Data: JSON.stringify(event.fullDocument),
    StreamName: "stitchStream",
    PartitionKey: "1"
  });
  console.log(EJSON.stringify(result));
  return result;
};

Refer to the Kinesis API Reference for implementation details.

Lambda Service¶

copy

exports = async function() {
  const lambda = context.services.get('MyAwsService').lambda("us-east-1");

  const result = await lambda.Invoke({
    FunctionName: "myLambdaFunction",
    Payload: context.user.id
  });

  console.log(result.Payload.text());
  return EJSON.parse(result.Payload.text());
};

Refer to the Lambda API Reference for implementation details.

SES Service¶

copy

exports = async function(){
  const ses = context.services.get('MyAwsService').ses("us-east-1");
  const result = await ses.SendEmail({
    Source: "sender@example.com",
    Destination: { ToAddresses: ["docs@mongodb.com"] },
    Message: {
      Body: {
        Html: {
          Charset: "UTF-8",
          Data: `This is a message from user ${context.user.id}`
        }
      },
      Subject: {
        Charset: "UTF-8",
        Data: "Test Email Please Ignore"
      }
    }
  });
  console.log(EJSON.stringify(result));
  return result;
};

Refer to the SES API Reference for implementation details.

Calling an AWS Service from the SDKs¶

The following example shows how to configure and call an AWS service (S3 in this case) using the AwsServiceClient factory in each SDK.

JavaScript SDK
Android SDK
iOS SDK

copy

// MyAwsService is the name of the aws service you created in
// the stitch UI, and it is configured with a rule
// that allows the PutObject action on the s3 API
const aws = stitchClient.getServiceClient(AwsServiceClient.factory, "MyAwsService");

// These are the arguments specifically for the s3 service PutObject function
const args = {
   ACL: "public-read",
   Bucket: "this-should-be-a-valid-s3-bucket",
   ContentType: "plain/text",
   Key: "some_key",
   Body: "This is the body of the message I am saving to S3",
   // or Body could be a BSON object
};

const request = new AwsRequest.Builder()
   .withService("s3")
   .withAction("PutObject")
   .withRegion("us-east-1") // this is optional
   .withArgs(args); // depending on the service and action, this may be optional as well

aws.execute(request.build())
   .then(result => {
      // the shape of the result will depend on the AWS function being called
   }).catch(err => {
      // handle failure
   });

copy

// MyAwsService is the name of the aws service you created in
// the stitch UI, and it is configured with a rule
// that allows the PutObject action on the s3 API
final AwsServiceClient aws = stitchClient.getServiceClient(AwsServiceClient.factory, "MyAwsService");

// These are the arguments specifically for s3 service PutObject function
final Document args = new Document()
   .append("Bucket", "this-should-be-a-valid-s3-bucket")
   .append("Key", "some_key")
   .append("ACL", "public-read")
   .append("ContentType", "plain/text")
   .append("Body", "This is the body of the message I am saving to S3");
   //or .append("Body", new BsonBinary(myByteArray));

AwsRequest.Builder request = new AwsRequest.Builder()
   .withService("s3")
   .withAction("PutObject")
   // .withRegion("us-east-1") // this is optional
   .withArguments(args);

// depending on the service and action, this may be optional as well
aws.execute(request.build(), Document.class)
   .addOnCompleteListener(new OnCompleteListener<Document>() {
        @Override
        public void onComplete(@NonNull Task<Document> task) {
            if (task.isSuccessful()) {
                final Document result = task.getResult();
                // the shape of the result will depend on the AWS function being called
            } else {
                // handle failure
            }
        }
    });

copy

// MyAwsService is the name of the aws service you created in
// the stitch UI, and it is configured with a rule
// that allows the PutObject action on the s3 API
let aws = client.serviceClient(fromFactory: awsServiceClientFactory, withName: "MyAwsService")

// These are the arguments specifically for s3 service PutObject function
let args: Document = [
   "Bucket": "this-should-be-a-valid-s3-bucket",
   "Key": "some_key",
   "ACL": "public-read",
   "ContentType": "plain/text",
   "Body": "This is the body of the message I am saving to S3",
   // or "Body": Binary.init(...)
]

let request = try AWSRequestBuilder()
   .with(service: "s3")
   .with(action: "PutObject")
   // .with(region: "us-east-1") // this is optional
   .with(arguments: args) // depending on the service and action, this may be optional as well

aws.execute(request.build()) { (result: StitchResult<Document>) in
   switch result {
   case .success(let awsResult):
      // the shape of the result will depend on the AWS function being called
   case .failure:
      // handle failure
   }
}

Supported AWS Services¶

Your Stitch app can connect to the following AWS services:

Athena
Batch
CloudWatch
Comprehend
EC2
Firehose
Glacier
IOT
Kinesis
Lambda
Lex Runtime Service
Machine Learning
Mobile Analytics
Polly
RDS
Redshift
Rekognition
S3
SES
Step Functions (SFN)
SNS
SQS
Textract

← http.head() AWS S3 Snippets →

AWS Service¶

Overview¶

Configuration Parameters¶

Service Actions¶

AWS Service Rules¶

Rule Conditions¶

Example¶

S3 PutObject¶

S3 GetObject¶

Usage¶

Call an AWS Service from a Stitch Function¶

S3 Service¶

S3 PutObject¶

S3 GetObject¶

S3 PresignURL¶

Kinesis Service¶

Lambda Service¶

SES Service¶

Calling an AWS Service from the SDKs¶

Supported AWS Services¶

`S3 PutObject`¶

`S3 GetObject`¶

`S3 PutObject`¶

`S3 GetObject`¶

`S3 PresignURL`¶