Amazon Web Services, Inc.

AWS Resource Access Manager

This is the Resource Access Manager API Reference . This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is…

Identity & security#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the Resource Access Manager API Reference . This documentation provides
descriptions and syntax for each of the actions and data types in RAM. RAM is a
service that helps you securely share your Amazon Web Services resources to other Amazon Web Services accounts. If
you use Organizations to manage your accounts, then you can share your resources with your
entire organization or to organizational units (OUs). For supported resource types, you
can also share resources with individual Identity and Access Management (IAM) roles and users.
To learn more about RAM, see the following resources:

Resource Access Manager product page

Resource Access Manager User
Guide

Endpoints 36

  • POSTAccept resource share invitation/acceptresourceshareinvitationAccepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource…
  • POSTAssociate resource share/associateresourceshareAdds the specified list of principals, resources, and source constraints to a resource share. Principals that already have access to this resource share…
  • POSTAssociate resource share permission/associateresourcesharepermissionAdds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type…
  • POSTCreate permission/createpermissionCreates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in…
  • POSTCreate permission version/createpermissionversionCreates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed…
  • POSTCreate resource share/createresourceshareCreates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want…
  • DELETEDelete permission/deletepermission?permissionArn=string&clientToken=stringDeletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed…
  • DELETEDelete permission version/deletepermissionversion?permissionArn=string&permissionVersion=0&clientToken=stringDeletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version…
  • DELETEDelete resource share/deleteresourceshare?resourceShareArn=string&clientToken=stringDeletes the specified resource share. This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of…
  • POSTDisassociate resource share/disassociateresourceshareRemoves the specified principals, resources, or source constraints from participating in the specified resource share.
  • POSTDisassociate resource share permission/disassociateresourcesharepermissionRemoves a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only…
  • POSTEnable sharing with aws organization/enablesharingwithawsorganizationEnables resource sharing within your organization in Organizations. This operation creates a service-linked role called AWSServiceRoleForResourceAccessManager…
  • POSTGet permission/getpermissionRetrieves the contents of a managed permission in JSON format. If the permission has template parameters, you can include the permissionTemplateParameters…
  • POSTGet resource policies/getresourcepoliciesRetrieves the resource policies for the specified resources that you own and have shared. Always check the NextToken response parameter for a null value when…
  • POSTGet resource share associations/getresourceshareassociationsRetrieves the lists of resources and principals that associated for resource shares that you own. Always check the NextToken response parameter for a null…
  • POSTGet resource share invitations/getresourceshareinvitationsRetrieves details about invitations that you have received for resource shares. Always check the NextToken response parameter for a null value when calling a…
  • POSTGet resource shares/getresourcesharesRetrieves details about the resource shares that you own or that are shared with you. Always check the NextToken response parameter for a null value when…
  • POSTList pending invitation resources/listpendinginvitationresourcesLists the resources in a resource share that is shared with you but for which the invitation is still PENDING . That means that you haven't accepted or…
  • POSTList permission associations/listpermissionassociationsLists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource…
  • POSTList permission versions/listpermissionversionsLists the available versions of the specified RAM permission. Always check the NextToken response parameter for a null value when calling a paginated…
  • POSTList permissions/listpermissionsRetrieves a list of available RAM permissions that you can use for the supported resource types. Always check the NextToken response parameter for a null…
  • POSTList principals/listprincipalsLists the principals that you are sharing resources with or that are sharing resources with you. Always check the NextToken response parameter for a null…
  • POSTList replace permission associations work/listreplacepermissionassociationsworkRetrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation. Always check the…
  • POSTList resource share permissions/listresourcesharepermissionsLists the RAM permissions that are associated with a resource share. Always check the NextToken response parameter for a null value when calling a paginated…
  • POSTList resource types/listresourcetypesLists the resource types that can be shared by RAM.
  • POSTList resources/listresourcesLists the resources that you added to a resource share or the resources that are shared with you. Always check the NextToken response parameter for a null…
  • POSTList source associations/listsourceassociationsLists source associations for resource shares. Source associations control which sources can be used with service principals in resource shares. This…
  • POSTPromote permission created from policy/promotepermissioncreatedfrompolicyWhen you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet = CREATED_FROM_POLICY with a managed…
  • POSTPromote resource share created from policy/promoteresourcesharecreatedfrompolicy?resourceShareArn=stringWhen you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet = CREATED_FROM_POLICY with a managed…
  • POSTReject resource share invitation/rejectresourceshareinvitationRejects an invitation to a resource share from another Amazon Web Services account.
  • POSTReplace permission associations/replacepermissionassociationsUpdates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target…
  • POSTSet default permission version/setdefaultpermissionversionDesignates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new…
  • POSTTag resource/tagresourceAdds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource…
  • POSTUntag resource/untagresourceRemoves the specified tag key and value pairs from the specified resource share or managed permission.
  • POSTUpdate permission/updatepermissionUpdates the status of the specified customer managed permission. Setting the status to DEPRECATED prevents new resource share associations. Setting it to…
  • POSTUpdate resource share/updateresourceshareModifies some of the properties of the specified resource share.

API details

Base URL
https://ram.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
36 operations on 36 pathsPOST 33DELETE 3
Description format
AWS Smithy model, API version 2018-01-04

How to test the AWS Resource Access Manager in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Resource Access Manager collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept resource share invitation” (POST /acceptresourceshareinvitation), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Resource Access Manager?

This is the Resource Access Manager API Reference . This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is… It is listed under Identity & security and has 36 endpoints.

Who publishes the AWS Resource Access Manager?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Resource Access Manager?

Requests go to https://ram.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Resource Access Manager?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Resource Access Manager have?

36 operations on 36 paths (33 POST, 3 DELETE).

Is forking the AWS Resource Access Manager free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.