Testing in a sandbox for the AWS Partner Central Channel API - AWS Partner Central
How to use the sandboxTesting AWS actionsAdditional testing notesTesting events in the sandbox environmentGetting help

Testing in a sandbox for the AWS Partner Central Channel API

Accounts in sandbox are not eligible for channel benefits, and are not validated against all program requirements.

How to use the sandbox

To use the sandbox, complete the following steps:

  1. Create an IAM role:

    Create an IAM role in the AWS account linked with your AWS Partner Central account.

  2. Assign Policy:

    Assign the following policy to the IAM role. For more information, see Adding and removing IAM identity permissions.

    {
  "Version": "2012-10-17",		 	 	 
  "Statement": [
    {
      "Sid": "ChannelManagement",
      "Effect": "Allow",
      "Action": [
        "partnercentral:CreateProgramManagementAccount",
        "partnercentral:UpdateProgramManagementAccount",
        "partnercentral:DeleteProgramManagementAccount",
        "partnercentral:ListProgramManagementAccounts",
        "partnercentral:GetProgramManagementAccount",
        "partnercentral:CreateRelationship",
        "partnercentral:UpdateRelationship",
        "partnercentral:DeleteRelationship",
        "partnercentral:GetRelationship",
        "partnercentral:ListRelationships",
        "partnercentral:CreateChannelHandshake",
        "partnercentral:AcceptChannelHandshake",
        "partnercentral:RejectChannelHandshake",
        "partnercentral:CancelChannelHandshake",
        "partnercentral:ListChannelHandshakes"
      ],
      "Resource": "*",
      "Condition": {
        "StringEquals": {
          "partnercentral:Catalog": [
            "Sandbox"
          ]
        }
      }
    },
    {
      "Sid": "TaggingAccess",
      "Effect": "Allow",
      "Action": [
        "partnercentral:TagResource",
        "partnercentral:UntagResource",
        "partnercentral:ListTagsForResource"
      ],
      "Resource": [
        "arn:aws:partnercentral:*:*:catalog/Sandbox/program-management-account/*",
        "arn:aws:partnercentral:*:*:catalog/Sandbox/channel-handshake/*"
      ],
      "Condition": {
        "StringEquals": {
          "partnercentral:Catalog": [
            "Sandbox"
          ]
        }
      }
    }
  ]
}

  3. Use IAM role credentials:

    Use the credentials (secret key and access key) of this IAM role in your solution to perform the API actions.

Testing AWS actions

During the testing phase, it is often necessary to simulate AWS actions. This simulation enables partners to thoroughly test the complete end-to-end flow of their integration with AWS services. Each request includes a catalog parameter, which determines the data environment.

Simulating the creation of a Program Management Account

To simulate the creation of a Program Management Account, in the payload of the CreateProgramManagementAccount action, include "catalog": "Sandbox" in the payload.

For example:

{
  "catalog": "Sandbox",
  "accountId": "123456789012",
  "displayName": "Test PMA Name",
  "clientToken": "123abc456def789ghi",
  "program": "SOLUTION_PROVIDER",
  "tags": [
    {
      "key": "testkey",
      "value": "testvalue"
    }
  ]
}

Simulating updates to a Relationship

To simulate updates on a relationship, use the UpdateRelationship action with "catalog": "Sandbox" in the payload.

For example:

{
  "catalog": "Sandbox",
  "displayName": "Updated Test PMA",
  "identifier": "rs-abc123def456g",
  "programManagementAccountIdentifier": "pma-123abc456def7"
}

Additional testing notes

  1. To test other actions, set "catalog": "Sandbox" in the payload.

  2. To move to production, change the catalog value from Sandbox to AWS.

Testing events in the sandbox environment

Partners can consume events from the sandbox environment to help test the event-based implementations. Set up EventBridge in the same AWS account with rules to listen for sandbox events by specifying catalog: Sandbox in the event details. For more information, see Channel API Events.

Example event rule:

{
  "source": ["aws.partnercentral-channel"],
  "detail": {
    "catalog": ["Sandbox"]
  }
}

Event rules that specify catalog as Sandbox will only match events coming from the sandbox, generated by the actions you perform in the sandbox environment.

Getting help

If you encounter challenges in testing, or if you need to test a specific scenario not covered here, please reach out to support by raising a case through the following steps:

  1. Sign in to the AWS Partner Central with your AWS Partner Network credentials.

  2. On the Support Center for Partner Central, choose Open New Case to log a new case. Complete the fields as follows:

    1. Type of support case: Channel Program

    2. Question regarding: General Program Inquiry

    3. Get specific: Select the most appropriate Channel case type.

    4. Subject: Include a brief description of the request.

    5. Description: Provide a detailed description of issues, questions, errors, and troubleshooting steps.

    6. Attachments: Include logs and screenshots, where applicable.