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

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

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.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. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.

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 Resoure Name (ARN) of the invitation that you want to accept.

    • clientToken — (String)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

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)

        An object that contains information about the specified invitation.

        • resourceShareInvitationArn — (String)

          The Amazon Resoure Name (ARN) of the invitation.

        • resourceShareName — (String)

          The name of the resource share.

        • resourceShareArn — (String)

          The Amazon Resoure 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 current 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 Resoure Name (ARN) of the resource share.

          • resourceShareName — (String)

            The name of the resource share.

          • associatedEntity — (String)

            The associated entity. This can be either of the following:

            • For a resource association, this is the Amazon Resoure Name (ARN) of the resource.

            • For principal associations, this is one of the following:

              • The ID of an Amazon Web Services account

              • The Amazon Resoure Name (ARN) of an organization in Organizations

              • The ARN of an organizational unit (OU) in Organizations

              • The ARN of an IAM role

              • The ARN of an IAM user

          • associationType — (String)

            The type of entity included in this association.

            Possible values include:
            • "PRINCIPAL"
            • "RESOURCE"
          • status — (String)

            The current 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 date and time when the association was created.

          • lastUpdatedTime — (Date)

            The date and 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 Resoure Name (ARN) of the IAM user or role that received the invitation.

      • clientToken — (String)

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.

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)

      Specifies the Amazon Resoure Name (ARN) of the resource share that you want to add principals or resources to.

    • resourceArns — (Array<String>)

      Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

    • principals — (Array<String>)

      Specifies a list of principals to whom you want to the resource share. This can be null if you want to add only resources.

      What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

      You can include the following values:

      • An Amazon Web Services account ID, for example: 123456789012

      • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

      • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

      • An ARN of an IAM role, for example: iam::123456789012:role/rolename

      • An ARN of an IAM user, for example: iam::123456789012user/username

      Note: Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
    • clientToken — (String)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

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

        An array of objects that contain information about the associations.

        • resourceShareArn — (String)

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

        • resourceShareName — (String)

          The name of the resource share.

        • associatedEntity — (String)

          The associated entity. This can be either of the following:

          • For a resource association, this is the Amazon Resoure Name (ARN) of the resource.

          • For principal associations, this is one of the following:

            • The ID of an Amazon Web Services account

            • The Amazon Resoure Name (ARN) of an organization in Organizations

            • The ARN of an organizational unit (OU) in Organizations

            • The ARN of an IAM role

            • The ARN of an IAM user

        • associationType — (String)

          The type of entity included in this association.

          Possible values include:
          • "PRINCIPAL"
          • "RESOURCE"
        • status — (String)

          The current 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 date and time when the association was created.

        • lastUpdatedTime — (Date)

          The date and 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)

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.

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)

      Specifies the Amazon Resoure Name (ARN) of the resource share to which you want to add or replace permissions.

    • permissionArn — (String)

      Specifies the Amazon Resoure Name (ARN) of the RAM permission to associate with the resource share. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.

    • replace — (Boolean)

      Specifies whether the specified permission should replace or add to the existing permission associated with the resource share. Use true to replace the current permissions. Use false to add the permission to the current permission. The default value is false.

      Note: A resource share can have only one permission per resource type. If a resource share already has a permission for the specified resource type and you don't set replace to true then the operation returns an error. This helps prevent accidental overwriting of a permission.
    • clientToken — (String)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

    • permissionVersion — (Integer)

      Specifies the version of the RAM permission to associate with the resource share. If you don't specify this parameter, the operation uses the version designated as the default. You can use the ListPermissionVersions operation to discover the available versions of a 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:

      • returnValue — (Boolean)

        A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

      • clientToken — (String)

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

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:

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)

      Specifies the name of the resource share.

    • resourceArns — (Array<String>)

      Specifies a list of one or more ARNs of the resources to associate with the resource share.

    • principals — (Array<String>)

      Specifies a list of one or more principals to associate with the resource share.

      You can include the following values:

      • An Amazon Web Services account ID, for example: 123456789012

      • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

      • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

      • An ARN of an IAM role, for example: iam::123456789012:role/rolename

      • An ARN of an IAM user, for example: iam::123456789012user/username

      Note: Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
    • tags — (Array<map>)

      Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.

      • key — (String)

        The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.

      • value — (String)

        The string value attached to the tag. The value can be an empty string. Key values are case sensitive.

    • allowExternalPrincipals — (Boolean)

      Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of true lets you share with individual Amazon Web Services accounts that are not in your organization. A value of false only has meaning if your account is a member of an Amazon Web Services Organization. The default value is true.

    • clientToken — (String)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

    • permissionArns — (Array<String>)

      Specifies the Amazon Resource Names (ARNs) of the RAM permission 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. You can associate only one permission with each resource type included in 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:

      • resourceShare — (map)

        An object with information about the new resource share.

        • resourceShareArn — (String)

          The Amazon Resoure 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 current 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 tag key and value pairs attached to the resource share.

          • key — (String)

            The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.

          • value — (String)

            The string value attached to the tag. The value can be an empty string. Key values are case sensitive.

        • creationTime — (Date)

          The date and time when the resource share was created.

        • lastUpdatedTime — (Date)

          The date and 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 Identity and Access Management (IAM) resource-based permission policy attached to the resource. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

          • 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 you share the resource share with. You can modify these resource shares in RAM using the console or APIs.

          Possible values include:
          • "CREATED_FROM_POLICY"
          • "PROMOTING_TO_STANDARD"
          • "STANDARD"
      • clientToken — (String)

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes the specified resource share. This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources outside of the Amazon Web Services account that created them.

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)

      Specifies the Amazon Resoure Name (ARN) of the resource share to delete.

    • clientToken — (String)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

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)

        A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

      • clientToken — (String)

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

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)

      Specifies Amazon Resoure Name (ARN) of the resource share that you want to remove resources from.

    • resourceArns — (Array<String>)

      Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals outside of the Amazon Web Services account that created the resources.

    • principals — (Array<String>)

      Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.

      You can include the following values:

      • An Amazon Web Services account ID, for example: 123456789012

      • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

      • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

      • An ARN of an IAM role, for example: iam::123456789012:role/rolename

      • An ARN of an IAM user, for example: iam::123456789012user/username

      Note: Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
    • clientToken — (String)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

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

        An array of objects that contain information about the updated associations for this resource share.

        • resourceShareArn — (String)

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

        • resourceShareName — (String)

          The name of the resource share.

        • associatedEntity — (String)

          The associated entity. This can be either of the following:

          • For a resource association, this is the Amazon Resoure Name (ARN) of the resource.

          • For principal associations, this is one of the following:

            • The ID of an Amazon Web Services account

            • The Amazon Resoure Name (ARN) of an organization in Organizations

            • The ARN of an organizational unit (OU) in Organizations

            • The ARN of an IAM role

            • The ARN of an IAM user

        • associationType — (String)

          The type of entity included in this association.

          Possible values include:
          • "PRINCIPAL"
          • "RESOURCE"
        • status — (String)

          The current 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 date and time when the association was created.

        • lastUpdatedTime — (Date)

          The date and 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)

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

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. Permission changes take effect immediately. You can remove a RAM permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.

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 Resoure Name (ARN) of the resource share from which you want to disassociate a permission.

    • permissionArn — (String)

      The Amazon Resoure Name (ARN) of the permission to disassociate from the resource share. Changes to permissions take effect immediately.

    • clientToken — (String)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

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)

        A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

      • clientToken — (String)

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

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. Calling this operation enables RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in an organization by specifying the organization's ID, or all of the accounts in an organizational unit (OU) by specifying the OU's ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM users and roles.

You must call this operation from an IAM user or role in the organization's management account.

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)

        A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

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:

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)

      Specifies the Amazon Resoure Name (ARN) of the permission whose contents you want to retrieve. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.

    • permissionVersion — (Integer)

      Specifies identifier for the version of the RAM permission to retrieve. If you don't specify this parameter, the operation retrieves the default version.

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)

        An object that contains information about the permission.

        • arn — (String)

          The Amazon Resoure Name (ARN) of this RAM permission.

        • version — (String)

          The version of the permission represented in this structure.

        • defaultVersion — (Boolean)

          Specifies whether the version of the permission represented in this structure is the default version for this permission.

        • name — (String)

          The name of this permission.

        • resourceType — (String)

          The resource type to which this permission applies.

        • permission — (String)

          The permission's effect and actions in JSON format. The effect indicates whether the specified actions are allowed or denied. The actions list the operations 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 represented in this structure is the default version for all resources of this resource type.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

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

      Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.

    • principal — (String)

      Specifies the principal.

    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

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

        An array of resource policy documents in JSON format.

      • nextToken — (String)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves the resource and principal associations for resource shares that you own.

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)

      Specifies whether you want to retrieve the associations that involve a specified resource or principal.

      • PRINCIPAL – list the principals that are associated with the specified resource share.

      • RESOURCE – list the resources that are associated with the specified resource share.

      Possible values include:
      • "PRINCIPAL"
      • "RESOURCE"
    • resourceShareArns — (Array<String>)

      Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.

    • resourceArn — (String)

      Specifies the Amazon Resoure Name (ARN) of the resource whose resource shares you want to retrieve.

      You cannot specify this parameter if the association type is PRINCIPAL.

    • principal — (String)

      Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resoure Name (ARN) of an individual IAM user or role.

      You cannot specify this parameter if the association type is RESOURCE.

    • associationStatus — (String)

      Specifies that you want to retrieve only associations with this status.

      Possible values include:
      • "ASSOCIATING"
      • "ASSOCIATED"
      • "FAILED"
      • "DISASSOCIATING"
      • "DISASSOCIATED"
    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

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

        An array of objects that contain the details about the associations.

        • resourceShareArn — (String)

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

        • resourceShareName — (String)

          The name of the resource share.

        • associatedEntity — (String)

          The associated entity. This can be either of the following:

          • For a resource association, this is the Amazon Resoure Name (ARN) of the resource.

          • For principal associations, this is one of the following:

            • The ID of an Amazon Web Services account

            • The Amazon Resoure Name (ARN) of an organization in Organizations

            • The ARN of an organizational unit (OU) in Organizations

            • The ARN of an IAM role

            • The ARN of an IAM user

        • associationType — (String)

          The type of entity included in this association.

          Possible values include:
          • "PRINCIPAL"
          • "RESOURCE"
        • status — (String)

          The current 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 date and time when the association was created.

        • lastUpdatedTime — (Date)

          The date and 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)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves details about invitations that you have received for resource shares.

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

      Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

    • resourceShareArns — (Array<String>)

      Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)

    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

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

        An array of objects that contain the details about the invitations.

        • resourceShareInvitationArn — (String)

          The Amazon Resoure Name (ARN) of the invitation.

        • resourceShareName — (String)

          The name of the resource share.

        • resourceShareArn — (String)

          The Amazon Resoure 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 current 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 Resoure Name (ARN) of the resource share.

          • resourceShareName — (String)

            The name of the resource share.

          • associatedEntity — (String)

            The associated entity. This can be either of the following:

            • For a resource association, this is the Amazon Resoure Name (ARN) of the resource.

            • For principal associations, this is one of the following:

              • The ID of an Amazon Web Services account

              • The Amazon Resoure Name (ARN) of an organization in Organizations

              • The ARN of an organizational unit (OU) in Organizations

              • The ARN of an IAM role

              • The ARN of an IAM user

          • associationType — (String)

            The type of entity included in this association.

            Possible values include:
            • "PRINCIPAL"
            • "RESOURCE"
          • status — (String)

            The current 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 date and time when the association was created.

          • lastUpdatedTime — (Date)

            The date and 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 Resoure Name (ARN) of the IAM user or role that received the invitation.

      • nextToken — (String)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves details about the resource shares that you own or that are shared with you.

Service Reference:

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

      Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

    • resourceShareStatus — (String)

      Specifies that you want to retrieve details of only those resource shares that have this status.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "FAILED"
      • "DELETING"
      • "DELETED"
    • resourceOwner — (String)

      Specifies that you want to retrieve details of only those resource shares that match the following:

      • SELF – resources that you are sharing

      • OTHER-ACCOUNTS – resources that other accounts share with you

      Possible values include:
      • "SELF"
      • "OTHER-ACCOUNTS"
    • name — (String)

      Specifies the name of an individual resource share that you want to retrieve details about.

    • tagFilters — (Array<map>)

      Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

      • tagKey — (String)

        The tag key. This must have a valid string value and can't be empty.

      • tagValues — (Array<String>)

        A list of zero or more tag values. If no values are provided, then the filter matches any tag with the specified key, regardless of its value.

    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    • permissionArn — (String)

      Specifies that you want to retrieve details of only those resource shares that use the RAM permission with this Amazon Resoure Name (ARN).

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

        An array of objects that contain the information about the resource shares.

        • resourceShareArn — (String)

          The Amazon Resoure 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 current 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 tag key and value pairs attached to the resource share.

          • key — (String)

            The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.

          • value — (String)

            The string value attached to the tag. The value can be an empty string. Key values are case sensitive.

        • creationTime — (Date)

          The date and time when the resource share was created.

        • lastUpdatedTime — (Date)

          The date and 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 Identity and Access Management (IAM) resource-based permission policy attached to the resource. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

          • 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 you share the resource share with. You can modify these resource shares in RAM using the console or APIs.

          Possible values include:
          • "CREATED_FROM_POLICY"
          • "PROMOTING_TO_STANDARD"
          • "STANDARD"
      • nextToken — (String)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

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 for which the invitation is still PENDING. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.

Service Reference:

Examples:

Calling the listPendingInvitationResources operation

var params = {
  resourceShareInvitationArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resourceRegionScope: ALL | REGIONAL | GLOBAL
};
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)

      Specifies the Amazon Resoure Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.

    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    • resourceRegionScope — (String)

      Specifies that you want the results to include only resources that have the specified scope.

      • ALL – the results include both global and regional resources or resource types.

      • GLOBAL – the results include only global resources or resource types.

      • REGIONAL – the results include only regional resources or resource types.

      The default value is ALL.

      Possible values include:
      • "ALL"
      • "REGIONAL"
      • "GLOBAL"

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

        An array of objects that contain the information about the resources included the specified resource share.

        • arn — (String)

          The Amazon Resoure Name (ARN) of the resource.

        • type — (String)

          The resource type. This takes the form of: service-code:resource-code

        • resourceShareArn — (String)

          The Amazon Resoure Name (ARN) of the resource share this resource is associated with.

        • resourceGroupArn — (String)

          The Amazon Resoure Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.

        • status — (String)

          The current 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 date and time when the resource was associated with the resource share.

        • lastUpdatedTime — (Date)

          The date an time when the association was last updated.

        • resourceRegionScope — (String)

          Specifies the scope of visibility of this resource:

          • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

          • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

          Possible values include:
          • "REGIONAL"
          • "GLOBAL"
      • nextToken — (String)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves a list of available RAM permissions that you can use for the supported resource types.

Service Reference:

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 that you want to list permissions for only the specified resource type. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet. You can use the ListResourceTypes operation to get the specific string required.

    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

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

        An array of objects with information about the permissions.

        • arn — (String)

          The Amazon Resoure Name (ARN) of the permission you want information about.

        • version — (String)

          The version of the permission represented in this structure.

        • defaultVersion — (Boolean)

          Specifies whether the version of the permission represented in this structure is the default version for this permission.

        • name — (String)

          The name of this permission.

        • resourceType — (String)

          The type of resource to which this 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 represented in this structure is the default version for all resources of this resource type.

      • nextToken — (String)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the available versions of the specified RAM permission.

Service Reference:

Examples:

Calling the listPermissionVersions operation

var params = {
  permissionArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ram.listPermissionVersions(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)

      Specifies the Amazon Resoure Name (ARN) of the RAM permission whose versions you want to list. You can use the permissionVersion parameter on the AssociateResourceSharePermission operation to specify a non-default version to attach.

    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

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

        An array of objects that contain details for each of the available versions.

        • arn — (String)

          The Amazon Resoure Name (ARN) of the permission you want information about.

        • version — (String)

          The version of the permission represented in this structure.

        • defaultVersion — (Boolean)

          Specifies whether the version of the permission represented in this structure is the default version for this permission.

        • name — (String)

          The name of this permission.

        • resourceType — (String)

          The type of resource to which this 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 represented in this structure is the default version for all resources of this resource type.

      • nextToken — (String)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the principals that you are sharing resources with or that are sharing resources with you.

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)

      Specifies that you want to list information for only resource shares that match the following:

      • SELF – resources that you are sharing

      • OTHER-ACCOUNTS – resources that other accounts share with you

      Possible values include:
      • "SELF"
      • "OTHER-ACCOUNTS"
    • resourceArn — (String)

      Specifies that you want to list principal information for the resource share with the specified Amazon Resoure Name (ARN).

    • principals — (Array<String>)

      Specifies that you want to list information for only the listed principals.

      You can include the following values:

      • An Amazon Web Services account ID, for example: 123456789012

      • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

      • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

      • An ARN of an IAM role, for example: iam::123456789012:role/rolename

      • An ARN of an IAM user, for example: iam::123456789012user/username

      Note: Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
    • resourceType — (String)

      Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

      For a list of valid values, query the ListResourceTypes operation.

    • resourceShareArns — (Array<String>)

      Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

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

        An array of objects that contain the details about the principals.

        • id — (String)

          The ID of the principal.

        • resourceShareArn — (String)

          The Amazon Resoure Name (ARN) of a resource share the principal is associated with.

        • creationTime — (Date)

          The date and time when the principal was associated with the resource share.

        • lastUpdatedTime — (Date)

          The date and 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)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

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:

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 */
  ],
  resourceRegionScope: ALL | REGIONAL | GLOBAL,
  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)

      Specifies that you want to list only the resource shares that match the following:

      • SELF – resources that you are sharing

      • OTHER-ACCOUNTS – resources that other accounts share with you

      Possible values include:
      • "SELF"
      • "OTHER-ACCOUNTS"
    • principal — (String)

      Specifies that you want to list only the resource shares that are associated with the specified principal.

    • resourceType — (String)

      Specifies that you want to list only the resource shares that include resources of the specified resource type.

      For valid values, query the ListResourceTypes operation.

    • resourceArns — (Array<String>)

      Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

    • resourceShareArns — (Array<String>)

      Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    • resourceRegionScope — (String)

      Specifies that you want the results to include only resources that have the specified scope.

      • ALL – the results include both global and regional resources or resource types.

      • GLOBAL – the results include only global resources or resource types.

      • REGIONAL – the results include only regional resources or resource types.

      The default value is ALL.

      Possible values include:
      • "ALL"
      • "REGIONAL"
      • "GLOBAL"

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

        An array of objects that contain information about the resources.

        • arn — (String)

          The Amazon Resoure Name (ARN) of the resource.

        • type — (String)

          The resource type. This takes the form of: service-code:resource-code

        • resourceShareArn — (String)

          The Amazon Resoure Name (ARN) of the resource share this resource is associated with.

        • resourceGroupArn — (String)

          The Amazon Resoure Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.

        • status — (String)

          The current 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 date and time when the resource was associated with the resource share.

        • lastUpdatedTime — (Date)

          The date an time when the association was last updated.

        • resourceRegionScope — (String)

          Specifies the scope of visibility of this resource:

          • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

          • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

          Possible values include:
          • "REGIONAL"
          • "GLOBAL"
      • nextToken — (String)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

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:

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)

      Specifies the Amazon Resoure Name (ARN) of the resource share for which you want to retrieve the associated permissions.

    • nextToken — (String)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

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

        An array of objects that describe the permissions associated with the resource share.

        • arn — (String)

          The Amazon Resoure Name (ARN) of the permission you want information about.

        • version — (String)

          The version of the permission represented in this structure.

        • defaultVersion — (Boolean)

          Specifies whether the version of the permission represented in this structure is the default version for this permission.

        • name — (String)

          The name of this permission.

        • resourceType — (String)

          The type of resource to which this 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 represented in this structure is the default version for all resources of this resource type.

      • nextToken — (String)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the resource types that can be shared by RAM.

Service Reference:

Examples:

Calling the listResourceTypes operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resourceRegionScope: ALL | REGIONAL | GLOBAL
};
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)

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults — (Integer)

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    • resourceRegionScope — (String)

      Specifies that you want the results to include only resources that have the specified scope.

      • ALL – the results include both global and regional resources or resource types.

      • GLOBAL – the results include only global resources or resource types.

      • REGIONAL – the results include only regional resources or resource types.

      The default value is ALL.

      Possible values include:
      • "ALL"
      • "REGIONAL"
      • "GLOBAL"

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

        An array of objects that contain information about the resource types that can be shared using RAM.

        • resourceType — (String)

          The type of the resource.

        • serviceName — (String)

          The name of the Amazon Web Services service to which resources of this type belong.

        • resourceRegionScope — (String)

          Specifies the scope of visibility of resources of this type:

          • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

          • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

          Possible values include:
          • "REGIONAL"
          • "GLOBAL"
      • nextToken — (String)

        If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

When you attach a resource-based permission policy to a resource, it automatically creates a resource share. However, resource shares created this way are visible only to the resource share owner, and the resource share can't be modified in RAM.

You can use this operation to promote the resource share to a full RAM resource share. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.

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: {})

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)

        A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

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:

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)

      Specifies the Amazon Resoure Name (ARN) of the invitation that you want to reject.

    • clientToken — (String)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

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)

        An object that contains the details about the rejected invitation.

        • resourceShareInvitationArn — (String)

          The Amazon Resoure Name (ARN) of the invitation.

        • resourceShareName — (String)

          The name of the resource share.

        • resourceShareArn — (String)

          The Amazon Resoure 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 current 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 Resoure Name (ARN) of the resource share.

          • resourceShareName — (String)

            The name of the resource share.

          • associatedEntity — (String)

            The associated entity. This can be either of the following:

            • For a resource association, this is the Amazon Resoure Name (ARN) of the resource.

            • For principal associations, this is one of the following:

              • The ID of an Amazon Web Services account

              • The Amazon Resoure Name (ARN) of an organization in Organizations

              • The ARN of an organizational unit (OU) in Organizations

              • The ARN of an IAM role

              • The ARN of an IAM user

          • associationType — (String)

            The type of entity included in this association.

            Possible values include:
            • "PRINCIPAL"
            • "RESOURCE"
          • status — (String)

            The current 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 date and time when the association was created.

          • lastUpdatedTime — (Date)

            The date and 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 Resoure Name (ARN) of the IAM user or role that received the invitation.

      • clientToken — (String)

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Adds the specified tag keys and values to the specified resource share. The tags are attached only to the resource share, not to the resources that are in the 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)

      Specifies the Amazon Resoure Name (ARN) of the resource share that you want to add tags to.

    • tags — (Array<map>)

      A list of one or more tag key and value pairs. The tag key must be present and not be an empty string. The tag value must be present but can be an empty string.

      • key — (String)

        The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.

      • value — (String)

        The string value attached to the tag. The value can be an empty string. Key values are case sensitive.

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 tag key and value pairs 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)

      Specifies the Amazon Resoure Name (ARN) of the resource share that you want to remove tags from. The tags are removed from the resource share, not the resources in the resource share.

    • tagKeys — (Array<String>)

      Specifies a list of one or more tag keys that you want 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

Modifies some of the properties of 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)

      Specifies the Amazon Resoure Name (ARN) of the resource share that you want to modify.

    • name — (String)

      If specified, the new name that you want to attach to the resource share.

    • allowExternalPrincipals — (Boolean)

      Specifies whether principals outside your organization in Organizations can be associated with a resource share.

    • clientToken — (String)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

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 Resoure 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 current 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 tag key and value pairs attached to the resource share.

          • key — (String)

            The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.

          • value — (String)

            The string value attached to the tag. The value can be an empty string. Key values are case sensitive.

        • creationTime — (Date)

          The date and time when the resource share was created.

        • lastUpdatedTime — (Date)

          The date and 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 Identity and Access Management (IAM) resource-based permission policy attached to the resource. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

          • 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 you share the resource share with. You can modify these resource shares in RAM using the console or APIs.

          Possible values include:
          • "CREATED_FROM_POLICY"
          • "PROMOTING_TO_STANDARD"
          • "STANDARD"
      • clientToken — (String)

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.