You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.RAM

Inherits:

AWS.Service

Object
AWS.Service
AWS.RAM

show all

Identifier:: ram

API Version:: 2018-01-04

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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 across Amazon Web Services accounts and within your organization or organizational units (OUs) in Organizations. For supported resource types, you can also share resources with IAM roles and IAM users. If you have multiple Amazon Web Services accounts, you can use RAM to share those resources with other accounts.

To learn more about RAM, see the following resources:

Sending a Request Using RAM

var ram = new AWS.RAM();
ram.acceptResourceShareInvitation(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the RAM object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ram = new AWS.RAM({apiVersion: '2018-01-04'});

You can also set the API version globally in AWS.config.apiVersions using the ram service identifier:

AWS.config.apiVersions = {
  ram: '2018-01-04',
  // other service API versions
};

var ram = new AWS.RAM();

Version:

2018-01-04

Constructor Summary collapse

new AWS.RAM(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

acceptResourceShareInvitation(params = {}, callback) ⇒ AWS.Request
Accepts an invitation to a resource share from another Amazon Web Services account.

.
associateResourceShare(params = {}, callback) ⇒ AWS.Request
Associates the specified resource share with the specified principals and resources.

.
associateResourceSharePermission(params = {}, callback) ⇒ AWS.Request
Associates a permission with a resource share.

.
createResourceShare(params = {}, callback) ⇒ AWS.Request
Creates a resource share.
deleteResourceShare(params = {}, callback) ⇒ AWS.Request
Deletes the specified resource share.

.
disassociateResourceShare(params = {}, callback) ⇒ AWS.Request
Disassociates the specified principals or resources from the specified resource share.

.
disassociateResourceSharePermission(params = {}, callback) ⇒ AWS.Request
Disassociates an RAM permission from a resource share.

.
enableSharingWithAwsOrganization(params = {}, callback) ⇒ AWS.Request
Enables resource sharing within your organization in Organizations.

The caller must be the master account for the organization.
.
getPermission(params = {}, callback) ⇒ AWS.Request
Gets the contents of an RAM permission in JSON format.

.
getResourcePolicies(params = {}, callback) ⇒ AWS.Request
Gets the policies for the specified resources that you own and have shared.

.
getResourceShareAssociations(params = {}, callback) ⇒ AWS.Request
Gets the resources or principals for the resource shares that you own.

.
getResourceShareInvitations(params = {}, callback) ⇒ AWS.Request
Gets the invitations that you have received for resource shares.

.
getResourceShares(params = {}, callback) ⇒ AWS.Request
Gets the resource shares that you own or the resource shares that are shared with you.

.
listPendingInvitationResources(params = {}, callback) ⇒ AWS.Request
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.

.
listPermissions(params = {}, callback) ⇒ AWS.Request
Lists the RAM permissions.

.
listPrincipals(params = {}, callback) ⇒ AWS.Request
Lists the principals that you have shared resources with or that have shared resources with you.

.
listResources(params = {}, callback) ⇒ AWS.Request
Lists the resources that you added to a resource shares or the resources that are shared with you.

.
listResourceSharePermissions(params = {}, callback) ⇒ AWS.Request
Lists the RAM permissions that are associated with a resource share.

.
listResourceTypes(params = {}, callback) ⇒ AWS.Request
Lists the shareable resource types supported by RAM.

.
promoteResourceShareCreatedFromPolicy(params = {}, callback) ⇒ AWS.Request
Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in RAM.

Use this API action to promote the resource share.
rejectResourceShareInvitation(params = {}, callback) ⇒ AWS.Request
Rejects an invitation to a resource share from another Amazon Web Services account.

.
tagResource(params = {}, callback) ⇒ AWS.Request
Adds the specified tags to the specified resource share that you own.

.
untagResource(params = {}, callback) ⇒ AWS.Request
Removes the specified tags from the specified resource share that you own.

.
updateResourceShare(params = {}, callback) ⇒ AWS.Request
Updates the specified resource share that you own.

.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.RAM(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a RAM object

var ram = new AWS.RAM({apiVersion: '2018-01-04'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.RAM.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.RAM.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.RAM.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptResourceShareInvitation(params = {}, callback) ⇒ `AWS.Request`

Accepts an invitation to a resource share from another Amazon Web Services account.

Service Reference:

AcceptResourceShareInvitation

Examples:

Calling the acceptResourceShareInvitation operation

var params = {
  resourceShareInvitationArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
ram.acceptResourceShareInvitation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareInvitationArn — (String)
  The Amazon Resource Name (ARN) of the invitation.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceShareInvitation — (map)
    Information about the invitation.
    
    resourceShareInvitationArn — (String)
    The Amazon Resource Name (ARN) of the invitation.
    
    resourceShareName — (String)
    The name of the resource share.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    senderAccountId — (String)
    The ID of the Amazon Web Services account that sent the invitation.
    
    receiverAccountId — (String)
    The ID of the Amazon Web Services account that received the invitation.
    
    invitationTimestamp — (Date)
    The date and time when the invitation was sent.
    
    status — (String)
    The status of the invitation.
    Possible values include:
    
    "PENDING"
    
    "ACCEPTED"
    
    "REJECTED"
    
    "EXPIRED"
    
    resourceShareAssociations — (Array<map>)
    To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    resourceShareName — (String)
    The name of the resource share.
    
    associatedEntity — (String)
    The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
    
    An Amazon Web Services account ID
    
    An ARN of an organization in Organizations
    
    An ARN of an organizational unit (OU) in Organizations
    
    An ARN of an IAM role
    
    An ARN of an IAM user
    
    associationType — (String)
    The association type.
    Possible values include:
    
    "PRINCIPAL"
    
    "RESOURCE"
    
    status — (String)
    The status of the association.
    Possible values include:
    
    "ASSOCIATING"
    
    "ASSOCIATED"
    
    "FAILED"
    
    "DISASSOCIATING"
    
    "DISASSOCIATED"
    
    statusMessage — (String)
    A message about the status of the association.
    
    creationTime — (Date)
    The time when the association was created.
    
    lastUpdatedTime — (Date)
    The time when the association was last updated.
    
    external — (Boolean)
    Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
    
    receiverArn — (String)
    The Amazon Resource Name (ARN) of the IAM user or IAM role that received the invitation.
  - clientToken — (String)
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

associateResourceShare(params = {}, callback) ⇒ `AWS.Request`

Associates the specified resource share with the specified principals and resources.

Service Reference:

AssociateResourceShare

Examples:

Calling the associateResourceShare operation

var params = {
  resourceShareArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  principals: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceArns: [
    'STRING_VALUE',
    /* more items */
  ]
};
ram.associateResourceShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share.
- resourceArns — (Array<String>)
  The Amazon Resource Names (ARNs) of the resources.
- principals — (Array<String>)
  The principals to associate with the resource share. The possible values are:
  - An Amazon Web Services account ID
  - An Amazon Resource Name (ARN) of an organization in Organizations
  - An ARN of an organizational unit (OU) in Organizations
  - An ARN of an IAM role
  - An ARN of an IAM user
  Note: Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceShareAssociations — (Array<map>)
    Information about the associations.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    resourceShareName — (String)
    The name of the resource share.
    
    associatedEntity — (String)
    The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
    
    An Amazon Web Services account ID
    
    An ARN of an organization in Organizations
    
    An ARN of an organizational unit (OU) in Organizations
    
    An ARN of an IAM role
    
    An ARN of an IAM user
    
    associationType — (String)
    The association type.
    Possible values include:
    
    "PRINCIPAL"
    
    "RESOURCE"
    
    status — (String)
    The status of the association.
    Possible values include:
    
    "ASSOCIATING"
    
    "ASSOCIATED"
    
    "FAILED"
    
    "DISASSOCIATING"
    
    "DISASSOCIATED"
    
    statusMessage — (String)
    A message about the status of the association.
    
    creationTime — (Date)
    The time when the association was created.
    
    lastUpdatedTime — (Date)
    The time when the association was last updated.
    
    external — (Boolean)
    Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
  - clientToken — (String)
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

associateResourceSharePermission(params = {}, callback) ⇒ `AWS.Request`

Associates a permission with a resource share.

Service Reference:

AssociateResourceSharePermission

Examples:

Calling the associateResourceSharePermission operation

var params = {
  permissionArn: 'STRING_VALUE', /* required */
  resourceShareArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  permissionVersion: 'NUMBER_VALUE',
  replace: true || false
};
ram.associateResourceSharePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share.
- permissionArn — (String)
  The Amazon Resource Name (ARN) of the RAM permission to associate with the resource share.
- replace — (Boolean)
  Indicates whether the permission should replace the permissions that are currently associated with the resource share. Use true to replace the current permissions. Use false to add the permission to the current permission.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- permissionVersion — (Integer)
  The version of the RAM permissions to associate with the resource share.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - returnValue — (Boolean)
    Indicates whether the request succeeded.
  - clientToken — (String)
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createResourceShare(params = {}, callback) ⇒ `AWS.Request`

Creates a resource share. You must provide a list of the Amazon Resource Names (ARNs) for the resources you want to share. You must also specify who you want to share the resources with, and the permissions that you grant them.

Note: Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

Service Reference:

CreateResourceShare

Examples:

Calling the createResourceShare operation

var params = {
  name: 'STRING_VALUE', /* required */
  allowExternalPrincipals: true || false,
  clientToken: 'STRING_VALUE',
  permissionArns: [
    'STRING_VALUE',
    /* more items */
  ],
  principals: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceArns: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ram.createResourceShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- name — (String)
  The name of the resource share.
- resourceArns — (Array<String>)
  The ARNs of the resources to associate with the resource share.
- principals — (Array<String>)
  The principals to associate with the resource share. The possible values are:
  - An Amazon Web Services account ID
  - An Amazon Resource Name (ARN) of an organization in Organizations
  - An ARN of an organizational unit (OU) in Organizations
  - An ARN of an IAM role
  - An ARN of an IAM user
  Note: Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.
- tags — (Array<map>)
  One or more tags.
  - key — (String)
    The key of the tag.
  - value — (String)
    The value of the tag.
- allowExternalPrincipals — (Boolean)
  Indicates whether principals outside your organization in Organizations can be associated with a resource share.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- permissionArns — (Array<String>)
  The Amazon Resource Names (ARNs) of the permissions to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. Only one permission can be associated with each resource type in a resource share.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceShare — (map)
    Information about the resource share.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    name — (String)
    The name of the resource share.
    
    owningAccountId — (String)
    The ID of the Amazon Web Services account that owns the resource share.
    
    allowExternalPrincipals — (Boolean)
    Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    
    status — (String)
    The status of the resource share.
    Possible values include:
    
    "PENDING"
    
    "ACTIVE"
    
    "FAILED"
    
    "DELETING"
    
    "DELETED"
    
    statusMessage — (String)
    A message about the status of the resource share.
    
    tags — (Array<map>)
    The tags for the resource share.
    
    key — (String)
    The key of the tag.
    
    value — (String)
    The value of the tag.
    
    creationTime — (Date)
    The time when the resource share was created.
    
    lastUpdatedTime — (Date)
    The time when the resource share was last updated.
    
    featureSet — (String)
    Indicates how the resource share was created. Possible values include:
    
    CREATED_FROM_POLICY - Indicates that the resource share was created from an Amazon Web Services Identity and Access Management (Amazon Web Services IAM) policy attached to a resource. These resource shares are visible only to the Amazon Web Services account that created it. They cannot be modified in RAM.
    
    PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy.
    
    STANDARD - Indicates that the resource share was created in RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in RAM.
    
    Possible values include:
    
    "CREATED_FROM_POLICY"
    
    "PROMOTING_TO_STANDARD"
    
    "STANDARD"
  - clientToken — (String)
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteResourceShare(params = {}, callback) ⇒ `AWS.Request`

Deletes the specified resource share.

Service Reference:

DeleteResourceShare

Examples:

Calling the deleteResourceShare operation

var params = {
  resourceShareArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
ram.deleteResourceShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - returnValue — (Boolean)
    Indicates whether the request succeeded.
  - clientToken — (String)
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

disassociateResourceShare(params = {}, callback) ⇒ `AWS.Request`

Disassociates the specified principals or resources from the specified resource share.

Service Reference:

DisassociateResourceShare

Examples:

Calling the disassociateResourceShare operation

var params = {
  resourceShareArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  principals: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceArns: [
    'STRING_VALUE',
    /* more items */
  ]
};
ram.disassociateResourceShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share.
- resourceArns — (Array<String>)
  The Amazon Resource Names (ARNs) of the resources.
- principals — (Array<String>)
  The principals.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceShareAssociations — (Array<map>)
    Information about the associations.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    resourceShareName — (String)
    The name of the resource share.
    
    associatedEntity — (String)
    The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
    
    An Amazon Web Services account ID
    
    An ARN of an organization in Organizations
    
    An ARN of an organizational unit (OU) in Organizations
    
    An ARN of an IAM role
    
    An ARN of an IAM user
    
    associationType — (String)
    The association type.
    Possible values include:
    
    "PRINCIPAL"
    
    "RESOURCE"
    
    status — (String)
    The status of the association.
    Possible values include:
    
    "ASSOCIATING"
    
    "ASSOCIATED"
    
    "FAILED"
    
    "DISASSOCIATING"
    
    "DISASSOCIATED"
    
    statusMessage — (String)
    A message about the status of the association.
    
    creationTime — (Date)
    The time when the association was created.
    
    lastUpdatedTime — (Date)
    The time when the association was last updated.
    
    external — (Boolean)
    Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
  - clientToken — (String)
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

disassociateResourceSharePermission(params = {}, callback) ⇒ `AWS.Request`

Disassociates an RAM permission from a resource share.

Service Reference:

DisassociateResourceSharePermission

Examples:

Calling the disassociateResourceSharePermission operation

var params = {
  permissionArn: 'STRING_VALUE', /* required */
  resourceShareArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
ram.disassociateResourceSharePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share.
- permissionArn — (String)
  The Amazon Resource Name (ARN) of the permission to disassociate from the resource share.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - returnValue — (Boolean)
    Indicates whether the request succeeded.
  - clientToken — (String)
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

enableSharingWithAwsOrganization(params = {}, callback) ⇒ `AWS.Request`

Enables resource sharing within your organization in Organizations.

The caller must be the master account for the organization.

Service Reference:

EnableSharingWithAwsOrganization

Examples:

Calling the enableSharingWithAwsOrganization operation

var params = {
};
ram.enableSharingWithAwsOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {})

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - returnValue — (Boolean)
    Indicates whether the request succeeded.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getPermission(params = {}, callback) ⇒ `AWS.Request`

Gets the contents of an RAM permission in JSON format.

Service Reference:

GetPermission

Examples:

Calling the getPermission operation

var params = {
  permissionArn: 'STRING_VALUE', /* required */
  permissionVersion: 'NUMBER_VALUE'
};
ram.getPermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- permissionArn — (String)
  The Amazon Resource Name (ARN) of the permission.
- permissionVersion — (Integer)
  The identifier for the version of the permission.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - permission — (map)
    Information about the permission.
    
    arn — (String)
    The Amazon Resource Name (ARN) of the permission.
    
    version — (String)
    The identifier for the version of the permission.
    
    defaultVersion — (Boolean)
    Specifies whether the version of the permission is set to the default version for this permission.
    
    name — (String)
    The name of the permission.
    
    resourceType — (String)
    The resource type to which the permission applies.
    
    permission — (String)
    The permission's effect and actions in JSON format. The effect indicates whether the actions are allowed or denied. The actions list the API actions to which the principal is granted or denied access.
    
    creationTime — (Date)
    The date and time when the permission was created.
    
    lastUpdatedTime — (Date)
    The date and time when the permission was last updated.
    
    isResourceTypeDefault — (Boolean)
    Specifies whether the version of the permission is set to the default version for this resource type.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getResourcePolicies(params = {}, callback) ⇒ `AWS.Request`

Gets the policies for the specified resources that you own and have shared.

Service Reference:

GetResourcePolicies

Examples:

Calling the getResourcePolicies operation

var params = {
  resourceArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  principal: 'STRING_VALUE'
};
ram.getResourcePolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArns — (Array<String>)
  The Amazon Resource Names (ARNs) of the resources.
- principal — (String)
  The principal.
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - policies — (Array<String>)
    A key policy document, in JSON format.
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getResourceShareAssociations(params = {}, callback) ⇒ `AWS.Request`

Gets the resources or principals for the resource shares that you own.

Service Reference:

GetResourceShareAssociations

Examples:

Calling the getResourceShareAssociations operation

var params = {
  associationType: PRINCIPAL | RESOURCE, /* required */
  associationStatus: ASSOCIATING | ASSOCIATED | FAILED | DISASSOCIATING | DISASSOCIATED,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  principal: 'STRING_VALUE',
  resourceArn: 'STRING_VALUE',
  resourceShareArns: [
    'STRING_VALUE',
    /* more items */
  ]
};
ram.getResourceShareAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- associationType — (String)
  The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share.
  Possible values include:
  - "PRINCIPAL"
  - "RESOURCE"
- resourceShareArns — (Array<String>)
  The Amazon Resource Names (ARN) of the resource shares.
- resourceArn — (String)
  The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL.
- principal — (String)
  The principal. You cannot specify this parameter if the association type is RESOURCE.
- associationStatus — (String)
  The association status.
  Possible values include:
  - "ASSOCIATING"
  - "ASSOCIATED"
  - "FAILED"
  - "DISASSOCIATING"
  - "DISASSOCIATED"
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceShareAssociations — (Array<map>)
    Information about the associations.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    resourceShareName — (String)
    The name of the resource share.
    
    associatedEntity — (String)
    The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
    
    An Amazon Web Services account ID
    
    An ARN of an organization in Organizations
    
    An ARN of an organizational unit (OU) in Organizations
    
    An ARN of an IAM role
    
    An ARN of an IAM user
    
    associationType — (String)
    The association type.
    Possible values include:
    
    "PRINCIPAL"
    
    "RESOURCE"
    
    status — (String)
    The status of the association.
    Possible values include:
    
    "ASSOCIATING"
    
    "ASSOCIATED"
    
    "FAILED"
    
    "DISASSOCIATING"
    
    "DISASSOCIATED"
    
    statusMessage — (String)
    A message about the status of the association.
    
    creationTime — (Date)
    The time when the association was created.
    
    lastUpdatedTime — (Date)
    The time when the association was last updated.
    
    external — (Boolean)
    Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getResourceShareInvitations(params = {}, callback) ⇒ `AWS.Request`

Gets the invitations that you have received for resource shares.

Service Reference:

GetResourceShareInvitations

Examples:

Calling the getResourceShareInvitations operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resourceShareArns: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceShareInvitationArns: [
    'STRING_VALUE',
    /* more items */
  ]
};
ram.getResourceShareInvitations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareInvitationArns — (Array<String>)
  The Amazon Resource Names (ARN) of the invitations.
- resourceShareArns — (Array<String>)
  The Amazon Resource Names (ARN) of the resource shares.
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceShareInvitations — (Array<map>)
    Information about the invitations.
    
    resourceShareInvitationArn — (String)
    The Amazon Resource Name (ARN) of the invitation.
    
    resourceShareName — (String)
    The name of the resource share.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    senderAccountId — (String)
    The ID of the Amazon Web Services account that sent the invitation.
    
    receiverAccountId — (String)
    The ID of the Amazon Web Services account that received the invitation.
    
    invitationTimestamp — (Date)
    The date and time when the invitation was sent.
    
    status — (String)
    The status of the invitation.
    Possible values include:
    
    "PENDING"
    
    "ACCEPTED"
    
    "REJECTED"
    
    "EXPIRED"
    
    resourceShareAssociations — (Array<map>)
    To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    resourceShareName — (String)
    The name of the resource share.
    
    associatedEntity — (String)
    The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
    
    An Amazon Web Services account ID
    
    An ARN of an organization in Organizations
    
    An ARN of an organizational unit (OU) in Organizations
    
    An ARN of an IAM role
    
    An ARN of an IAM user
    
    associationType — (String)
    The association type.
    Possible values include:
    
    "PRINCIPAL"
    
    "RESOURCE"
    
    status — (String)
    The status of the association.
    Possible values include:
    
    "ASSOCIATING"
    
    "ASSOCIATED"
    
    "FAILED"
    
    "DISASSOCIATING"
    
    "DISASSOCIATED"
    
    statusMessage — (String)
    A message about the status of the association.
    
    creationTime — (Date)
    The time when the association was created.
    
    lastUpdatedTime — (Date)
    The time when the association was last updated.
    
    external — (Boolean)
    Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
    
    receiverArn — (String)
    The Amazon Resource Name (ARN) of the IAM user or IAM role that received the invitation.
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getResourceShares(params = {}, callback) ⇒ `AWS.Request`

Gets the resource shares that you own or the resource shares that are shared with you.

Service Reference:

GetResourceShares

Examples:

Calling the getResourceShares operation

var params = {
  resourceOwner: SELF | OTHER-ACCOUNTS, /* required */
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  permissionArn: 'STRING_VALUE',
  resourceShareArns: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceShareStatus: PENDING | ACTIVE | FAILED | DELETING | DELETED,
  tagFilters: [
    {
      tagKey: 'STRING_VALUE',
      tagValues: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
ram.getResourceShares(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArns — (Array<String>)
  The Amazon Resource Names (ARNs) of the resource shares.
- resourceShareStatus — (String)
  The status of the resource share.
  Possible values include:
  - "PENDING"
  - "ACTIVE"
  - "FAILED"
  - "DELETING"
  - "DELETED"
- resourceOwner — (String)
  The type of owner.
  Possible values include:
  - "SELF"
  - "OTHER-ACCOUNTS"
- name — (String)
  The name of the resource share.
- tagFilters — (Array<map>)
  One or more tag filters.
  - tagKey — (String)
    The tag key.
  - tagValues — (Array<String>)
    The tag values.
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
- permissionArn — (String)
  The Amazon Resource Name (ARN) of the RAM permission that is associated with the resource share.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceShares — (Array<map>)
    Information about the resource shares.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    name — (String)
    The name of the resource share.
    
    owningAccountId — (String)
    The ID of the Amazon Web Services account that owns the resource share.
    
    allowExternalPrincipals — (Boolean)
    Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    
    status — (String)
    The status of the resource share.
    Possible values include:
    
    "PENDING"
    
    "ACTIVE"
    
    "FAILED"
    
    "DELETING"
    
    "DELETED"
    
    statusMessage — (String)
    A message about the status of the resource share.
    
    tags — (Array<map>)
    The tags for the resource share.
    
    key — (String)
    The key of the tag.
    
    value — (String)
    The value of the tag.
    
    creationTime — (Date)
    The time when the resource share was created.
    
    lastUpdatedTime — (Date)
    The time when the resource share was last updated.
    
    featureSet — (String)
    Indicates how the resource share was created. Possible values include:
    
    CREATED_FROM_POLICY - Indicates that the resource share was created from an Amazon Web Services Identity and Access Management (Amazon Web Services IAM) policy attached to a resource. These resource shares are visible only to the Amazon Web Services account that created it. They cannot be modified in RAM.
    
    PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy.
    
    STANDARD - Indicates that the resource share was created in RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in RAM.
    
    Possible values include:
    
    "CREATED_FROM_POLICY"
    
    "PROMOTING_TO_STANDARD"
    
    "STANDARD"
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listPendingInvitationResources(params = {}, callback) ⇒ `AWS.Request`

Lists the resources in a resource share that is shared with you but that the invitation is still pending for.

Service Reference:

ListPendingInvitationResources

Examples:

Calling the listPendingInvitationResources operation

var params = {
  resourceShareInvitationArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ram.listPendingInvitationResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareInvitationArn — (String)
  The Amazon Resource Name (ARN) of the invitation.
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resources — (Array<map>)
    Information about the resources included the resource share.
    
    arn — (String)
    The Amazon Resource Name (ARN) of the resource.
    
    type — (String)
    The resource type.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    resourceGroupArn — (String)
    The Amazon Resource Name (ARN) of the resource group. This value is returned only if the resource is a resource group.
    
    status — (String)
    The status of the resource.
    Possible values include:
    
    "AVAILABLE"
    
    "ZONAL_RESOURCE_INACCESSIBLE"
    
    "LIMIT_EXCEEDED"
    
    "UNAVAILABLE"
    
    "PENDING"
    
    statusMessage — (String)
    A message about the status of the resource.
    
    creationTime — (Date)
    The time when the resource was associated with the resource share.
    
    lastUpdatedTime — (Date)
    The time when the association was last updated.
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listPermissions(params = {}, callback) ⇒ `AWS.Request`

Lists the RAM permissions.

Service Reference:

ListPermissions

Examples:

Calling the listPermissions operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resourceType: 'STRING_VALUE'
};
ram.listPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceType — (String)
  Specifies the resource type for which to list permissions. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet.
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - permissions — (Array<map>)
    Information about the permissions.
    
    arn — (String)
    The Amazon Resource Name (ARN) of the permission.
    
    version — (String)
    The identifier for the version of the permission.
    
    defaultVersion — (Boolean)
    Specifies whether the version of the permission is set to the default version for this permission.
    
    name — (String)
    The name of the permission.
    
    resourceType — (String)
    The type of resource to which the permission applies.
    
    status — (String)
    The current status of the permission.
    
    creationTime — (Date)
    The date and time when the permission was created.
    
    lastUpdatedTime — (Date)
    The date and time when the permission was last updated.
    
    isResourceTypeDefault — (Boolean)
    Specifies whether the version of the permission is set to the default version for this resource type.
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listPrincipals(params = {}, callback) ⇒ `AWS.Request`

Lists the principals that you have shared resources with or that have shared resources with you.

Service Reference:

ListPrincipals

Examples:

Calling the listPrincipals operation

var params = {
  resourceOwner: SELF | OTHER-ACCOUNTS, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  principals: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceArn: 'STRING_VALUE',
  resourceShareArns: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceType: 'STRING_VALUE'
};
ram.listPrincipals(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceOwner — (String)
  The type of owner.
  Possible values include:
  - "SELF"
  - "OTHER-ACCOUNTS"
- resourceArn — (String)
  The Amazon Resource Name (ARN) of the resource.
- principals — (Array<String>)
  The principals.
- resourceType — (String)
  The resource type.
  
  Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan
- resourceShareArns — (Array<String>)
  The Amazon Resource Names (ARN) of the resource shares.
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - principals — (Array<map>)
    The principals.
    
    id — (String)
    The ID of the principal.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    creationTime — (Date)
    The time when the principal was associated with the resource share.
    
    lastUpdatedTime — (Date)
    The time when the association was last updated.
    
    external — (Boolean)
    Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listResources(params = {}, callback) ⇒ `AWS.Request`

Lists the resources that you added to a resource shares or the resources that are shared with you.

Service Reference:

ListResources

Examples:

Calling the listResources operation

var params = {
  resourceOwner: SELF | OTHER-ACCOUNTS, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  principal: 'STRING_VALUE',
  resourceArns: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceShareArns: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceType: 'STRING_VALUE'
};
ram.listResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceOwner — (String)
  The type of owner.
  Possible values include:
  - "SELF"
  - "OTHER-ACCOUNTS"
- principal — (String)
  The principal.
- resourceType — (String)
  The resource type.
  
  Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan
- resourceArns — (Array<String>)
  The Amazon Resource Names (ARNs) of the resources.
- resourceShareArns — (Array<String>)
  The Amazon Resource Names (ARN) of the resource shares.
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resources — (Array<map>)
    Information about the resources.
    
    arn — (String)
    The Amazon Resource Name (ARN) of the resource.
    
    type — (String)
    The resource type.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    resourceGroupArn — (String)
    The Amazon Resource Name (ARN) of the resource group. This value is returned only if the resource is a resource group.
    
    status — (String)
    The status of the resource.
    Possible values include:
    
    "AVAILABLE"
    
    "ZONAL_RESOURCE_INACCESSIBLE"
    
    "LIMIT_EXCEEDED"
    
    "UNAVAILABLE"
    
    "PENDING"
    
    statusMessage — (String)
    A message about the status of the resource.
    
    creationTime — (Date)
    The time when the resource was associated with the resource share.
    
    lastUpdatedTime — (Date)
    The time when the association was last updated.
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listResourceSharePermissions(params = {}, callback) ⇒ `AWS.Request`

Lists the RAM permissions that are associated with a resource share.

Service Reference:

ListResourceSharePermissions

Examples:

Calling the listResourceSharePermissions operation

var params = {
  resourceShareArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ram.listResourceSharePermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share.
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - permissions — (Array<map>)
    The permissions associated with the resource share.
    
    arn — (String)
    The Amazon Resource Name (ARN) of the permission.
    
    version — (String)
    The identifier for the version of the permission.
    
    defaultVersion — (Boolean)
    Specifies whether the version of the permission is set to the default version for this permission.
    
    name — (String)
    The name of the permission.
    
    resourceType — (String)
    The type of resource to which the permission applies.
    
    status — (String)
    The current status of the permission.
    
    creationTime — (Date)
    The date and time when the permission was created.
    
    lastUpdatedTime — (Date)
    The date and time when the permission was last updated.
    
    isResourceTypeDefault — (Boolean)
    Specifies whether the version of the permission is set to the default version for this resource type.
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listResourceTypes(params = {}, callback) ⇒ `AWS.Request`

Lists the shareable resource types supported by RAM.

Service Reference:

ListResourceTypes

Examples:

Calling the listResourceTypes operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ram.listResourceTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- nextToken — (String)
  The token for the next page of results.
- maxResults — (Integer)
  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceTypes — (Array<map>)
    The shareable resource types supported by RAM.
    
    resourceType — (String)
    The shareable resource types.
    
    serviceName — (String)
    The name of the Amazon Web Services services to which the resources belong.
  - nextToken — (String)
    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

promoteResourceShareCreatedFromPolicy(params = {}, callback) ⇒ `AWS.Request`

Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in RAM.

Use this API action to promote the resource share. When you promote the resource share, it becomes:

Visible to all principals that it is shared with.
Modifiable in RAM.

Service Reference:

PromoteResourceShareCreatedFromPolicy

Examples:

Calling the promoteResourceShareCreatedFromPolicy operation

var params = {
  resourceShareArn: 'STRING_VALUE' /* required */
};
ram.promoteResourceShareCreatedFromPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share to promote.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - returnValue — (Boolean)
    Indicates whether the request succeeded.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

rejectResourceShareInvitation(params = {}, callback) ⇒ `AWS.Request`

Rejects an invitation to a resource share from another Amazon Web Services account.

Service Reference:

RejectResourceShareInvitation

Examples:

Calling the rejectResourceShareInvitation operation

var params = {
  resourceShareInvitationArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
ram.rejectResourceShareInvitation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareInvitationArn — (String)
  The Amazon Resource Name (ARN) of the invitation.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceShareInvitation — (map)
    Information about the invitation.
    
    resourceShareInvitationArn — (String)
    The Amazon Resource Name (ARN) of the invitation.
    
    resourceShareName — (String)
    The name of the resource share.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    senderAccountId — (String)
    The ID of the Amazon Web Services account that sent the invitation.
    
    receiverAccountId — (String)
    The ID of the Amazon Web Services account that received the invitation.
    
    invitationTimestamp — (Date)
    The date and time when the invitation was sent.
    
    status — (String)
    The status of the invitation.
    Possible values include:
    
    "PENDING"
    
    "ACCEPTED"
    
    "REJECTED"
    
    "EXPIRED"
    
    resourceShareAssociations — (Array<map>)
    To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    resourceShareName — (String)
    The name of the resource share.
    
    associatedEntity — (String)
    The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
    
    An Amazon Web Services account ID
    
    An ARN of an organization in Organizations
    
    An ARN of an organizational unit (OU) in Organizations
    
    An ARN of an IAM role
    
    An ARN of an IAM user
    
    associationType — (String)
    The association type.
    Possible values include:
    
    "PRINCIPAL"
    
    "RESOURCE"
    
    status — (String)
    The status of the association.
    Possible values include:
    
    "ASSOCIATING"
    
    "ASSOCIATED"
    
    "FAILED"
    
    "DISASSOCIATING"
    
    "DISASSOCIATED"
    
    statusMessage — (String)
    A message about the status of the association.
    
    creationTime — (Date)
    The time when the association was created.
    
    lastUpdatedTime — (Date)
    The time when the association was last updated.
    
    external — (Boolean)
    Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
    
    receiverArn — (String)
    The Amazon Resource Name (ARN) of the IAM user or IAM role that received the invitation.
  - clientToken — (String)
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ `AWS.Request`

Adds the specified tags to the specified resource share that you own.

Service Reference:

TagResource

Examples:

Calling the tagResource operation

var params = {
  resourceShareArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ram.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share.
- tags — (Array<map>)
  One or more tags.
  - key — (String)
    The key of the tag.
  - value — (String)
    The value of the tag.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ `AWS.Request`

Removes the specified tags from the specified resource share that you own.

Service Reference:

UntagResource

Examples:

Calling the untagResource operation

var params = {
  resourceShareArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ram.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share.
- tagKeys — (Array<String>)
  The tag keys of the tags to remove.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateResourceShare(params = {}, callback) ⇒ `AWS.Request`

Updates the specified resource share that you own.

Service Reference:

UpdateResourceShare

Examples:

Calling the updateResourceShare operation

var params = {
  resourceShareArn: 'STRING_VALUE', /* required */
  allowExternalPrincipals: true || false,
  clientToken: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
ram.updateResourceShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceShareArn — (String)
  The Amazon Resource Name (ARN) of the resource share.
- name — (String)
  The name of the resource share.
- allowExternalPrincipals — (Boolean)
  Indicates whether principals outside your organization in Organizations can be associated with a resource share.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - resourceShare — (map)
    Information about the resource share.
    
    resourceShareArn — (String)
    The Amazon Resource Name (ARN) of the resource share.
    
    name — (String)
    The name of the resource share.
    
    owningAccountId — (String)
    The ID of the Amazon Web Services account that owns the resource share.
    
    allowExternalPrincipals — (Boolean)
    Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    
    status — (String)
    The status of the resource share.
    Possible values include:
    
    "PENDING"
    
    "ACTIVE"
    
    "FAILED"
    
    "DELETING"
    
    "DELETED"
    
    statusMessage — (String)
    A message about the status of the resource share.
    
    tags — (Array<map>)
    The tags for the resource share.
    
    key — (String)
    The key of the tag.
    
    value — (String)
    The value of the tag.
    
    creationTime — (Date)
    The time when the resource share was created.
    
    lastUpdatedTime — (Date)
    The time when the resource share was last updated.
    
    featureSet — (String)
    Indicates how the resource share was created. Possible values include:
    
    CREATED_FROM_POLICY - Indicates that the resource share was created from an Amazon Web Services Identity and Access Management (Amazon Web Services IAM) policy attached to a resource. These resource shares are visible only to the Amazon Web Services account that created it. They cannot be modified in RAM.
    
    PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy.
    
    STANDARD - Indicates that the resource share was created in RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in RAM.
    
    Possible values include:
    
    "CREATED_FROM_POLICY"
    
    "PROMOTING_TO_STANDARD"
    
    "STANDARD"
  - clientToken — (String)
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.RAM

Overview

Service Description

Sending a Request Using RAM

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.RAM(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

acceptResourceShareInvitation(params = {}, callback) ⇒ AWS.Request

associateResourceShare(params = {}, callback) ⇒ AWS.Request

associateResourceSharePermission(params = {}, callback) ⇒ AWS.Request

createResourceShare(params = {}, callback) ⇒ AWS.Request

deleteResourceShare(params = {}, callback) ⇒ AWS.Request

disassociateResourceShare(params = {}, callback) ⇒ AWS.Request

disassociateResourceSharePermission(params = {}, callback) ⇒ AWS.Request

enableSharingWithAwsOrganization(params = {}, callback) ⇒ AWS.Request

getPermission(params = {}, callback) ⇒ AWS.Request

getResourcePolicies(params = {}, callback) ⇒ AWS.Request

getResourceShareAssociations(params = {}, callback) ⇒ AWS.Request

getResourceShareInvitations(params = {}, callback) ⇒ AWS.Request

getResourceShares(params = {}, callback) ⇒ AWS.Request

listPendingInvitationResources(params = {}, callback) ⇒ AWS.Request

listPermissions(params = {}, callback) ⇒ AWS.Request

listPrincipals(params = {}, callback) ⇒ AWS.Request

listResources(params = {}, callback) ⇒ AWS.Request

listResourceSharePermissions(params = {}, callback) ⇒ AWS.Request

listResourceTypes(params = {}, callback) ⇒ AWS.Request

promoteResourceShareCreatedFromPolicy(params = {}, callback) ⇒ AWS.Request

rejectResourceShareInvitation(params = {}, callback) ⇒ AWS.Request

tagResource(params = {}, callback) ⇒ AWS.Request

untagResource(params = {}, callback) ⇒ AWS.Request

updateResourceShare(params = {}, callback) ⇒ AWS.Request

new AWS.RAM(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

acceptResourceShareInvitation(params = {}, callback) ⇒ `AWS.Request`

associateResourceShare(params = {}, callback) ⇒ `AWS.Request`

associateResourceSharePermission(params = {}, callback) ⇒ `AWS.Request`

createResourceShare(params = {}, callback) ⇒ `AWS.Request`

deleteResourceShare(params = {}, callback) ⇒ `AWS.Request`

disassociateResourceShare(params = {}, callback) ⇒ `AWS.Request`

disassociateResourceSharePermission(params = {}, callback) ⇒ `AWS.Request`

enableSharingWithAwsOrganization(params = {}, callback) ⇒ `AWS.Request`

getPermission(params = {}, callback) ⇒ `AWS.Request`

getResourcePolicies(params = {}, callback) ⇒ `AWS.Request`

getResourceShareAssociations(params = {}, callback) ⇒ `AWS.Request`

getResourceShareInvitations(params = {}, callback) ⇒ `AWS.Request`

getResourceShares(params = {}, callback) ⇒ `AWS.Request`

listPendingInvitationResources(params = {}, callback) ⇒ `AWS.Request`

listPermissions(params = {}, callback) ⇒ `AWS.Request`

listPrincipals(params = {}, callback) ⇒ `AWS.Request`

listResources(params = {}, callback) ⇒ `AWS.Request`

listResourceSharePermissions(params = {}, callback) ⇒ `AWS.Request`

listResourceTypes(params = {}, callback) ⇒ `AWS.Request`

promoteResourceShareCreatedFromPolicy(params = {}, callback) ⇒ `AWS.Request`

rejectResourceShareInvitation(params = {}, callback) ⇒ `AWS.Request`

tagResource(params = {}, callback) ⇒ `AWS.Request`

untagResource(params = {}, callback) ⇒ `AWS.Request`

updateResourceShare(params = {}, callback) ⇒ `AWS.Request`