client.storage_hosts.patch

A method of the Storage Hosts endpoint.

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

Update some attributes of this storage host

API URL: PATCH /storage_hosts/{id}

import civis
client = civis.APIClient()
response = client.storage_hosts.patch(...)

Parameters:

idint

The ID of the storage host.

namestr, optional

The human readable name for the storage host.

providerstr, optional

The storage provider.One of: s3.

bucketstr, optional

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”)