URI HTTP methods Schemas Properties See also

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
Name	Type	Required	Description
`appId`	String	True	The app ID.
`backendEnvironmentName`	String	True	The name of the backend environment.

Responses
Status code	Response model	Description
`200`	`GetBackendStorageRespObj`	200 response
`400`	`BadRequestException`	400 response
`404`	`NotFoundException`	404 response
`429`	`LimitExceededException`	429 response
`504`	`InternalServiceException`	504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
Name	Type	Required	Description
`appId`	String	True	The app ID.
`backendEnvironmentName`	String	True	The name of the backend environment.

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Request bodies


{
  "resourceName resourceName": "string"
}

Response bodies


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


{
  "message message": "string"
}


{
  "message message": "string",
  "resourceType resourceType": "string"
}


{
  "message message": "string",
  "limitType limitType": "string"
}


{
  "message message": "string"
}

Properties

BackendStoragePermissions

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

Property Type Required Description

Property	Type	Required	Description
`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.

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.

authenticated

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

Type: Array of type string
Required: True
Values: READ | CREATE_AND_UPDATE | DELETE

unAuthenticated

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

Type: Array of type string
Required: False
Values: READ | CREATE_AND_UPDATE | DELETE

BadRequestException

An error returned if a request is not formed properly.

Property	Type	Required	Description
`message`	string	False	An error message to inform that the request failed.

message

An error message to inform that the request failed.

Type: string
Required: False

GetBackendStorageReqObj

The request object for this operation.

Property	Type	Required	Description
`resourceName`	string	True	The name of the storage resource.

resourceName

The name of the storage resource.

Type: string
Required: True

GetBackendStorageResourceConfig

The details for a backend storage resource.

Property	Type	Required	Description
`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.

bucketName

The name of the S3 bucket.

Type: string
Required: False

permissions

The authorization configuration for the storage S3 bucket.

Type: BackendStoragePermissions
Required: False

imported

Returns True if the storage resource has been imported.

Type: boolean
Required: True

serviceName

The name of the storage service.

Type: string
Required: True
Values: S3

GetBackendStorageRespObj

The response object for this operation.

Property	Type	Required	Description
`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.

resourceConfig

The resource configuration for the backend storage resource.

Type: GetBackendStorageResourceConfig
Required: False

appId

The app ID.

Type: string
Required: True

resourceName

The name of the storage resource.

Type: string
Required: False

backendEnvironmentName

The name of the backend environment.

Type: string
Required: True

InternalServiceException

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

Property	Type	Required	Description
`message`	string	False	An error message to inform that the request failed.

message

An error message to inform that the request failed.

Type: string
Required: False

LimitExceededException

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

Property	Type	Required	Description
`limitType`	string	False	The type of limit that was exceeded.
`message`	string	False	An error message to inform that the request has failed.

message

An error message to inform that the request has failed.

Type: string
Required: False

limitType

The type of limit that was exceeded.

Type: string
Required: False

NotFoundException

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

Property	Type	Required	Description
`message`	string	False	An error message to inform that the request has failed.
`resourceType`	string	False	The type of resource that is not found.

message

An error message to inform that the request has failed.

Type: string
Required: False

resourceType

The type of resource that is not found.

Type: string
Required: False