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

*********
add_cache
*********



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

  

  Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see `How Storage Gateway works (architecture) <https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html>`__.

   

  In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

  

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


  **Request Syntax**
  ::

    response = client.add_cache(
        GatewayARN='string',
        DiskIds=[
            '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.

    

  
  :type DiskIds: list
  :param DiskIds: **[REQUIRED]** 

    An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the  ListLocalDisks API.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'GatewayARN': 'string'
      }
      
    **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.

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

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

  

  **Examples**

  The following example shows a request that activates a gateway-stored volume.
  ::

    response = client.add_cache(
        DiskIds=[
            'pci-0000:03:00.0-scsi-0:0:0:0',
            'pci-0000:03:00.0-scsi-0:0:1:0',
        ],
        GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
        'ResponseMetadata': {
            '...': '...',
        },
    }

  