Class: AWS.RAM

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 – resource shares that your account shares with other accounts

    • OTHER-ACCOUNTS – resource shares that other accounts share with your account

    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.

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.

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.

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.

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 – principals that your account is sharing resources with

    • OTHER-ACCOUNTS – principals that are sharing resources with your account

    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.

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 your account shares with other accounts

    • OTHER-ACCOUNTS – resources that other accounts share with your account

    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.

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.

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.

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

Parameters:

• params (Object) (defaults to: {}) —
  • resourceShareArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • returnValue — (Boolean)

      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.

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.

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.

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.

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.