Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.aws Namespace Reference

Namespaces

 config_flow
 
 const
 
 notify
 

Functions

def _validate_aws_credentials (hass, credential)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 AWS_CREDENTIAL_SCHEMA
 
 CONFIG_SCHEMA
 
list DEFAULT_CREDENTIAL
 
 NOTIFY_PLATFORM_SCHEMA
 
list SUPPORTED_SERVICES = ["lambda", "sns", "sqs", "events"]
 

Detailed Description

Support for Amazon Web Services (AWS).

Function Documentation

◆ _validate_aws_credentials()

def homeassistant.components.aws._validate_aws_credentials (   hass,
  credential 
)
private
Validate AWS credential config.

Definition at line 160 of file __init__.py.

◆ async_setup()

bool homeassistant.components.aws.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up AWS component.

Definition at line 89 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.aws.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Load a config entry.

Validate and save sessions per aws credential.

Definition at line 109 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.aws._LOGGER = logging.getLogger(__name__)
private

Definition at line 39 of file __init__.py.

◆ AWS_CREDENTIAL_SCHEMA

homeassistant.components.aws.AWS_CREDENTIAL_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_NAME): cv.string,
4  vol.Inclusive(CONF_ACCESS_KEY_ID, ATTR_CREDENTIALS): cv.string,
5  vol.Inclusive(CONF_SECRET_ACCESS_KEY, ATTR_CREDENTIALS): cv.string,
6  vol.Exclusive(CONF_PROFILE_NAME, ATTR_CREDENTIALS): cv.string,
7  vol.Optional(CONF_VALIDATE, default=True): cv.boolean,
8  }
9 )

Definition at line 41 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.aws.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Optional(CONF_CREDENTIALS, default=DEFAULT_CREDENTIAL): vol.All(
6  cv.ensure_list, [AWS_CREDENTIAL_SCHEMA]
7  ),
8  vol.Optional(CONF_NOTIFY, default=[]): vol.All(
9  cv.ensure_list, [NOTIFY_PLATFORM_SCHEMA]
10  ),
11  }
12  )
13  },
14  extra=vol.ALLOW_EXTRA,
15 )

Definition at line 72 of file __init__.py.

◆ DEFAULT_CREDENTIAL

list homeassistant.components.aws.DEFAULT_CREDENTIAL
Initial value:
1 = [
2  {CONF_NAME: "default", CONF_PROFILE_NAME: "default", CONF_VALIDATE: False}
3 ]

Definition at line 51 of file __init__.py.

◆ NOTIFY_PLATFORM_SCHEMA

homeassistant.components.aws.NOTIFY_PLATFORM_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_NAME): cv.string,
4  vol.Required(CONF_SERVICE): vol.All(
5  cv.string, vol.Lower, vol.In(SUPPORTED_SERVICES)
6  ),
7  vol.Required(CONF_REGION): vol.All(cv.string, vol.Lower),
8  vol.Inclusive(CONF_ACCESS_KEY_ID, ATTR_CREDENTIALS): cv.string,
9  vol.Inclusive(CONF_SECRET_ACCESS_KEY, ATTR_CREDENTIALS): cv.string,
10  vol.Exclusive(CONF_PROFILE_NAME, ATTR_CREDENTIALS): cv.string,
11  vol.Exclusive(CONF_CREDENTIAL_NAME, ATTR_CREDENTIALS): cv.string,
12  vol.Optional(CONF_CONTEXT): vol.Coerce(dict),
13  }
14 )

Definition at line 57 of file __init__.py.

◆ SUPPORTED_SERVICES

list homeassistant.components.aws.SUPPORTED_SERVICES = ["lambda", "sns", "sqs", "events"]

Definition at line 55 of file __init__.py.