Open documentation ↗Overview
<p>This is the <i>Resource Access Manager API Reference</i>. 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. </p> <p>To learn more about RAM, see the following resources:</p> <ul> <li> <p> <a href="http://aws.amazon.com/ram">Resource Access Manager product page</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/ram/latest/userguide/">Resource Access Manager User Guide</a> </p> </li> </ul>
AWS Resource Access Manager is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 34 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2018-01-04
- Endpoints
- 34
- OpenAPI
- Specification ↗
- Spec updated
- 2020-04-23
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /acceptresourceshareinvitation | Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource shar |
| POST | /associateresourceshare | Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive |
| POST | /associateresourcesharepermission | Adds 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 in |
| POST | /createpermission | Creates 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 w |
| POST | /createpermissionversion | <p>Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permi |
| POST | /createresourceshare | <p>Creates a resource share. You can provide a list of the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource |
| DELETE | /deletepermission#permissionArn | Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permissi |
| DELETE | /deletepermissionversion#permissionArn&permissionVersion | <p>Deletes 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 |
| DELETE | /deleteresourceshare#resourceShareArn | <p>Deletes the specified resource share.</p> <important> <p>This doesn't delete any of the resources that were associated with the resource share; it only stops |
| POST | /disassociateresourceshare | Removes the specified principals or resources from participating in the specified resource share. |
| POST | /disassociateresourcesharepermission | Removes a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only i |
| POST | /enablesharingwithawsorganization | <p>Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called <code>AWSServiceRoleForResourceAccess |
| POST | /getpermission | Retrieves the contents of a managed permission in JSON format. |
| POST | /getresourcepolicies | Retrieves the resource policies for the specified resources that you own and have shared. |
| POST | /getresourceshareassociations | Retrieves the lists of resources and principals that associated for resource shares that you own. |
| POST | /getresourceshareinvitations | Retrieves details about invitations that you have received for resource shares. |
| POST | /getresourceshares | Retrieves details about the resource shares that you own or that are shared with you. |
| POST | /listpendinginvitationresources | Lists the resources in a resource share that is shared with you but for which the invitation is still <code>PENDING</code>. That means that you haven't accepted |
| POST | /listpermissionassociations | Lists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource sh |
| POST | /listpermissionversions | Lists the available versions of the specified RAM permission. |
| POST | /listpermissions | Retrieves a list of available RAM permissions that you can use for the supported resource types. |
| POST | /listprincipals | Lists the principals that you are sharing resources with or that are sharing resources with you. |
| POST | /listreplacepermissionassociationswork | Retrieves the current status of the asynchronous tasks performed by RAM when you perform the <a>ReplacePermissionAssociationsWork</a> operation. |
| POST | /listresourcesharepermissions | Lists the RAM permissions that are associated with a resource share. |
| POST | /listresourcetypes | Lists the resource types that can be shared by RAM. |
| POST | /listresources | Lists the resources that you added to a resource share or the resources that are shared with you. |
| POST | /promotepermissioncreatedfrompolicy | <p>When you attach a resource-based policy to a resource, RAM automatically creates a resource share of <code>featureSet</code>=<code>CREATED_FROM_POLICY</code> |
| POST | /promoteresourcesharecreatedfrompolicy#resourceShareArn | <p>When you attach a resource-based policy to a resource, RAM automatically creates a resource share of <code>featureSet</code>=<code>CREATED_FROM_POLICY</code> |
| POST | /rejectresourceshareinvitation | Rejects an invitation to a resource share from another Amazon Web Services account. |
| POST | /replacepermissionassociations | <p>Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target |
| POST | /setdefaultpermissionversion | Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new def |
| POST | /tagresource | <p>Adds 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 |
| POST | /untagresource | Removes the specified tag key and value pairs from the specified resource share or managed permission. |
| POST | /updateresourceshare | Modifies some of the properties of the specified resource share. |
Questions
Does the AWS Resource Access Manager API need an API key?
Yes. The AWS Resource Access Manager API uses API key authentication; the documentation explains how to get credentials.
Does the AWS Resource Access Manager API support HTTPS?
Yes, the AWS Resource Access Manager API is served over HTTPS.
How many endpoints does the AWS Resource Access Manager API have?
Its OpenAPI description lists 34 endpoints in version 2018-01-04. All of them are shown on this page.
What are alternatives to the AWS Resource Access Manager API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).