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:
-
endpoint_type
(Optional[EndpointType], default:
None
)
–
The endpoint type. Valid endpoint types include:
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.
Raises:
Source code in docs_src/capo_iot/_services/io_t.py
| def describe_endpoint(
self,
*,
config_overrides: Optional[IoTClientConfig] = None,
endpoint_type: Optional["capo_iot.types.endpoint_type.EndpointType"] = None,
) -> "capo_iot.types.describe_endpoint_response.DescribeEndpointResponse":
"""<p>Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.</p> <note> <p>The first time <code>DescribeEndpoint</code> is called, an endpoint is created. All subsequent calls to <code>DescribeEndpoint</code> return the same endpoint.</p> </note> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeEndpoint</a> action.</p>
Args:
endpoint_type: <p>The endpoint type. Valid endpoint types include:</p> <ul> <li> <p> <code>iot:Data</code> - Returns a VeriSign signed data endpoint.</p> </li> </ul> <ul> <li> <p> <code>iot:Data-ATS</code> - Returns an ATS signed data endpoint.</p> </li> </ul> <ul> <li> <p> <code>iot:CredentialProvider</code> - Returns an IoT credentials provider API endpoint.</p> </li> </ul> <ul> <li> <p> <code>iot:Jobs</code> - Returns an IoT device management Jobs API endpoint.</p> </li> </ul> <p>We strongly recommend that customers use the newer <code>iot:Data-ATS</code> 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.</p>
Raises:
capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iot.types.describe_endpoint_request.DescribeEndpointRequest]",
) -> OperationResponse[
"capo_iot.types.describe_endpoint_response.DescribeEndpointResponse"
]:
import capo_iot._operations.aws_iot_service.describe_endpoint
output, http_response = (
capo_iot._operations.aws_iot_service.describe_endpoint.describe_endpoint(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeEndpoint")
)
input_: capo_iot.types.describe_endpoint_request.DescribeEndpointRequest = {}
if endpoint_type is not None:
input_["endpoint_type"] = endpoint_type
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|