Get Bucket Lifecycle Configuration

s3_get_bucket_lifecycle_configuration

R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by directory buckets.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see get_bucket_lifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

get_bucket_lifecycle_configuration has the following special error:

• Error code: NoSuchLifecycleConfiguration

  • Description: The lifecycle configuration does not exist.

  • HTTP Status Code: 404 Not Found

  • SOAP Fault Code Prefix: Client

The following operations are related to get_bucket_lifecycle_configuration:

• get_bucket_lifecycle

• put_bucket_lifecycle

• delete_bucket_lifecycle

Usage

s3_get_bucket_lifecycle_configuration(Bucket, ExpectedBucketOwner)

Arguments

Bucket

[required] The name of the bucket for which to get the lifecycle information.

ExpectedBucketOwner

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ⁠403 Forbidden⁠ (access denied).

Value

A list with the following syntax:

list(
  Rules = list(
    list(
      Expiration = list(
        Date = as.POSIXct(
          "2015-01-01"
        ),
        Days = 123,
        ExpiredObjectDeleteMarker = TRUE|FALSE
      ),
      ID = "string",
      Prefix = "string",
      Filter = list(
        Prefix = "string",
        Tag = list(
          Key = "string",
          Value = "string"
        ),
        ObjectSizeGreaterThan = 123,
        ObjectSizeLessThan = 123,
        And = list(
          Prefix = "string",
          Tags = list(
            list(
              Key = "string",
              Value = "string"
            )
          ),
          ObjectSizeGreaterThan = 123,
          ObjectSizeLessThan = 123
        )
      ),
      Status = "Enabled"|"Disabled",
      Transitions = list(
        list(
          Date = as.POSIXct(
            "2015-01-01"
          ),
          Days = 123,
          StorageClass = "GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|"GLACIER_IR"
        )
      ),
      NoncurrentVersionTransitions = list(
        list(
          NoncurrentDays = 123,
          StorageClass = "GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|"GLACIER_IR",
          NewerNoncurrentVersions = 123
        )
      ),
      NoncurrentVersionExpiration = list(
        NoncurrentDays = 123,
        NewerNoncurrentVersions = 123
      ),
      AbortIncompleteMultipartUpload = list(
        DaysAfterInitiation = 123
      )
    )
  )
)

Request syntax

svc$get_bucket_lifecycle_configuration(
  Bucket = "string",
  ExpectedBucketOwner = "string"
)

Examples

## Not run: 
# The following example retrieves lifecycle configuration on set on a
# bucket.
svc$get_bucket_lifecycle_configuration(
  Bucket = "examplebucket"
)

## End(Not run)