AmplifyBackend / Client / get_backend_storage
get_backend_storage#
- AmplifyBackend.Client.get_backend_storage(**kwargs)#
Gets details for a backend storage resource.
See also: AWS API Documentation
Request Syntax
response = client.get_backend_storage( AppId='string', BackendEnvironmentName='string', ResourceName='string' )
- Parameters:
AppId (string) –
[REQUIRED]
The app ID.
BackendEnvironmentName (string) –
[REQUIRED]
The name of the backend environment.
ResourceName (string) –
[REQUIRED]
The name of the storage resource.
- Return type:
dict
- Returns:
Response Syntax
{ 'AppId': 'string', 'BackendEnvironmentName': 'string', 'ResourceConfig': { 'BucketName': 'string', 'Imported': True|False, 'Permissions': { 'Authenticated': [ 'READ'|'CREATE_AND_UPDATE'|'DELETE', ], 'UnAuthenticated': [ 'READ'|'CREATE_AND_UPDATE'|'DELETE', ] }, 'ServiceName': 'S3' }, 'ResourceName': 'string' }
Response Structure
(dict) –
200 response
AppId (string) –
The app ID.
BackendEnvironmentName (string) –
The name of the backend environment.
ResourceConfig (dict) –
The resource configuration for the backend storage resource.
BucketName (string) –
The name of the S3 bucket.
Imported (boolean) –
Returns True if the storage resource has been imported.
Permissions (dict) –
The authorization configuration for the storage S3 bucket.
Authenticated (list) –
Lists all authenticated user read, write, and delete permissions for your S3 bucket.
(string) –
UnAuthenticated (list) –
Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.
(string) –
ServiceName (string) –
The name of the storage service.
ResourceName (string) –
The name of the storage resource.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundException
AmplifyBackend.Client.exceptions.GatewayTimeoutException
AmplifyBackend.Client.exceptions.TooManyRequestsException
AmplifyBackend.Client.exceptions.BadRequestException