snowflake.core.password_policy.PasswordPolicyResource

class snowflake.core.password_policy.PasswordPolicyResource(name: str, collection_class: PasswordPolicyCollectionBase)

Bases: PasswordPolicyResourceBase

Represents a reference to a Snowflake password policy.

With this password policy reference, you can fetch information about a password policy, as well as perform certain actions on it.

Attributes

database

The DatabaseResource this reference belongs to.

fully_qualified_name

Return the fully qualified name of the object this reference points to.

root

The Root object this reference belongs to.

Methods

drop(if_exists: bool | None = None) → None

Delete a password policy.

Parameters:

if_exists (bool) – Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist.

drop_async(if_exists: bool | None = None) → PollingOperation[None]

An asynchronous version of drop().

Refer to PollingOperation for more information on asynchronous execution and the return type.

fetch() → PasswordPolicy

Fetch a password policy.

fetch_async() → PollingOperation[PasswordPolicy]

An asynchronous version of fetch().

Refer to PollingOperation for more information on asynchronous execution and the return type.

get_tags(with_lineage: bool | None = None) → dict[TagResource, TagValue]

Get the tag assignments for a password policy.

Returns all tags assigned to a password policy. This operation requires an active warehouse.

Parameters:

with_lineage (bool) – Parameter that specifies whether tag assignments inherited by the object from its ancestors in securable object hierarchy should be returned as well: - true: All tags assigned to this object should be returned, inheritance included. - false: Only tags explicitly assigned to this object should be returned.

get_tags_async(with_lineage: bool | None = None) → PollingOperation[dict[TagResource, TagValue]]

An asynchronous version of get_tags().

Refer to PollingOperation for more information on asynchronous execution and the return type.

rename(target_name: str, if_exists: bool | None = None, target_database: str | None = None, target_schema: str | None = None) → None

Rename a password policy with a new identifier.

Parameters:

  • target_name (str) – Name of the target resource. (required)

  • if_exists (bool) – Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist.

  • target_database (str) – Database of the target resource. Defaults to the source’s database

  • target_schema (str) – Schema of the target resource. Defaults to the source’s schema

rename_async(target_name: str, if_exists: bool | None = None, target_database: str | None = None, target_schema: str | None = None) → PollingOperation[None]

An asynchronous version of rename().

Refer to PollingOperation for more information on asynchronous execution and the return type.

set_tags(tags: dict[TagResource, TagValue], if_exists: bool | None = None) → None

Set tags on a password policy.

Parameters:

  • tags (dict[TagResource, TagValue]) – (required)

  • if_exists (bool) – Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist.

set_tags_async(tags: dict[TagResource, TagValue], if_exists: bool | None = None) → PollingOperation[None]

An asynchronous version of set_tags().

Refer to PollingOperation for more information on asynchronous execution and the return type.

unset_tags(tag_resources: set[TagResource], if_exists: bool | None = None) → None

Unset tags from a password policy.

Parameters:

  • tag_resources (set[TagResource]) – (required)

  • if_exists (bool) – Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist.

unset_tags_async(tag_resources: set[TagResource], if_exists: bool | None = None) → PollingOperation[None]

An asynchronous version of unset_tags().

Refer to PollingOperation for more information on asynchronous execution and the return type.

Language: English