Share your portal product with a portal owner in API Gateway - Amazon API Gateway
ConsiderationsShare your portal product
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Share your portal product with a portal owner in API Gateway

As a product owner, you can share your product with a portal owner in another Amazon Web Services account using Amazon RAM. You maintain full control of all product pages and product REST endpoint pages.

Considerations

The following considerations might impact how you share portal products:

  • You can share or unshare your portal products at any time. If you unshare a portal product while it's being used in a published portal, the portal owner won't be able to view the portal product, view any updates made to it, or republish or preview the portal until they remove the portal product.

  • You can view the portal products that you've shared with other accounts.

  • You can't modify any portals that contain your portal product, unless you create the portal yourself.

Share your portal product

The following procedure shows how to create a resource share.

Amazon Web Services Management Console

To use the Amazon Web Services Management Console, see Creating a resource share in Amazon RAM in the Amazon RAM User Guide.

For Select resource type, choose API Gateway Product.

Amazon CLI

The following create-resource-share creates a resource share for your private custom domain name. It can take a few minutes for the resource and principal associations to complete. For principals, provide an account ID or an Organizations ID, such as arn:aws:organizations::123456789012:organization/o-1234abcd. You can provide multiple principals for your resource share.

aws ram create-resource-share \ 
 --region us-west-2 \ 
 --name portal-product-resource-share \ 
 --permission-arns arn:aws:ram::aws:permission/AWSRAMDefaultPermissionAPIGatewayDeveloperPortalProduct \ 
 --resource-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \ 
 --principals 222222222222

To unshare your portal product, use Amazon RAM to delete the resource share.

At any time, you can modify the product sharing policy to modify which principals can use your portal products in their portals.

To update the product sharing policy

  1. Sign in to the API Gateway console at https://console.amazonaws.cn/apigateway.

  2. In the main navigation pane, choose Portal products.

  3. Choose a product.

  4. In the Product sharing tab, for Product sharing policy, choose Manage product sharing policy.

  5. If you haven't shared your product before, your product sharing policy will deny all access to other accounts to your portal products. You need to update the policy to allow access for certain accounts to your portal product.

  6. After you have updated your product sharing policy, choose Save changes.