Skip to main content
Sign in

Creating an extended integration for AWS WorkSpaces assets

  • May 28, 2026 16:20
  • Updated

Let Oomnitza be your single source of truth!

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

This integration describes AWS Workspaces.

AWS WorkSpaces is a cloud-based service provided by Amazon Web Services (AWS) that allows users to access virtual desktops in the cloud. It enables businesses to provision fully managed desktop environments for their users, eliminating the need to manage physical hardware and allowing users to access their desktops from anywhere using various devices like laptops, tablets, or thin clients.

For information on the API used in this integration, refer to AWS API Documentation: Describe Workspaces

Connect Oomnitza and AWS Workspaces 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 creating, terminating or stopping WorkSpaces
    • Workflows for getting, creating and deleting WorkSpace tags

Navigation

small_blue_link.svg Adding the credentials

small_blue_link.svg Creating the asset integration

small_blue_link.svg Creating custom mappings

small_blue_link.svg Creating workflows

Before you start

When you create the integration, you can specify the following:

1. Multiple AWS Regions

Enter a space-separated list of AWS Regions, such as us-east-1 us-west-2. The data received from each region appears as a separate sync session in the Sync Sessions table.

AWS_integration_sync_sessions.PNG

To find your AWS region, refer to Regions, Availability Zones, and Local Zones.

2. Enable Cross-Account access

Select the IAM Roles checkbox to iterate over all AWS accounts with IAM roles. The data received from all iterated roles will be added as one sync session for each region in the Sync Sessions table.

Before you select this option, you must enable cross-account access in your AWS accounts. For further information see Create an IAM user to easily access all your accounts using the AWS console.

Adding the credentials

When you create the integration, you need to add your AWS Access keys to Oomnitza. See Adding your AWS credentials to Oomnitza.

Creating the asset integration

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

  1. In Oomnitza, click Configuration> Integrations> Overview.
  2. Click Block view block_view.PNG
  3. Scroll down to the Extended section for asset integrations.
  4. Click NEW INTEGRATION.
  5. Select the integration in the sidebar.
  6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

Software data

Depending on the asset integration, an option might be available to ingest desktop software information such as the name and version of the software installed on an asset. To view the software information in Oomnitza, you must have the software module. 

Installation types

  • Cloud. Store credentials in the Oomnitza cloud.
  • Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

  • Create & Update. Add and update records.
  • Create only. Add records.
  • Update only. Update records.

Integration details

To review or update the integrations details, click Edit edit_black_pencil_icon.svg.

TipBulb_Icon_small.svg When you edit the Integration details section, you can select the name or names of integration contacts.  Integration contacts will receive an in-app notification and an email, when the integration fails, when the integration fails to complete within 24 hours, or when the scheduled integration fails to run.

  1. Update the integration name.
  2. Select an installation type.
  3. For integration preferences, select an option.
  4. Enter the name of the integration user.  

Credential details

If you selected Cloud as the installation type, choose one of the following options:

  • Select the credentials that were created for the integration.
  • Edit the credentials that were created for the integration.
  • Create new credentials

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

  1. Click Edit edit_black_pencil_icon.svg.
  2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit edit_black_pencil_icon.svg.

 cog_red_dot_small_icon.svg Select Edit integration to add rules for syncing data. small_blue_link.svg Filtering integration results.  

Click SMART MAPPING.

You can add new fields to your integration by selecting Add new field  add_grey_rectangel_icon.svg on the mapping page. 
small_blue_link.svg Creating custom API fields. 

Creating custom mappings

Map AWS fields to Oomnitza fields to get the user information that you need.

If you want to map the AWS Status field to Oomnitza, complete these steps first:

  1. Click Configuration > Data Model > Field Configuration. By default a list of the asset fields are displayed.
  2. Click Add field. 
  3. Name the field AWS Status. 
  4. Click the Dropdown checkbox.
  5. In the Dropdown tab, enter the following options as separate entries: PENDING | AVAILABLE | IMPAIRED | UNHEALTHY | REBOOTING | STARTING | REBUILDING | RESTORING | MAINTENANCE | ADMIN_MAINTENANCE | TERMINATING | TERMINATED | SUSPENDED | UPDATING | STOPPING | STOPPED | ERROR
  6. Click CREATE. 
  7. Return to your integration in the Configuration > Integrations menu.

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

  1. Click Smart Mapping to automatically detect the appropriate mapping fields
  2. Map the Status field to the AWS Status field you created. You can map the fields by:
    • Dragging the source field to the target field on the Oomnitza side 
    • Selecting the dropdown arrow on the source field and choosing an appropriate target field from the list.
  3. Create a custom mapping for the AWS Connect : Region. To do this, complete the following steps:
    1. Select the down arrow on the ID field that you want to map.
    2. Select Add new Oomnitza assets field.
    3. Change the name of the field to AWS Region.
    4. Click CREATE. 
  4. Map the Workspace ID to the Serial Number field and assign a sync key.
  5. Click UPDATE. 

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 following fields to Oomnitza:   

  • Connect: Credentials
  • Connect: Enable Cross-Account
  • Connect: Region

Custom mappings

Bundle ID
Compute Type Name
Computer Name
Connector Sync Time
IP Address
Recycle Mode
Root Volume Size in GB
Running Mode
Running Mode Auto Timeout
*Status
Subnet Id
User Name
User Volume size in GB
Workspace ID

In Oomnitza the field is called Status, but it is returned in the AWS Response as State. For further information, see AWS API Documentation: Workspace

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

small_blue_link.svg If you selected Cloud as the installation type when creating the integration, see Running an extended integration

small_blue_link.svg If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

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 Using the API block. To locate the available presets, enter workspace in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

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

Important
Unlike the integration, these workflows are not enabled for cross-account access. As a result, when performing create, fetch, update, and delete operations, you must use credentials that belong to the target account you intend to work with.

Amazon AWS Start Workspace

This Amazon AWS Start Workspace allows you to start an existing workspace.

The AWS fields Connect:Region and Workspace ID are assumed to be stored in the Oomnitza fields that you mapped in Creating custom mappings. If these fields are mapped differently in your implementation, you need to update your API workflow block to the correct Oomnitza fields. 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 Information tab. Update the aws_region field to the field name in Oomnitza. The field name should be in lower case, and spaces replaced with an underscore, example new_aws_region.
  3. Select the Body tab. Update the serial_number field to the field name in Oomnitza. The field name should be in lower case, and spaces replaced with an underscore.

This preset only works on Workspaces that have a running mode of AutoStop and a state of STOPPED.For further information see StartWorkspaces.

Amazon AWS Reboot Workspace

The Amazon AWS Reboot Workspace allows you to reboot an existing Workspace. You cannot reboot a WorkSpace unless the state is AVAILABLE or UNHEALTHY.For further information see RebootWorkspaces.

Amazon AWS Stop Workspace

The Amazon AWS Stop Workspace allows you to stop an existing Workspace. You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of  AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.For further information see StopWorkspaces.

Amazon AWS Terminate Workspace

The Amazon AWS Terminate Workspace terminates the specified WorkSpaces. You can terminate a WorkSpace that is in any state except SUSPENDED. For further see TerminateWorkspaces.

Important
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact AWS Support before terminating the WorkSpace.

Amazon AWS Workspace Add Tags

This Amazon AWS Workspace Add Tags allows you to add or update a tag for a given workspace. It is recommended that you adhere to the following steps when using this preset:

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Body tab.
  3. Replace myTagFieldName with the tag name in AWS you want to create/update and set Oomnitza_field to the Oomnitza field value you want to reference for this tag.

Note: If the Oomnitza field value is an empty string, this preset sets the value in the value of the tag in AWS to "--EMPTY--".

Amazon AWS Workspace GetTag

This Amazon AWS Workspace GetTag preset allows you to read tags from the workspace and map them to fields within Oomnitza. 

Once you have applied the preset, use the response mapping within the Advanced Mode to do the mapping. To set the response mapping, 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. In the Response field, use a Jinja statement like the following:
 {% set temp = response['TagList']%}{%if (temp is defined) and temp%}{{ temp | selectattr('Key', 'eq', 'myTagField') | map(attribute='Value') | join('') }}{% endif %}

This will map the tag which is named myTagField in AWS to the field you select in the response mapping screen.

The AWS fields Connect:Region and Workspace ID are assumed to be stored in the Oomnitza fields that you mapped in Creating custom mappings. If these fields are mapped differently in your implementation, you can follow steps 1 to 3 in Amazon AWS Start Workspace to update your API workflow block to the correct Oomnitza fields.

Amazon AWS Workspace Delete Tag

This Amazon AWS Workspace Delete Tag allows you to delete a tag for a given workspace.

It is recommended that you adhere to the following steps when using this preset:

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Body tab.
  3. Replace myTagFieldName with the tag name in AWS you want to delete.

For further information see DeleteTags.

articles_icon.svg Reference articles for workflows

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 small_blue_link.svg Getting started for more information.

Related articles

Comments

0 comments

Please sign in to leave a comment.