Backend appId Storage backendEnvironmentName Remove - Amplify Admin UI

Backend appId Storage backendEnvironmentName Remove

Remove a storage resource from your Amplify app backend.

URI

/prod/backend/appId/storage/backendEnvironmentName/remove

HTTP methods

POST

Operation ID: DeleteBackendStorage

Removes the specified backend storage resource.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

backendEnvironmentNameStringTrue

The name of the backend environment.

Responses
Status codeResponse modelDescription
200BackendStorageRespObj

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", "serviceName": enum }

Response bodies

{ "jobId": "string", "appId": "string", "backendEnvironmentName": "string", "status": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }
{ "message": "string" }

Properties

BackendStorageRespObj

The response object for this operation.

PropertyTypeRequiredDescription
appId

string

True

The app ID.

backendEnvironmentName

string

True

The name of the backend environment.

jobId

string

True

The ID for the job.

status

string

True

The current status of the request.

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.

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.

RemoveBackendStorageReqObj

The request object for this operation.

PropertyTypeRequiredDescription
resourceName

string

True

The name of the storage resource.

serviceName

string

Values: S3

True

The name of the storage service.

See also

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

DeleteBackendStorage