list_s3_buckets

AmplifyBackend.Client.list_s3_buckets(**kwargs)

The list of S3 buckets in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_s3_buckets(
    NextToken='string'
)
Parameters
NextToken (string) -- Reserved for future use.
Return type
dict
Returns
Response Syntax
{
    'Buckets': [
        {
            'CreationDate': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    200 response

    • Buckets (list) --

      The list of S3 buckets.

      • (dict) --

        Describes the metadata of the S3 bucket.

        • CreationDate (string) --

          The creation date of the S3 bucket.

        • Name (string) --

          The name of the S3 bucket.

    • NextToken (string) --

      Reserved for future use.

Exceptions

  • AmplifyBackend.Client.exceptions.NotFoundException
  • AmplifyBackend.Client.exceptions.GatewayTimeoutException
  • AmplifyBackend.Client.exceptions.TooManyRequestsException
  • AmplifyBackend.Client.exceptions.BadRequestException