endpoints

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

Overview

Name	endpoints
Type	Resource
Id	aws.iot.endpoints

Fields

The following fields are returned by SELECT queries:

describe_endpoint

Name	Datatype	Description
endpoint_address	string	The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_endpoint	select	region	endpointType	Returns or creates a unique endpoint specific to the Amazon Web Services account making the call. The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint. Requires permission to access the DescribeEndpoint action.

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)
endpointType	string	The endpoint type. Valid endpoint types include: iot:Data - Returns a VeriSign signed data endpoint. iot:Data-ATS - Returns an ATS signed data endpoint. iot:CredentialProvider - Returns an IoT credentials provider API endpoint. iot:Jobs - Returns an IoT device management Jobs API endpoint. We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities. ATS Signed Certificates are more secure and are trusted by most popular browsers.

SELECT examples

describe_endpoint

Returns or creates a unique endpoint specific to the Amazon Web Services account making the call. The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint. Requires permission to access the DescribeEndpoint action.

SELECT
endpoint_address
FROM aws.iot.endpoints
WHERE region = '{{ region }}' -- required
AND endpointType = '{{ endpointType }}'
;