awsiot.greengrass_discovery

class awsiot.greengrass_discovery.DiscoveryClient(bootstrap, socket_options, tls_context, region, gg_server_name=None, proxy_options=None)

Bases: object

Client which performs Greengrass discovery.

Parameters:
  • bootstrap (ClientBootstrap) – Client bootstrap

  • socket_options (SocketOptions) – Socket options

  • tls_context (ClientTlsContext) – Client TLS context

  • region (str) – AWS region (not used if gg_server_name is set)

  • gg_server_name (str) – optional full server name

  • proxy_options (HttpProxyOptions) – Proxy options (if None is provided then a proxy is not used)

discover(thing_name)

Perform discovery.

This is an asynchronous operation.

Returns:

Future a Future which will contain a result of DiscoverResponse on success, or an exception on failure.

Parameters:

thing_name (str) –

Return type:

Future

exception awsiot.greengrass_discovery.DiscoveryException(message, response_code)

Bases: Exception

Discovery response was an error.

Parameters:
  • message (str) –

  • response_code (int) –

http_response_code: int

HTTP response code

message: str

Message

class awsiot.greengrass_discovery.ConnectivityInfo

Bases: ModeledClass

Connectivity info

id

ID

host_address

Port address

metadata

Metadata

port

Port

class awsiot.greengrass_discovery.GGCore

Bases: ModeledClass

Greengrass Core

thing_arn

Thing ARN

connectivity

List of ConnectivityInfo

class awsiot.greengrass_discovery.GGGroup

Bases: ModeledClass

Greengrass group

gg_group_id

Greengrass group ID

cores

List of GGCore

certificate_authorities

List of strings

class awsiot.greengrass_discovery.DiscoverResponse

Bases: ModeledClass

Discovery response

gg_groups: List[GGGroup] | None

List of GGGroup