AmplifyBackend / Client / update_backend_storage

update_backend_storage#

AmplifyBackend.Client.update_backend_storage(**kwargs)#

Updates an existing backend storage resource.

Request Syntax

response = client.update_backend_storage(
    AppId='string',
    BackendEnvironmentName='string',
    ResourceConfig={
        'Permissions': {
            'Authenticated': [
                'READ'|'CREATE_AND_UPDATE'|'DELETE',
            ],
            'UnAuthenticated': [
                'READ'|'CREATE_AND_UPDATE'|'DELETE',
            ]
        },
        'ServiceName': 'S3'
    },
    ResourceName='string'
)

Parameters:

AppId (string) –
[REQUIRED]

The app ID.
BackendEnvironmentName (string) –
[REQUIRED]

The name of the backend environment.
ResourceConfig (dict) –
[REQUIRED]

The resource configuration for updating backend storage.
- Permissions (dict) – [REQUIRED]
  
  The authorization configuration for the storage S3 bucket.
  - Authenticated (list) – [REQUIRED]
    
    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) – [REQUIRED]
  
  The name of the storage service.
ResourceName (string) –
[REQUIRED]

The name of the storage resource.

Return type:

dict

Returns:

Response Syntax

{
    'AppId': 'string',
    'BackendEnvironmentName': 'string',
    'JobId': 'string',
    'Status': 'string'
}

Response Structure

(dict) –

200 response
- AppId (string) –
  
  The app ID.
- BackendEnvironmentName (string) –
  
  The name of the backend environment.
- JobId (string) –
  
  The ID for the job.
- Status (string) –
  
  The current status of the request.

Exceptions

AmplifyBackend.Client.exceptions.NotFoundException
AmplifyBackend.Client.exceptions.GatewayTimeoutException
AmplifyBackend.Client.exceptions.TooManyRequestsException
AmplifyBackend.Client.exceptions.BadRequestException