:doc:`StorageGateway <../../storagegateway>` / Client / describe_upload_buffer

**********************
describe_upload_buffer
**********************



.. py:method:: StorageGateway.Client.describe_upload_buffer(**kwargs)

  

  Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

   

  The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeUploadBuffer>`_  


  **Request Syntax**
  ::

    response = client.describe_upload_buffer(
        GatewayARN='string'
    )
    
  :type GatewayARN: string
  :param GatewayARN: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the gateway. Use the  ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'GatewayARN': 'string',
          'DiskIds': [
              'string',
          ],
          'UploadBufferUsedInBytes': 123,
          'UploadBufferAllocatedInBytes': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **GatewayARN** *(string) --* 

        The Amazon Resource Name (ARN) of the gateway. Use the  ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

        
      

      - **DiskIds** *(list) --* 

        An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

        
        

        - *(string) --* 
    
      

      - **UploadBufferUsedInBytes** *(integer) --* 

        The total number of bytes being used in the gateway's upload buffer.

        
      

      - **UploadBufferAllocatedInBytes** *(integer) --* 

        The total number of bytes allocated in the gateway's as upload buffer.

        
  
  **Exceptions**
  
  *   :py:class:`StorageGateway.Client.exceptions.InvalidGatewayRequestException`

  
  *   :py:class:`StorageGateway.Client.exceptions.InternalServerError`

  

  **Examples**

  Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.
  ::

    response = client.describe_upload_buffer(
        GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'DiskIds': [
            'pci-0000:03:00.0-scsi-0:0:0:0',
            'pci-0000:04:00.0-scsi-0:1:0:0',
        ],
        'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
        'UploadBufferAllocatedInBytes': 0,
        'UploadBufferUsedInBytes': 161061273600,
        'ResponseMetadata': {
            '...': '...',
        },
    }

  

  Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.
  ::

    response = client.describe_upload_buffer(
        GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'DiskIds': [
            'pci-0000:03:00.0-scsi-0:0:0:0',
            'pci-0000:04:00.0-scsi-0:1:0:0',
        ],
        'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
        'UploadBufferAllocatedInBytes': 161061273600,
        'UploadBufferUsedInBytes': 0,
        'ResponseMetadata': {
            '...': '...',
        },
    }

  