snowflake.core.api_integration.AwsHook¶

class snowflake.core.api_integration.AwsHook(*, api_provider: Annotated[str, Strict(strict=True)], api_aws_role_arn: Annotated[str, Strict(strict=True)], api_key: Annotated[str, Strict(strict=True)] | None = None)¶

Bases: ApiHook

A model object representing the AwsHook resource.

Constructs an object of type AwsHook with the provided properties.

Parameters:

  • api_provider (str)

  • api_aws_role_arn (str) – The ARN (Amazon resource name) of the IAM role.

  • api_key (str, optional) – An alphanumeric string that is used to identify API clients and control access to the API, also called a subscription key.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

classmethod from_dict(obj: dict) → AwsHook¶

Create an instance of AwsHook from a dict.

classmethod from_json(json_str: str) → AwsHook¶

Create an instance of AwsHook from a JSON string.

to_dict(hide_readonly_properties: bool = False) → dict[str, Any]¶

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() → dict[str, Any]¶

Return the dictionary representation of the model without readonly properties.

to_json() → str¶

Returns the JSON representation of the model using alias.

to_str() → str¶

Returns the string representation of the model using alias.

Language: English