Tenant

Tenants client module.

peak.resources.tenants.get_client(session=None)

Returns a Tenant client, If no session is provided, a default session is used.

Parameters:

session (Optional[Session]) – A Session Object. Default is None.

Returns:

the tenant client object

Return type:

Tenant

Tenant Client

class peak.resources.tenants.Tenant(session=None)

Tenant client class.

Parameters:

session (Session) –

get_credentials(data_store_type=None)

Retrieve credentials for a given data store type.

REFERENCE:

🔗 API Documentation

Parameters:

data_store_type (str) – The type of the data store. Allowed values are - data-warehouse. Default - data-warehouse

Returns:

a dictionary containing the credentials for the data store.

Return type:

Dict[str, Any]

Raises:

  • BadRequestException – The given request parameters are invalid.

  • UnauthorizedException – The credentials are invalid.

  • ForbiddenException – The user does not have permission to perform the operation.

  • NotFoundException – The given image does not exist.

  • InternalServerErrorException – The server failed to process the request.

list_instance_options(entity_type)

Retrieve details of allowed instance options for a tenant.

REFERENCE:

🔗 API Documentation

Parameters:

entity_type (str) – The type of the entity. Allowed values are - api-deployment, data-bridge, webapp, workflow, workspace.

Returns:

a dictionary containing the details of the allowed instance options of a tenant.

Return type:

Dict[str, Any]

Raises:

  • BadRequestException – The given request parameters are invalid.

  • UnauthorizedException – The credentials are invalid.

  • ForbiddenException – The user does not have permission to perform the operation.

  • NotFoundException – The given image does not exist.

  • InternalServerErrorException – The server failed to process the request.