snowflake.core.account.Account | Snowflake Documentation (original) (raw)

class snowflake.core.account.Account(name: str, edition: str, admin_name: str, email: str, organization_name: str | None = None, region_group: str | None = None, region: str | None = None, created_on: datetime | None = None, account_url: str | None = None, account_locator: str | None = None, account_locator_url: str | None = None, managed_accounts: int | None = None, consumption_billing_entity_name: str | None = None, marketplace_consumer_billing_entity_name: str | None = None, marketplace_provider_billing_entity_name: str | None = None, old_account_url: str | None = None, comment: str | None = None, is_org_admin: bool | None = None, retention_time: int | None = None, dropped_on: datetime | None = None, scheduled_deletion_time: datetime | None = None, restored_on: datetime | None = None, account_old_url_saved_on: datetime | None = None, account_old_url_last_used: datetime | None = None, organization_old_url: str | None = None, organization_old_url_saved_on: datetime | None = None, organization_old_url_last_used: datetime | None = None, organization_url_expiration_on: datetime | None = None, moved_on: datetime | None = None, is_events_account: bool | None = None, moved_to_organization: str | None = None, admin_password: str | None = None, admin_rsa_public_key: str | None = None, admin_user_type: str | None = None, first_name: str | None = None, last_name: str | None = None, must_change_password: bool | None = False, polaris: bool | None = False)¶

Bases: object

A model object representing the Account resource.

Constructs an object of type Account with the provided properties.

Parameters:

• name (str) – A Snowflake object identifier.
• edition (str) – Snowflake Edition of the account.
• admin_name (str) – Name of the account administrator.
• email (str) – Email address of the account administrator.
• organization_name (str , optional) – Name of the organization.
• region_group (str , optional) – Region group where the account is located. Note - This column is only displayed for organizations that span multiple region groups.
• region (str , optional) – Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
• created_on (datetime , optional) – Date and time the account was created.
• account_url (str , optional) – Preferred Snowflake account URL that includes the values of organization_name and account_name.
• account_locator (str , optional) – System-assigned identifier of the acccount.
• account_locator_url (str , optional) – Legacy Snowflake account URL syntax that includes the region_name and account_locator.
• managed_accounts (int , optional) – Indicates how many managed accounts have been created by the account.
• consumption_billing_entity_name (str , optional) – Name of the consumption billing entity.
• marketplace_consumer_billing_entity_name (str , optional) – Name of the marketplace consumer billing entity.
• marketplace_provider_billing_entity_name (str , optional) – Name of the marketplace provider billing entity.
• old_account_url (str , optional) – If the original account URL was saved when the account was renamed, provides the original URL. If the original account URL was dropped, the value is NULL even if the account was renamed
• comment (str , optional) – Optional comment in which to store information related to the account.
• is_org_admin (bool , optional) – Indicates whether the ORGADMIN role is enabled in an account. If TRUE, the role is enabled.
• retention_time (int , optional) – Number of days that historical data is retained for Time Travel.
• dropped_on (datetime , optional) – Date and time the account was dropped.
• scheduled_deletion_time (datetime , optional) – Date and time when the account is scheduled to be permanently deleted. Accounts are deleted within one hour after the scheduled time.
• restored_on (datetime , optional) – Date and time when the account was last restored.
• account_old_url_saved_on (datetime , optional) – If the original account URL was saved when the account was renamed, provides the date and time when the original account URL was saved.
• account_old_url_last_used (datetime , optional) – If the original account URL was saved when the account was renamed, indicates the last time the account was accessed using the original URL.
• organization_old_url (str , optional) – If the account’s organization was changed in a way that created a new account URL and the original account URL was saved, provides the original account URL. If the original account URL was dropped, the value is NULL even if the organization changed.
• organization_old_url_saved_on (datetime , optional) – If the account’s organization was changed in a way that created a new account URL and the original account URL was saved, provides the date and time when the original account URL was saved.
• organization_old_url_last_used (datetime , optional) – If the account’s organization was changed in a way that created a new account URL and the original account URL was saved, indicates the last time the account was accessed using the original account URL.
• organization_url_expiration_on (datetime , optional) – If the account’s organization was changed in a way that created a new account URL and the original account URL was saved, provides the date and time when the original account URL will be dropped. Dropped URLs cannot be used to access the account.
• moved_on (datetime , optional) – Date and time when the account was moved to a different organization.
• is_events_account (bool , optional) – Indicates whether an account is an events account. For more information, see Set up logging and event sharing for an application.
• moved_to_organization (str , optional) – If the account was moved to a different organization, provides the name of that organization.
• admin_password (str , optional) – Password for the account administrator.
• admin_rsa_public_key (str , optional) – RSA public key for the account administrator.
• admin_user_type (str , optional) – User type of the account administrator.
• first_name (str , optional) – First name of the account administrator.
• last_name (str , optional) – Last name of the account administrator.
• must_change_password (bool , default False) – Indicates whether the account administrator must change the password at the next login.
• polaris (bool , default False) – Indicates whether the account is a Polaris account.

Methods

classmethod from_dict(obj: dict) → AccountModel¶

Creates an instance of Account from a dict.

This method constructs a Account object from a dictionary with the key-value pairs of its properties.

Parameters:

obj (dict) – A dictionary whose keys and values correspond to the properties of the resource object.

Returns:

A Account object created using the input dictionary; this will fail if the required properties are missing.

Return type:

Account

to_dict()¶

Creates a dictionary of the properties from a Account.

This method constructs a dictionary with the key-value entries corresponding to the properties of the Account object.

Returns:

A dictionary object created using the input model.

Return type:

dict