:doc:`AmplifyBackend <../../amplifybackend>` / Client / get_backend_storage

*******************
get_backend_storage
*******************



.. py:method:: AmplifyBackend.Client.get_backend_storage(**kwargs)

  

  Gets details for a backend storage resource.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendStorage>`_  


  **Request Syntax**
  ::

    response = client.get_backend_storage(
        AppId='string',
        BackendEnvironmentName='string',
        ResourceName='string'
    )
    
  :type AppId: string
  :param AppId: **[REQUIRED]** 

    The app ID.

    

  
  :type BackendEnvironmentName: string
  :param BackendEnvironmentName: **[REQUIRED]** 

    The name of the backend environment.

    

  
  :type ResourceName: string
  :param ResourceName: **[REQUIRED]** 

    The name of the storage resource.

    

  
  
  :rtype: 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**
  
  *   :py:class:`AmplifyBackend.Client.exceptions.NotFoundException`

  
  *   :py:class:`AmplifyBackend.Client.exceptions.GatewayTimeoutException`

  
  *   :py:class:`AmplifyBackend.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`AmplifyBackend.Client.exceptions.BadRequestException`

  