Class: AWS.RAM

Inherits:
AWS.Service 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

Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resource. The following principals are supported:

  • The ID of an AWS account

  • The Amazon Resource Name (ARN) of an OU from AWS Organizations

  • The Amazon Resource Name (ARN) of an organization from AWS Organizations

If you specify an AWS account that doesn't exist in the same organization as the account that owns the resource share, the owner of the specified account receives an invitation to accept the resource share. After the owner accepts the invitation, they can access the resources in the resource share. An administrator of the specified account can use IAM policies to restrict access resources in the resource share.

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

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

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) —

    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'.

  • 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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • 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.

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 AWS account.

Service Reference:

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 AWS account that sent the invitation.

        • receiverAccountId — (String)

          The ID of the AWS 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>)

          The resources associated with the resource share.

          • resourceShareArn — (String)

            The Amazon Resource Name (ARN) of the resource share.

          • associatedEntity — (String)

            The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

          • 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 as the AWS 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.

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

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

Service Reference:

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 (ARN) 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.

        • associatedEntity — (String)

          The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

        • 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 as the AWS 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.

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

Creates a resource share.

Service Reference:

Examples:

Calling the createResourceShare operation

var params = {
  name: 'STRING_VALUE', /* required */
  allowExternalPrincipals: true || false,
  clientToken: 'STRING_VALUE',
  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 Amazon Resource Names (ARN) of the resources to associate with the resource share.

    • principals — (Array<String>)

      The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.

    • 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 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 AWS account that owns the resource share.

        • allowExternalPrincipals — (Boolean)

          Indicates whether principals outside your organization 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.

      • 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:

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:

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 (ARN) 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.

        • associatedEntity — (String)

          The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

        • 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 as the AWS 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.

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

Enables resource sharing within your organization.

Service Reference:

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.

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

Gets the policies for the specifies resources.

Service Reference:

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 (ARN) 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 associations for the specified resource share.

Service Reference:

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.

      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.

    • principal — (String)

      The principal.

    • associationStatus — (String)

      The status of the association.

      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 association.

        • resourceShareArn — (String)

          The Amazon Resource Name (ARN) of the resource share.

        • associatedEntity — (String)

          The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

        • 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 as the AWS 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 specified invitations for resource sharing.

Service Reference:

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 AWS account that sent the invitation.

        • receiverAccountId — (String)

          The ID of the AWS 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>)

          The resources associated with the resource share.

          • resourceShareArn — (String)

            The Amazon Resource Name (ARN) of the resource share.

          • associatedEntity — (String)

            The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

          • 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 as the AWS 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.

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

Gets the specified resource shares or all of your resource shares.

Service Reference:

Examples:

Calling the getResourceShares operation

var params = {
  resourceOwner: SELF | OTHER-ACCOUNTS, /* required */
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: '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 (ARN) 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.

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 AWS account that owns the resource share.

        • allowExternalPrincipals — (Boolean)

          Indicates whether principals outside your organization 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.

      • 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 with access to the specified resource.

Service Reference:

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.

    • 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 as the AWS 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 the specified principal can access.

Service Reference:

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.

    • resourceArns — (Array<String>)

      The Amazon Resource Names (ARN) 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.

        • status — (String)

          The status of the resource.

          Possible values include:
          • "AVAILABLE"
          • "ZONAL_RESOURCE_INACCESSIBLE"
          • "LIMIT_EXCEEDED"
          • "UNAVAILABLE"
        • 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.

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

Rejects an invitation to a resource share from another AWS account.

Service Reference:

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 AWS account that sent the invitation.

        • receiverAccountId — (String)

          The ID of the AWS 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>)

          The resources associated with the resource share.

          • resourceShareArn — (String)

            The Amazon Resource Name (ARN) of the resource share.

          • associatedEntity — (String)

            The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

          • 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 as the AWS 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.

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

Adds the specified tags to the specified resource share.

Service Reference:

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.

Service Reference:

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.

Service Reference:

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 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 AWS account that owns the resource share.

        • allowExternalPrincipals — (Boolean)

          Indicates whether principals outside your organization 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.

      • 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.