Backend appId Storage backendEnvironmentName Details - Amplify Admin UI

Backend appId Storage backendEnvironmentName Details

Get the details for a storage resource in your Amplify app backend.

URI

/prod/backend/appId/storage/backendEnvironmentName/details

HTTP methods

POST

Operation ID: GetBackendStorage

Gets details for a backend storage resource.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

backendEnvironmentNameStringTrue

The name of the backend environment.

Responses
Status codeResponse modelDescription
200GetBackendStorageRespObj

200 response

400BadRequestException

400 response

404NotFoundException

404 response

429LimitExceededException

429 response

504InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

backendEnvironmentNameStringTrue

The name of the backend environment.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "resourceName": "string" }

Response bodies

{ "resourceConfig": { "bucketName": "string", "permissions": { "authenticated": [ enum ], "unAuthenticated": [ enum ] }, "imported": boolean, "serviceName": enum }, "appId": "string", "resourceName": "string", "backendEnvironmentName": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }
{ "message": "string" }

Properties

BackendStoragePermissions

Describes the read, write, and delete permissions users have against your storage S3 bucket.

PropertyTypeRequiredDescription
authenticated

Array of type string

Values: READ | CREATE_AND_UPDATE | DELETE

True

Lists all authenticated user read, write, and delete permissions for your S3 bucket.

unAuthenticated

Array of type string

Values: READ | CREATE_AND_UPDATE | DELETE

False

Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.

BadRequestException

An error returned if a request is not formed properly.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

GetBackendStorageReqObj

The request object for this operation.

PropertyTypeRequiredDescription
resourceName

string

True

The name of the storage resource.

GetBackendStorageResourceConfig

The details for a backend storage resource.

PropertyTypeRequiredDescription
bucketName

string

False

The name of the S3 bucket.

imported

boolean

True

Returns True if the storage resource has been imported.

permissions

BackendStoragePermissions

False

The authorization configuration for the storage S3 bucket.

serviceName

string

Values: S3

True

The name of the storage service.

GetBackendStorageRespObj

The response object for this operation.

PropertyTypeRequiredDescription
appId

string

True

The app ID.

backendEnvironmentName

string

True

The name of the backend environment.

resourceConfig

GetBackendStorageResourceConfig

False

The resource configuration for the backend storage resource.

resourceName

string

False

The name of the storage resource.

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.

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.

See also

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

GetBackendStorage