Home

Awesome

Ballerina AWS Marketplace Metering connector

Build Trivy GraalVM Check GitHub Last Commit GitHub Issues

AWS Marketplace Metering Service is a usage and billing service that allows AWS Marketplace sellers to report the usage of their products for billing purposes. This service supports both software-as-a-service (SaaS) products and metering products sold through AWS Marketplace.

The ballerinax/aws.marketplace.mpm package provides APIs to interact with the AWS Marketplace Metering Service, enabling developers to submit usage records, batch meter usage data, and manage metering-related tasks programmatically.

Setup guide

Before using this connector in your Ballerina application, complete the following:

  1. Create an AWS account
  2. Obtain tokens

Quickstart

To use the aws.marketplace.mpm connector in your Ballerina project, modify the .bal file as follows:

Step 1: Import the module

Import the ballerinax/aws.marketplace.mpm module into your Ballerina project.

import ballerinax/aws.marketplace.mpm;

Step 2: Instantiate a new connector

Create a new mpm:Client by providing the access key ID, secret access key, and the region.

configurable string accessKeyId = ?;
configurable string secretAccessKey = ?;

mpm:Client mpm = check new(region = mpm:US_EAST_1, auth = {
    accessKeyId,
    secretAccessKey
});

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

mpm:ResolveCustomerResponse response = check mpm->resolveCustomer("<registration-token>");

Step 4: Run the Ballerina application

Use the following command to compile and run the Ballerina program.

bal run

Build from the source

Setting up the prerequisites

  1. Download and install Java SE Development Kit (JDK) version 17. You can download it from either of the following sources:

    Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.

  2. Download and install Ballerina Swan Lake.

  3. Download and install Docker.

    Note: Ensure that the Docker daemon is running before executing any tests.

  4. Export Github Personal access token with read package permissions as follows,

    export packageUser=<Username>
export packagePAT=<Personal access token>

Build options

Execute the commands below to build from the source.

  1. To build the package:

    ./gradlew clean build

  2. To run the tests:

    ./gradlew clean test

  3. To build the without the tests:

    ./gradlew clean build -x test

  4. To run tests against different environments:

    ./gradlew clean test -Pgroups=<Comma separated groups/test cases>

  5. To debug the package with a remote debugger:

    ./gradlew clean build -Pdebug=<port>

  6. To debug with the Ballerina language:

    ./gradlew clean build -PbalJavaDebug=<port>

  7. Publish the generated artifacts to the local Ballerina Central repository:

    ./gradlew clean build -PpublishToLocalCentral=true

  8. Publish the generated artifacts to the Ballerina Central repository:

    ./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links