Implementation Samples

This section provides code samples for implementing User Agent strings across different programming languages and AWS SDKs. Each sample demonstrates how to configure the User Agent string format APN_1.1/pc_<YOUR-PRODUCT-CODE>$ for AWS services.

Python (boto3)

import boto3
from botocore.config import Config

UA_STRING = "APN_1.1/pc_5ugbbrmu7ud3u5hsipfzug61p$"

# Create a config object with the custom user agent
session_config = Config(user_agent=UA_STRING)

# EC2 client
ec2 = boto3.client('ec2', config=session_config)

# S3 client
s3 = boto3.client('s3', config=session_config)

Java (AWS SDK v2)

import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.ec2.Ec2Client;
import software.amazon.awssdk.services.s3.S3Client;

public class AwsCustomUserAgentExample {
    private static final String UA_STRING = "APN_1.1/pc_5ugbbrmu7ud3u5hsipfzug61p$";
    private static final Region REGION = Region.US_WEST_2;

    public static void main(String[] args) {
        ClientOverrideConfiguration overrideConfig = ClientOverrideConfiguration.builder()
            .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_PREFIX, UA_STRING)
            .build();

        Ec2Client ec2 = Ec2Client.builder()
            .region(REGION)
            .overrideConfiguration(overrideConfig)
            .build();

        S3Client s3 = S3Client.builder()
            .region(REGION)
            .overrideConfiguration(overrideConfig)
            .build();
    }
}

.NET (AWS SDK)

using Amazon;
using Amazon.S3;
using Amazon.Runtime;

class Program
{
    static void Main(string[] args)
    {
        AWSConfigs.UseAlternateUserAgentHeader = true;
        string UA_STRING = "APN_1.1/pc_5ugbbrmu7ud3u5hsipfzug61p$";

        var s3Config = new AmazonS3Config
        {
            RegionEndpoint = RegionEndpoint.USEast2,
        };
        var s3Client = new AmazonS3Client(s3Config);

        s3Client.BeforeRequestEvent += delegate (object sender, RequestEventArgs e)
        {
            if (e is WebServiceRequestEventArgs args)
            {
                args.Headers["User-Agent"] = UA_STRING;
            }
        };
    }
}

Node.js (AWS SDK v3)

const { EC2Client } = require("@aws-sdk/client-ec2");
const { S3Client } = require("@aws-sdk/client-s3");

const PRODUCT_CODE = "5ugbbrmu7ud3u5hsipfzug61p";
const REGION = "us-west-2";

function addPRMUserAgent(client, productCode) {
    client.middlewareStack.add(
        (next) => async (args) => {
            if (!args.request.headers) args.request.headers = {};
            const existing = args.request.headers["User-Agent"] || "";
            const prmUAString = `APN_1.1/pc_${productCode}$`;
            args.request.headers["User-Agent"] = existing 
                ? `${existing} ${prmUAString}`
                : prmUAString;
            return next(args);
        },
        { step: "finalizeRequest", name: "prmUserAgent" }
    );
    return client;
}

const ec2Client = addPRMUserAgent(new EC2Client({ region: REGION }), PRODUCT_CODE);
const s3Client = addPRMUserAgent(new S3Client({ region: REGION }), PRODUCT_CODE);

Go (AWS SDK v2)

package main

import (
    "context"
    "net/http"

    "github.com/aws/aws-sdk-go-v2/config"
    "github.com/aws/aws-sdk-go-v2/service/s3"
)

const UA_STRING = "APN_1.1/pc_5ugbbrmu7ud3u5hsipfzug61p$"

type PRMUserAgentTransport struct {
    Transport http.RoundTripper
}

func (t *PRMUserAgentTransport) RoundTrip(req *http.Request) (*http.Response, error) {
    req.Header.Set("User-Agent", UA_STRING)
    return t.Transport.RoundTrip(req)
}

func main() {
    cfg, _ := config.LoadDefaultConfig(context.TODO(),
        config.WithRegion("us-east-2"),
        config.WithHTTPClient(&http.Client{
            Transport: &PRMUserAgentTransport{
                Transport: http.DefaultTransport,
            },
        }),
    )
    s3Client := s3.NewFromConfig(cfg)
    _ = s3Client
}

Ruby (AWS SDK v3)

require 'aws-sdk-ec2'
require 'aws-sdk-s3'

UA_STRING = 'APN_1.1/pc_5ugbbrmu7ud3u5hsipfzug61p$'
REGION = 'us-west-2'

Aws.config.update({
  region: REGION,
  user_agent_suffix: UA_STRING
})

ec2_client = Aws::EC2::Client.new
s3_client = Aws::S3::Client.new

Terraform

The Terraform AWS provider supports three ways to inject custom User Agent information:

provider_meta is scoped to the declaring module only, ensuring correct attribution without collision when multiple partner modules are used in the same Terraform configuration.

Prerequisites: Terraform >= 1.0 and AWS provider >= 6.27.0 (or AWSCC provider >= 1.67.0).

In your module's terraform block, add the provider_meta "aws" block with the PRM User Agent string:

terraform {
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = ">= 6.27.0"
    }
  }

  provider_meta "aws" {
    user_agent = [
      "APN_1.1/pc_5ugbbrmu7ud3u5hsipfzug61p$",
    ]
  }
}

Replace 5ugbbrmu7ud3u5hsipfzug61p with your actual product code. The $ is a required end delimiter, do not omit it.