Creating an extended integration for AWS Simple Storage Service (S3) assets

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets and users as data from AWS S3 is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and AWS S3 in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key asset information
• Configurable reports to share information about your assets with your colleagues and management
• Configurable workflows that you can easily create to automate tasks such as:
  • Workflows for getting details about S3 buckets
  • Workflows for getting tags associated with S3 buckets

Navigation

Adding the credentials

Creating the asset integration

Creating custom mappings

Creating workflows

Creating asset workflows with the API block

Amazon AWS S3 get location (region)
Amazon AWS S3 get Bucket size
Amazon AWS S3 get number of objects in the Bucket

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

Oomnitza's AWS S3 integrations allow you to ingest S3 buckets into Oomnitza, trigger actions to get details about S3 buckets, and control these buckets within AWS.

Oomnitza requires AWS Auth based authentication. For further information on how to obtain these credentials, see AWS Authentication.

Adding the credentials

To add AWS credentials to Oomnitza, see Adding AWS credentials.

Creating the asset integration

To configure the integration for the AWS S3 Load, complete the following steps:

1. In Oomnitza, click Configuration>Overview>Integrations.
2. Click Integrations List View .
3. On the Integrations page, scroll down to the Extended section for Assets.
4. Click NEW INTEGRATION.
5. In the New Asset Integration sidebar, click Amazon AWS S3 Bucket Asset Load.
6. To integrate Oomnitza with the Amazon AWS S3 Bucket Asset Load, click APPLY and then click NEXT twice.

On the connect page, complete the following steps to connect the integration:

1. Enter a descriptive name for the integration such as AWS S3 Assets. This name will be displayed on the Integrations page once the setup is complete.
2. Select Cloud as the installation type.
3. From the Credentials list, select the credentials from the Oomnitza vault that you added for the connection. For further information see Adding AWS credentials.
4. From the Integration Preferences list, select Create & Update. 
5. Enter the name of the user of the integration.
6. Click Next.

Creating custom mappings

Map the AWS S3 fields to Oomnitza fields and create custom mappings to get the user information that you need.

For the field mapping, it is recommended to follow these steps:

1. Hardcode the Oomnitza field Asset Type to Virtual Instance. To do this, click on the Asset Type field and select Virtual Instance in the dropdown list. 
2. Set the Oomnitza field Status to Deployed.
3. Hardcode the Oomnitza field AWS Instance Type to S3.
4. Create custom mappings to map any other field that you want to add to Oomnitza:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza assets field.
   3. Change the name of the field.
   4. Click CREATE. 
5. Map the Bucket Name to the Oomnitza Serial Number field, or a similar field. Assign a sync key to the Serial Number field. 
6. Click NEXT. 

Tracking information for asset loads 

When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the Connect: Credentials field to Oomnitza.

Custom mappings

Bucket Name
Connector Sync Time
Creation Date

 Learn more about mapping

When you've completed mapping AWS S3 fields to Oomnitza fields, click NEXT.   

Schedule

By default, data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Configure your schedule.
2. Click FINISH.

Result

A new tile is created for the integration on the Integrations page. 

What to do next

If you want to see what information is collected now, click the tile on the Integrations page and click RUN NOW.

If you want to change the integration settings, you can click a navigation link on the page, such as 4 Mappings, and edit the settings.

Tip
To view the information that is collected about your mobile assets, click Assets. 

Creating workflows

Creating asset workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create workflows with the API block by following the steps in Creating asset workflows with the API block. To locate the available presets, enter S3 in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

• Your AWS Credentials that you created in Adding AWS credentials.

The AWS S3 API block workflow comes with the following presets:

Amazon AWS S3 get location (region)
Amazon AWS S3 get Bucket size
Amazon AWS S3 get number of objects in the Bucket

Important
Due to an issue on AWS side, you can only use bucket names that do not include a dot. For example, having the name "oomnitza.com" will not work for the presets listed below. You can find more information about this issue here.

Amazon AWS S3 get location (region)

This preset allows you to get the location (region) for a given S3 bucket.

This preset requires that you have the bucket name mapped to the Oomnitza serial_number field as mentioned in Creating custom mappings.

To use this preset, you need to use the Advanced Mode to map the response from the API call to the asset variable within Oomnitza. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Response tab.
3. Map an Oomnitza field from the dropdown to the AWS region.

Since the region of a bucket does not change after it has been created, once you create a workflow which is triggered on a new bucket you do not need to use this preset again.

Amazon AWS S3 get Bucket size

This preset allows you to get the size of an S3 bucket in MB.

This preset requires that you have the bucket name mapped to the Oomnitza serial_number field as mentioned in Creating custom mappings.

To use this preset, you need to use the Advanced Mode to map the response from the API call to the asset variable within Oomnitza. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Response tab.
3. Map an Oomnitza field from the dropdown to thebucket size in MB.In case you prefer to have this in GB, simply adjust the Jinja2 query by adding another division by 1024 to it. For further information see Importing and Using Libraries with Jinja2.
4. Map an Oomnitza field from the dropdown to the Last file activity timestamp.

Within this API there is a call to get the bucket size from Amazon metrics. For more information, refer to CloudWatch Metric. This call only works if files have been added or removed from the bucket within the last 30 days. If no files have been added or removed during this period, the API returns an empty response which in turn does not update the mapped field in Oomnitza and returns an API fail on the response mapping, which is expected behavior.

Amazon AWS S3 get number of objects in the Bucket

This preset allows you to get the number of objects (files) of an S3 bucket.

This preset requires that you have the bucket name mapped to the Oomnitza serial_number field as mentioned in Creating custom mappings.

To use this preset, you need to use the Advanced Mode to map the response from the API call to the asset variable within Oomnitza. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Response tab.
3. Map an Oomnitza field from the dropdown to thenumber of objects in bucket.

Within this API there is a call to get the bucket size from Amazon metrics. For more information, refer to CloudWatch Metric. This call only works if files have been added or removed from the bucket within the last 30 days. If no files have been added or removed during this period, the API returns an empty response which in turn does not update the mapped field in Oomnitza and returns an API fail on the response mapping, which is expected behavior.

For further information on workflows see:
 Understanding workflows
 Workflow block overview

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.