S3Buckets - Amplify Admin UI

S3Buckets

List the Amazon S3 buckets in your AWS account.

URI

/prod/s3Buckets

HTTP methods

POST

Operation ID: ListS3Buckets

The list of S3 buckets in your account.

Responses
Status codeResponse modelDescription
200ListS3BucketsRespObj

200 response

400BadRequestException

400 response

404NotFoundException

404 response

429LimitExceededException

429 response

504InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "nextToken": "string" }

Response bodies

{ "nextToken": "string", "buckets": [ { "name": "string", "creationDate": "string" } ] }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }
{ "message": "string" }

Properties

BadRequestException

An error returned if a request is not formed properly.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

InternalServiceException

An error returned if there's a temporary issue with the service.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

LimitExceededException

An error that is returned when a limit of a specific type has been exceeded.

PropertyTypeRequiredDescription
limitType

string

False

The type of limit that was exceeded.

message

string

False

An error message to inform that the request has failed.

ListS3BucketsReqObj

The request object for this operation.

PropertyTypeRequiredDescription
nextToken

string

False

Reserved for future use.

ListS3BucketsRespObj

The response object for this operation.

PropertyTypeRequiredDescription
buckets

Array of type S3BucketInfo

True

The list of S3 buckets.

nextToken

string

False

Reserved for future use.

NotFoundException

An error returned when a specific resource type is not found.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request has failed.

resourceType

string

False

The type of resource that is not found.

S3BucketInfo

Describes the metadata of the S3 bucket.

PropertyTypeRequiredDescription
creationDate

string

False

The creation date of the S3 bucket.

name

string

False

The name of the S3 bucket.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListS3Buckets