Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . macie2 ]

describe-buckets

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-buckets
[--criteria <value>]
[--max-results <value>]
[--next-token <value>]
[--sort-criteria <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--criteria (map)

The criteria to use to filter the query results.

Shorthand Syntax:

KeyName1=eq=string,string,gt=long,gte=long,lt=long,lte=long,neq=string,string,prefix=string,KeyName2=eq=string,string,gt=long,gte=long,lt=long,lte=long,neq=string,string,prefix=string

JSON Syntax:

{"string": {
      "eq": ["string", ...],
      "gt": long,
      "gte": long,
      "lt": long,
      "lte": long,
      "neq": ["string", ...],
      "prefix": "string"
    }
  ...}

--max-results (integer)

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

--next-token (string)

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

--sort-criteria (structure)

The criteria to use to sort the query results.

Shorthand Syntax:

attributeName=string,orderBy=string

JSON Syntax:

{
  "attributeName": "string",
  "orderBy": "ASC"|"DESC"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

buckets -> (list)

An array of objects, one for each bucket that meets the filter criteria specified in the request.

(structure)

Provides information about an S3 bucket that Amazon Macie monitors and analyzes.

accountId -> (string)

The unique identifier for the AWS account that's associated with the bucket.

bucketArn -> (string)

The Amazon Resource Name (ARN) of the bucket.

bucketCreatedAt -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

bucketName -> (string)

The name of the bucket.

classifiableObjectCount -> (long)

The total number of objects that Amazon Macie can monitor and analyze in the bucket. These objects use a file format, file extension, or content type that Amazon Macie supports.

lastUpdated -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last analyzed the bucket.

objectCount -> (long)

The total number of objects in the bucket.

objectCountByEncryptionType -> (structure)

The total number of objects that are in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted.

customerManaged -> (long)

Reserved for future use.

kmsManaged -> (long)

Reserved for future use.

s3Managed -> (long)

Reserved for future use.

unencrypted -> (long)

Reserved for future use.

publicAccess -> (structure)

Specifies whether the bucket is publicly accessible. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.

effectivePermission -> (string)

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are: PUBLIC, the bucket is publicly accessible; and, NOT_PUBLIC, the bucket isn't publicly accessible.

permissionConfiguration -> (structure)

The account-level and bucket-level permissions for the bucket.

accountLevelPermissions -> (structure)

The account-level permissions settings that apply to the bucket.

blockPublicAccess -> (structure)

The block public access settings for the bucket.

blockPublicAcls -> (boolean)

Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

blockPublicPolicy -> (boolean)

Specifies whether Amazon S3 blocks public bucket policies for the bucket.

ignorePublicAcls -> (boolean)

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

restrictPublicBuckets -> (boolean)

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

bucketLevelPermissions -> (structure)

The bucket-level permissions settings for the bucket.

accessControlList -> (structure)

The permissions settings of the access control list (ACL) for the bucket. This value is null if an ACL hasn't been defined for the bucket.

allowsPublicReadAccess -> (boolean)

Specifies whether the ACL grants the general public with read access permissions for the bucket.

allowsPublicWriteAccess -> (boolean)

Specifies whether the ACL grants the general public with write access permissions for the bucket.

blockPublicAccess -> (structure)

The block public access settings for the bucket.

blockPublicAcls -> (boolean)

Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

blockPublicPolicy -> (boolean)

Specifies whether Amazon S3 blocks public bucket policies for the bucket.

ignorePublicAcls -> (boolean)

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

restrictPublicBuckets -> (boolean)

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

bucketPolicy -> (structure)

The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.

allowsPublicReadAccess -> (boolean)

Specifies whether the bucket policy allows the general public to have read access to the bucket.

allowsPublicWriteAccess -> (boolean)

Specifies whether the bucket policy allows the general public to have write access to the bucket.

region -> (string)

The AWS Region that hosts the bucket.

replicationDetails -> (structure)

Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.

replicated -> (boolean)

Specifies whether the bucket is configured to replicate one or more objects to any destination.

replicatedExternally -> (boolean)

Specifies whether the bucket is configured to replicate one or more objects to an AWS account that isn't part of the Amazon Macie organization.

replicationAccounts -> (list)

An array of AWS account IDs, one for each AWS account that the bucket is configured to replicate one or more objects to.

(string)

sharedAccess -> (string)

Specifies whether the bucket is shared with another AWS account or configured to support cross-origin resource sharing (CORS). Valid values are:

  • EXTERNAL - The bucket is shared with an AWS account that isn’t part of the Amazon Macie organization.
  • INTERNAL - The bucket is shared with an AWS account that's part of the Amazon Macie organization.
  • NOT_SHARED - The bucket isn't shared with other AWS accounts.

sizeInBytes -> (long)

The total storage size, in bytes, of the bucket.

sizeInBytesCompressed -> (long)

The total compressed storage size, in bytes, of the bucket.

tags -> (list)

An array that specifies the tags (keys and values) that are associated with the bucket.

(structure)

Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.

key -> (string)

One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

value -> (string)

One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be empty or null.

versioning -> (boolean)

Specifies whether versioning is enabled for the bucket.

nextToken -> (string)

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.