Describe Buckets

macie2_describe_buckets

R Documentation

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account

Description

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.

Usage

macie2_describe_buckets(criteria, maxResults, nextToken, sortCriteria)

Arguments

criteria

The criteria to use to filter the query results.

maxResults

The maximum number of items to include in each page of the response. The default value is 50.

nextToken

The nextToken string that specifies which page of results to return in a paginated response.

sortCriteria

The criteria to use to sort the query results.

Value

A list with the following syntax:

list(
  buckets = list(
    list(
      accountId = "string",
      allowsUnencryptedObjectUploads = "TRUE"|"FALSE"|"UNKNOWN",
      automatedDiscoveryMonitoringStatus = "MONITORED"|"NOT_MONITORED",
      bucketArn = "string",
      bucketCreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      bucketName = "string",
      classifiableObjectCount = 123,
      classifiableSizeInBytes = 123,
      errorCode = "ACCESS_DENIED",
      errorMessage = "string",
      jobDetails = list(
        isDefinedInJob = "TRUE"|"FALSE"|"UNKNOWN",
        isMonitoredByJob = "TRUE"|"FALSE"|"UNKNOWN",
        lastJobId = "string",
        lastJobRunTime = as.POSIXct(
          "2015-01-01"
        )
      ),
      lastAutomatedDiscoveryTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdated = as.POSIXct(
        "2015-01-01"
      ),
      objectCount = 123,
      objectCountByEncryptionType = list(
        customerManaged = 123,
        kmsManaged = 123,
        s3Managed = 123,
        unencrypted = 123,
        unknown = 123
      ),
      publicAccess = list(
        effectivePermission = "PUBLIC"|"NOT_PUBLIC"|"UNKNOWN",
        permissionConfiguration = list(
          accountLevelPermissions = list(
            blockPublicAccess = list(
              blockPublicAcls = TRUE|FALSE,
              blockPublicPolicy = TRUE|FALSE,
              ignorePublicAcls = TRUE|FALSE,
              restrictPublicBuckets = TRUE|FALSE
            )
          ),
          bucketLevelPermissions = list(
            accessControlList = list(
              allowsPublicReadAccess = TRUE|FALSE,
              allowsPublicWriteAccess = TRUE|FALSE
            ),
            blockPublicAccess = list(
              blockPublicAcls = TRUE|FALSE,
              blockPublicPolicy = TRUE|FALSE,
              ignorePublicAcls = TRUE|FALSE,
              restrictPublicBuckets = TRUE|FALSE
            ),
            bucketPolicy = list(
              allowsPublicReadAccess = TRUE|FALSE,
              allowsPublicWriteAccess = TRUE|FALSE
            )
          )
        )
      ),
      region = "string",
      replicationDetails = list(
        replicated = TRUE|FALSE,
        replicatedExternally = TRUE|FALSE,
        replicationAccounts = list(
          "string"
        )
      ),
      sensitivityScore = 123,
      serverSideEncryption = list(
        kmsMasterKeyId = "string",
        type = "NONE"|"AES256"|"aws:kms"|"aws:kms:dsse"
      ),
      sharedAccess = "EXTERNAL"|"INTERNAL"|"NOT_SHARED"|"UNKNOWN",
      sizeInBytes = 123,
      sizeInBytesCompressed = 123,
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      unclassifiableObjectCount = list(
        fileType = 123,
        storageClass = 123,
        total = 123
      ),
      unclassifiableObjectSizeInBytes = list(
        fileType = 123,
        storageClass = 123,
        total = 123
      ),
      versioning = TRUE|FALSE
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_buckets(
  criteria = list(
    list(
      eq = list(
        "string"
      ),
      gt = 123,
      gte = 123,
      lt = 123,
      lte = 123,
      neq = list(
        "string"
      ),
      prefix = "string"
    )
  ),
  maxResults = 123,
  nextToken = "string",
  sortCriteria = list(
    attributeName = "string",
    orderBy = "ASC"|"DESC"
  )
)