Skip to content
AWS for Query.Farm

aws.lightsail.get_buckets

Example SQL Queries

SELECT * FROM
aws.lightsail.get_buckets;

Description

Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Table Definition

Column NameColumn Data Type
bucket_name Input Column

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.

VARCHAR
include_connected_resources Input Column

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

BOOLEAN
page_token Input Column

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
account_level_bpa_sync

An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

STRUCT(
    "status" VARCHAR,
    "last_synced_at" TIMESTAMP_S,
    "message" VARCHAR,
    "bpa_impacts_lightsail" BOOLEAN
)
Show child fields
account_level_bpa_sync.bpa_impacts_lightsail

A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.

account_level_bpa_sync.last_synced_at

The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.

account_level_bpa_sync.message

A message that provides a reason for a Failed or Defaulted synchronization status.

The following messages are possible:

  • SYNC_ON_HOLD - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.

  • DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.

  • DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.

  • Unknown - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.

account_level_bpa_sync.status

The status of the account-level BPA synchronization.

The following statuses are possible:

  • InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets.

  • NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.

  • Failed - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.

  • Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to active.

You might need to complete further actions if the status is Failed or Defaulted. The message parameter provides more information for those statuses.

buckets

An array of objects that describe buckets.

STRUCT(
    "resource_type" VARCHAR,
    "access_rules" STRUCT(
        "get_object" VARCHAR,
        "allow_public_overrides" BOOLEAN
    ),
    "arn" VARCHAR,
    "bundle_id" VARCHAR,
    "created_at" TIMESTAMP_S,
    "url" VARCHAR,
    "location" STRUCT(
        "availability_zone" VARCHAR,
        "region_name" VARCHAR
    ),
    "name" VARCHAR,
    "support_code" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "object_versioning" VARCHAR,
    "able_to_update_bundle" BOOLEAN,
    "readonly_access_accounts" VARCHAR[],
    "resources_receiving_access" STRUCT(
        "name" VARCHAR,
        "resource_type" VARCHAR
    )[],
    "state" STRUCT(
        "code" VARCHAR,
        "message" VARCHAR
    ),
    "access_log_config" STRUCT(
        "enabled" BOOLEAN,
        "destination" VARCHAR,
        "prefix" VARCHAR
    )
)[]
Show child fields
buckets[]
Show child fields
buckets[].able_to_update_bundle

Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.

Use the UpdateBucketBundle action to change a bucket's bundle.

buckets[].access_log_config

An object that describes the access log configuration for the bucket.

Show child fields
buckets[].access_log_config.destination

The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.

This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.

buckets[].access_log_config.enabled

A Boolean value that indicates whether bucket access logging is enabled for the bucket.

buckets[].access_log_config.prefix

The optional object prefix for the bucket access log.

The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).

This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.

buckets[].access_rules

An object that describes the access rules of the bucket.

Show child fields
buckets[].access_rules.allow_public_overrides

A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

buckets[].access_rules.get_object

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

buckets[].arn

The Amazon Resource Name (ARN) of the bucket.

buckets[].bundle_id

The ID of the bundle currently applied to the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to change the bundle of a bucket.

buckets[].created_at

The timestamp when the distribution was created.

buckets[].location

An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

Show child fields
buckets[].location.availability_zone

The Availability Zone. Follows the format us-east-2a (case-sensitive).

buckets[].location.region_name

The Amazon Web Services Region name.

buckets[].name

The name of the bucket.

buckets[].object_versioning

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

  • Enabled - Object versioning is enabled.

  • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

  • NeverEnabled - Object versioning has never been enabled.

buckets[].readonly_access_accounts[]
buckets[].resource_type

The Lightsail resource type of the bucket.

buckets[].resources_receiving_access[]
Show child fields
buckets[].resources_receiving_access[].name

The name of the Lightsail instance.

buckets[].resources_receiving_access[].resource_type

The Lightsail resource type (for example, Instance).

buckets[].state

An object that describes the state of the bucket.

Show child fields
buckets[].state.code

The state code of the bucket.

The following codes are possible:

  • OK - The bucket is in a running state.

  • Unknown - Creation of the bucket might have timed-out. You might want to delete the bucket and create a new one.

buckets[].state.message

A message that describes the state of the bucket.

buckets[].support_code

The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

buckets[].tags[]
Show child fields
buckets[].tags[].key

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@

buckets[].tags[].value

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@

buckets[].url

The URL of the bucket.

next_page_token

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetBuckets request and specify the next page token using the pageToken parameter.

VARCHAR