endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Name	endpoints
Type	Resource
Id	aws.iotdeviceadvisor.endpoints

Fields

The following fields are returned by SELECT queries:

get_endpoint

Name	Datatype	Description
endpoint	string	The response of an Device Advisor endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_endpoint	select	region	thingArn, certificateArn, deviceRoleArn, authenticationMethod	Gets information about an Device Advisor endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
authenticationMethod	string	The authentication method used during the device connection.
certificateArn	string	The certificate ARN of the device. This is an optional parameter.
deviceRoleArn	string	The device role ARN of the device. This is an optional parameter.
thingArn	string	The thing ARN of the device. This is an optional parameter.

SELECT examples

get_endpoint

Gets information about an Device Advisor endpoint.

SELECT
endpoint
FROM aws.iotdeviceadvisor.endpoints
WHERE region = '{{ region }}' -- required
AND thingArn = '{{ thingArn }}'
AND certificateArn = '{{ certificateArn }}'
AND deviceRoleArn = '{{ deviceRoleArn }}'
AND authenticationMethod = '{{ authenticationMethod }}'
;