Search Resources

macie2_search_resources

R Documentation

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes for an account

Description

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes for an account.

Usage

macie2_search_resources(bucketCriteria, maxResults, nextToken,
  sortCriteria)

Arguments

bucketCriteria	The filter conditions that determine which S3 buckets to include or exclude from 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 results.

Value

A list with the following syntax:

list(
  matchingResources = list(
    list(
      matchingBucket = list(
        accountId = "string",
        automatedDiscoveryMonitoringStatus = "MONITORED"|"NOT_MONITORED",
        bucketName = "string",
        classifiableObjectCount = 123,
        classifiableSizeInBytes = 123,
        errorCode = "ACCESS_DENIED"|"BUCKET_COUNT_EXCEEDS_QUOTA",
        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"
        ),
        objectCount = 123,
        objectCountByEncryptionType = list(
          customerManaged = 123,
          kmsManaged = 123,
          s3Managed = 123,
          unencrypted = 123,
          unknown = 123
        ),
        sensitivityScore = 123,
        sizeInBytes = 123,
        sizeInBytesCompressed = 123,
        unclassifiableObjectCount = list(
          fileType = 123,
          storageClass = 123,
          total = 123
        ),
        unclassifiableObjectSizeInBytes = list(
          fileType = 123,
          storageClass = 123,
          total = 123
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$search_resources(
  bucketCriteria = list(
    excludes = list(
      and = list(
        list(
          simpleCriterion = list(
            comparator = "EQ"|"NE",
            key = "ACCOUNT_ID"|"S3_BUCKET_NAME"|"S3_BUCKET_EFFECTIVE_PERMISSION"|"S3_BUCKET_SHARED_ACCESS"|"AUTOMATED_DISCOVERY_MONITORING_STATUS",
            values = list(
              "string"
            )
          ),
          tagCriterion = list(
            comparator = "EQ"|"NE",
            tagValues = list(
              list(
                key = "string",
                value = "string"
              )
            )
          )
        )
      )
    ),
    includes = list(
      and = list(
        list(
          simpleCriterion = list(
            comparator = "EQ"|"NE",
            key = "ACCOUNT_ID"|"S3_BUCKET_NAME"|"S3_BUCKET_EFFECTIVE_PERMISSION"|"S3_BUCKET_SHARED_ACCESS"|"AUTOMATED_DISCOVERY_MONITORING_STATUS",
            values = list(
              "string"
            )
          ),
          tagCriterion = list(
            comparator = "EQ"|"NE",
            tagValues = list(
              list(
                key = "string",
                value = "string"
              )
            )
          )
        )
      )
    )
  ),
  maxResults = 123,
  nextToken = "string",
  sortCriteria = list(
    attributeName = "ACCOUNT_ID"|"RESOURCE_NAME"|"S3_CLASSIFIABLE_OBJECT_COUNT"|"S3_CLASSIFIABLE_SIZE_IN_BYTES",
    orderBy = "ASC"|"DESC"
  )
)