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

Class: AWS.Rbin

Inherits:
AWS.Service show all
Identifier:
rbin
API Version:
2021-06-15
Defined in:
(unknown)

Overview

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

Service Description

This is the Recycle Bin API Reference. This documentation provides descriptions and syntax for each of the actions and data types in Recycle Bin.

Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are deleted, they are retained in the Recycle Bin for a time period that you specify.

You can restore a resource from the Recycle Bin at any time before its retention period expires. After you restore a resource from the Recycle Bin, the resource is removed from the Recycle Bin, and you can then use it in the same way you use any other resource of that type in your account. If the retention period expires and the resource is not restored, the resource is permanently deleted from the Recycle Bin and is no longer available for recovery. For more information about Recycle Bin, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

Sending a Request Using Rbin

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

Locking the API Version

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

var rbin = new AWS.Rbin({apiVersion: '2021-06-15'});

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

AWS.config.apiVersions = {
  rbin: '2021-06-15',
  // other service API versions
};

var rbin = new AWS.Rbin();

Version:

  • 2021-06-15

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Rbin object

var rbin = new AWS.Rbin({apiVersion: '2021-06-15'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Rbin.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Rbin.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Rbin.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

Calling the createRule operation

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

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

    • ResourceType — (String)

      The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

      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.

      • Tags — (Array<map>)

        Information about the tags assigned to the retention rule.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The tag value.

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

Returns:

  • (AWS.Request) —

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

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

Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

Calling the deleteRule operation

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.

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

Gets information about a Recycle Bin retention rule.

Service Reference:

Examples:

Calling the getRule operation

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"

Returns:

  • (AWS.Request) —

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

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

Lists the Recycle Bin retention rules in the Region.

Service Reference:

Examples:

Calling the listRules operation

var params = {
  ResourceType: EBS_SNAPSHOT | EC2_IMAGE, /* required */
  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.

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

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

Lists the tags assigned to a retention rule.

Service Reference:

Examples:

Calling the listTagsForResource operation

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.

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

Assigns tags to the specified retention rule.

Service Reference:

Examples:

Calling the tagResource operation

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.

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

Unassigns a tag from a retention rule.

Service Reference:

Examples:

Calling the untagResource operation

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.

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

Updates an existing Recycle Bin retention rule. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

Calling the updateRule operation

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)

      The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

      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"

Returns:

  • (AWS.Request) —

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