Backend appId Storage backendEnvironmentName Import

Import a storage resource into your Amplify app backend.

URI

/prod/backend/appId/storage/backendEnvironmentName/import

Operation ID: ImportBackendStorage

Imports an existing backend storage resource.

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

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


{
  "bucketName": "string",
  "serviceName": enum
}


{
  "jobId": "string",
  "appId": "string",
  "backendEnvironmentName": "string",
  "status": "string"
}


{
  "message": "string"
}


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


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


{
  "message": "string"
}

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.
`jobId`	string	True	The ID for the job.
`status`	string	True	The current status of the request.

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.

The request object for this operation.

Property Type Required Description

Property	Type	Required	Description
`bucketName`	string	False	The name of the S3 bucket.
`serviceName`	string Values: `S3`	True	The name of the storage service.

bucketName

string

False

The name of the S3 bucket.

serviceName

string

Values: S3

True

The name of the storage service.

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.

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.

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.