Class: AWS.Rbin

var params = {
  Identifier: 'STRING_VALUE' /* required */
};
rbin.deleteRule(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: {}) —
  • Identifier — (String)

    The unique ID of the retention rule.

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 = {
  Identifier: 'STRING_VALUE' /* required */
};
rbin.getRule(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: {}) —
  • Identifier — (String)

    The unique ID of the retention rule.

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:

    • Identifier — (String)

      The unique ID of the retention rule.

    • Description — (String)

      The retention rule description.

    • ResourceType — (String)

      The resource type retained by the retention rule.

      Possible values include:
      • "EBS_SNAPSHOT"
      • "EC2_IMAGE"
    • RetentionPeriod — (map)

      Information about the retention period for which the retention rule is to retain resources.

      • RetentionPeriodValue — required — (Integer)

        The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

      • RetentionPeriodUnit — required — (String)

        The unit of time in which the retention period is measured. Currently, only DAYS is supported.

        Possible values include:
        • "DAYS"
    • ResourceTags — (Array<map>)

      Information about the resource tags used to identify resources that are retained by the retention rule.

      • ResourceTagKey — required — (String)

        The tag key.

      • ResourceTagValue — (String)

        The tag value.

    • Status — (String)

      The state of the retention rule. Only retention rules that are in the available state retain resources.

      Possible values include:
      • "pending"
      • "available"
    • LockConfiguration — (map)

      Information about the retention rule lock configuration.

      • UnlockDelay — required — (map)

        Information about the retention rule unlock delay.

        • UnlockDelayValue — required — (Integer)

          The unlock delay period, measured in the unit specified for UnlockDelayUnit.

        • UnlockDelayUnit — required — (String)

          The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.

          Possible values include:
          • "DAYS"
    • LockState — (String)

      The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

      Possible values include:
      • "locked"
      • "pending_unlock"
      • "unlocked"
    • LockEndTime — (Date)

      The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceType: EBS_SNAPSHOT | EC2_IMAGE, /* required */
  LockState: locked | pending_unlock | unlocked,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceTags: [
    {
      ResourceTagKey: 'STRING_VALUE', /* required */
      ResourceTagValue: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rbin.listRules(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: {}) —
  • MaxResults — (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

  • NextToken — (String)

    The token for the next page of results.

  • ResourceType — (String)

    The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

    Possible values include:
    • "EBS_SNAPSHOT"
    • "EC2_IMAGE"
  • ResourceTags — (Array<map>)

    Information about the resource tags used to identify resources that are retained by the retention rule.

    • ResourceTagKey — required — (String)

      The tag key.

    • ResourceTagValue — (String)

      The tag value.

  • LockState — (String)

    The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

    Possible values include:
    • "locked"
    • "pending_unlock"
    • "unlocked"

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:

    • Rules — (Array<map>)

      Information about the retention rules.

      • Identifier — (String)

        The unique ID of the retention rule.

      • Description — (String)

        The retention rule description.

      • RetentionPeriod — (map)

        Information about the retention period for which the retention rule is to retain resources.

        • RetentionPeriodValue — required — (Integer)

          The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

        • RetentionPeriodUnit — required — (String)

          The unit of time in which the retention period is measured. Currently, only DAYS is supported.

          Possible values include:
          • "DAYS"
      • LockState — (String)

        The lock state for the retention rule.

        • locked - The retention rule is locked and can't be modified or deleted.

        • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

        • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

        • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

        Possible values include:
        • "locked"
        • "pending_unlock"
        • "unlocked"
    • NextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
rbin.listTagsForResource(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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the retention rule.

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:

    • Tags — (Array<map>)

      Information about the tags assigned to the retention rule.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

Returns:

• (AWS.Request) —

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

var params = {
  Identifier: 'STRING_VALUE', /* required */
  LockConfiguration: { /* required */
    UnlockDelay: { /* required */
      UnlockDelayUnit: DAYS, /* required */
      UnlockDelayValue: 'NUMBER_VALUE' /* required */
    }
  }
};
rbin.lockRule(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: {}) —
  • Identifier — (String)

    The unique ID of the retention rule.

  • LockConfiguration — (map)

    Information about the retention rule lock configuration.

    • UnlockDelay — required — (map)

      Information about the retention rule unlock delay.

      • UnlockDelayValue — required — (Integer)

        The unlock delay period, measured in the unit specified for UnlockDelayUnit.

      • UnlockDelayUnit — required — (String)

        The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.

        Possible values include:
        • "DAYS"

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:

    • Identifier — (String)

      The unique ID of the retention rule.

    • Description — (String)

      The retention rule description.

    • ResourceType — (String)

      The resource type retained by the retention rule.

      Possible values include:
      • "EBS_SNAPSHOT"
      • "EC2_IMAGE"
    • RetentionPeriod — (map)

      Information about the retention period for which the retention rule is to retain resources.

      • RetentionPeriodValue — required — (Integer)

        The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

      • RetentionPeriodUnit — required — (String)

        The unit of time in which the retention period is measured. Currently, only DAYS is supported.

        Possible values include:
        • "DAYS"
    • ResourceTags — (Array<map>)

      Information about the resource tags used to identify resources that are retained by the retention rule.

      • ResourceTagKey — required — (String)

        The tag key.

      • ResourceTagValue — (String)

        The tag value.

    • Status — (String)

      The state of the retention rule. Only retention rules that are in the available state retain resources.

      Possible values include:
      • "pending"
      • "available"
    • LockConfiguration — (map)

      Information about the retention rule lock configuration.

      • UnlockDelay — required — (map)

        Information about the retention rule unlock delay.

        • UnlockDelayValue — required — (Integer)

          The unlock delay period, measured in the unit specified for UnlockDelayUnit.

        • UnlockDelayUnit — required — (String)

          The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.

          Possible values include:
          • "DAYS"
    • LockState — (String)

      The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

      Possible values include:
      • "locked"
      • "pending_unlock"
      • "unlocked"

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
rbin.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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the retention rule.

  • Tags — (Array<map>)

    Information about the tags to assign to the retention rule.

    • Key — required — (String)

      The tag key.

    • Value — required — (String)

      The tag value.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  Identifier: 'STRING_VALUE' /* required */
};
rbin.unlockRule(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: {}) —
  • Identifier — (String)

    The unique ID of the retention rule.

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:

    • Identifier — (String)

      The unique ID of the retention rule.

    • Description — (String)

      The retention rule description.

    • ResourceType — (String)

      The resource type retained by the retention rule.

      Possible values include:
      • "EBS_SNAPSHOT"
      • "EC2_IMAGE"
    • RetentionPeriod — (map)

      Information about the retention period for which the retention rule is to retain resources.

      • RetentionPeriodValue — required — (Integer)

        The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

      • RetentionPeriodUnit — required — (String)

        The unit of time in which the retention period is measured. Currently, only DAYS is supported.

        Possible values include:
        • "DAYS"
    • ResourceTags — (Array<map>)

      Information about the resource tags used to identify resources that are retained by the retention rule.

      • ResourceTagKey — required — (String)

        The tag key.

      • ResourceTagValue — (String)

        The tag value.

    • Status — (String)

      The state of the retention rule. Only retention rules that are in the available state retain resources.

      Possible values include:
      • "pending"
      • "available"
    • LockConfiguration — (map)

      Information about the retention rule lock configuration.

      • UnlockDelay — required — (map)

        Information about the retention rule unlock delay.

        • UnlockDelayValue — required — (Integer)

          The unlock delay period, measured in the unit specified for UnlockDelayUnit.

        • UnlockDelayUnit — required — (String)

          The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.

          Possible values include:
          • "DAYS"
    • LockState — (String)

      The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

      Possible values include:
      • "locked"
      • "pending_unlock"
      • "unlocked"
    • LockEndTime — (Date)

      The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
rbin.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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the retention rule.

  • TagKeys — (Array<String>)

    The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.

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 = {
  Identifier: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  ResourceTags: [
    {
      ResourceTagKey: 'STRING_VALUE', /* required */
      ResourceTagValue: 'STRING_VALUE'
    },
    /* more items */
  ],
  ResourceType: EBS_SNAPSHOT | EC2_IMAGE,
  RetentionPeriod: {
    RetentionPeriodUnit: DAYS, /* required */
    RetentionPeriodValue: 'NUMBER_VALUE' /* required */
  }
};
rbin.updateRule(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: {}) —
  • Identifier — (String)

    The unique ID of the retention rule.

  • RetentionPeriod — (map)

    Information about the retention period for which the retention rule is to retain resources.

    • RetentionPeriodValue — required — (Integer)

      The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

    • RetentionPeriodUnit — required — (String)

      The unit of time in which the retention period is measured. Currently, only DAYS is supported.

      Possible values include:
      • "DAYS"
  • Description — (String)

    The retention rule description.

  • ResourceType — (String)
    Note: This parameter is currently not supported. You can't update a retention rule's resource type after creation.
    Possible values include:
    • "EBS_SNAPSHOT"
    • "EC2_IMAGE"
  • ResourceTags — (Array<map>)

    Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

    You can add the same tag key and value pair to a maximum or five retention rules.

    To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

    • ResourceTagKey — required — (String)

      The tag key.

    • ResourceTagValue — (String)

      The tag value.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Identifier — (String)

      The unique ID of the retention rule.

    • RetentionPeriod — (map)

      Information about the retention period for which the retention rule is to retain resources.

      • RetentionPeriodValue — required — (Integer)

        The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

      • RetentionPeriodUnit — required — (String)

        The unit of time in which the retention period is measured. Currently, only DAYS is supported.

        Possible values include:
        • "DAYS"
    • Description — (String)

      The retention rule description.

    • ResourceType — (String)

      The resource type retained by the retention rule.

      Possible values include:
      • "EBS_SNAPSHOT"
      • "EC2_IMAGE"
    • ResourceTags — (Array<map>)

      Information about the resource tags used to identify resources that are retained by the retention rule.

      • ResourceTagKey — required — (String)

        The tag key.

      • ResourceTagValue — (String)

        The tag value.

    • Status — (String)

      The state of the retention rule. Only retention rules that are in the available state retain resources.

      Possible values include:
      • "pending"
      • "available"
    • LockState — (String)

      The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

      Possible values include:
      • "locked"
      • "pending_unlock"
      • "unlocked"
    • LockEndTime — (Date)

      The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

Returns:

• (AWS.Request) —

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