client.storage_hosts.put

A method of the Storage Hosts endpoint.

put(id: int, name: str, provider: str, bucket: str, *, s3_options: dict = None) Response

Replace all attributes of this storage host

API URL: PUT /storage_hosts/{id}

import civis
client = civis.APIClient()
response = client.storage_hosts.put(...)
Parameters:
idint

The ID of the storage host.

namestr

The human readable name for the storage host.

providerstr

The storage provider.One of: s3.

bucketstr

The bucket for this storage host.

s3_optionsdict, optional
  • regionstr

    The region for this storage host (ex. “us-east-1”)

Returns:
civis.Response
  • idint

    The ID of the storage host.

  • ownercivis.Response
    • idint

      The ID of this user.

    • namestr

      This user’s name.

    • usernamestr

      This user’s username.

    • initialsstr

      This user’s initials.

    • onlinebool

      Whether this user is online.

  • namestr

    The human readable name for the storage host.

  • providerstr

    The storage provider.One of: s3.

  • bucketstr

    The bucket for this storage host.

  • s3_optionscivis.Response
    • regionstr

      The region for this storage host (ex. “us-east-1”)