anatools.client.channels module

Channels Functions

anatools.client.channels.add_channel_access(self, channelId, organizationId)

Add access to a channel for an organization.

Parameters

  • channel (str) – Name of channel to add access for.

  • organizationId (str) – Organization ID. Defaults to current if not specified.

Returns

Access status.

Return type

str

anatools.client.channels.create_managed_channel(self, name, organizationId=None, dataVolumes=None, instanceType=None, timeout=None)

Create a managed channel for your organization.

Parameters

  • organizationId (str) – Organization ID. Defaults to current if not specified.

  • name (name) – Channel name.

  • dataVolumes (str) – Data volume

  • instanceType (str) – AWS Instance type

  • timeout (int) – Timeout

Returns

channel data

Return type

json

anatools.client.channels.deploy_channel(self, channel, alias=None)

Deploy the docker image of a channel.

Parameters

channel (str) – Channel name for the docker image, this must match the channel docker image.

Returns

Success or failure message about docker registration.

Return type

str

anatools.client.channels.edit_managed_channel(self, name, volumes, instanceType, timeout)

Edit a managed channel for your organization.

Parameters

  • organizationId (str) – Organization ID. Defaults to current if not specified.

  • name (name) – Channel name.

  • volumes ([str]) – Data volumes

  • instanceType (str) – AWS instance type

  • timeout (int) – Timeout for the channel

Returns

If true, the channel was successfully edited.

Return type

bool

anatools.client.channels.get_channels(self, organizationId=None, workspaceId=None, channelId=None)

Shows all channels available to the user. Can filter by organizationId, workspaceId, or channelId.

Parameters

  • organizationId (str) – Filter channel list on what’s available to the organization.

  • workspaceId (str) – Filter channel list on what’s available to the workspace.

  • channelId (str) – Filter channel list on the specific channelId.

Returns

List of all possible channel names.

Return type

list

anatools.client.channels.get_managed_channels(self, channelId=None, organizationId=None)

Get managed channels by organization.

Parameters

  • organizationId (str) – Organization ID. Defaults to current if not specified.

  • channel (name) – Channel name to filter.

Returns

channel data

Return type

json

anatools.client.channels.remove_channel_access(self, channelId, organizationId)

Remove access to a channel for an organization.

Parameters

  • channel (str) – Name of channel to remove access to.

  • organizationId (str) – Organization ID. Defaults to current if not specified.

Returns

Access status.

Return type

str