s3_bucket_info – List S3 Buckets

Retrieve information about AWS S3 Buckets.

Examples

- name: List all accessible buckets
  s3_bucket_info:
  register: result

- debug:
    var: result.objects

- name: Retrieve a specific S3 bucket
  s3_bucket_info:
    names: steamybucket
  register: result

- debug:
    var: result.objects

- name: Retrieve a specific S3 buckets
  s3_bucket_info:
    names:
      - xbucket
      - lbucket
      - abucket
      - bbucket

Parameters

auth (optional)

Parameters for authenticating with the AWS service. Each of them may be defined via environment variables.

type: dict
access_key (optional)

The AWS access key ID. If not set, the value of the AWS_ACCESS_KEY environment variable will be checked.

Mutually exclusive with profile.

type: str
profile (optional)

The name of the AWS profile configured with aws configure.

Can be used instead of explicitly specifying your access credentials and region.

Use default to use the default profile.

Mutually exclusive with access_key and secret_key.

type: str
region (optional)

The name of the AWS region.

If not set, the value of the AWS_REGION environment variable will be checked.

If you set a profile that specifies a default region, that region is used and you can omit this parameter. Use this parameter to override the profile’s default region.

type: str
secret_key (optional)

The AWS secret access key. If not set, the value of the AWS_SECRET_KEY environment variable will be checked.

Mutually exclusive with profile.

type: str
url (optional)

The URL to the AWS service related to the resource. By default, this is automatically determined through the region parameter.

If not set explicitly, the value of the AWS_<SERVICE>_URL environment variable will be used.

The services currently supported are EC2 and S3.

type: str
names (optional)

Limit results to the specified S3 Buckets only

type: list

Return Values

object (success), complex,

An object representing an S3 Bucket.

name (always), str, steamybucket

Name of S3 bucket.

versioning (always), bool, False

If there are multiple versions of an object in the same bucket.

access_logging (always), bool, False

If records for the requests are enabled.

public_access (always), bool, False

If public access to your S3 buckets and objects is blocked.

tags (always), dict, {‘Name’: ‘my-s3-bucket’}

Tags associated with the S3 Bucket.