describeEndpoint method

Future<DescribeEndpointResponse> describeEndpoint({ String? endpointType, })

Returns a unique endpoint specific to the AWS account making the call.

May throw InternalFailureException. May throw InvalidRequestException. May throw UnauthorizedException. May throw ThrottlingException.

Parameter endpointType : 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 AWS IoT credentials provider API endpoint.

• iot:Jobs - Returns an AWS 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.

Implementation

Future<DescribeEndpointResponse> describeEndpoint({
  String? endpointType,
}) async {
  _s.validateStringLength(
    'endpointType',
    endpointType,
    0,
    128,
  );
  final $query = <String, List<String>>{
    if (endpointType != null) 'endpointType': [endpointType],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/endpoint',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeEndpointResponse.fromJson(response);
}