Gets information about an Device Advisor endpoint.
Parameters:
Raises:
Source code in docs_src/capo_iotdeviceadvisor/_services/iot_device_advisor.py
| def get_endpoint(
self,
*,
config_overrides: Optional[IotDeviceAdvisorClientConfig] = None,
thing_arn: Optional[
"capo_iotdeviceadvisor.types.amazon_resource_name.AmazonResourceName"
] = None,
certificate_arn: Optional[
"capo_iotdeviceadvisor.types.amazon_resource_name.AmazonResourceName"
] = None,
device_role_arn: Optional[
"capo_iotdeviceadvisor.types.amazon_resource_name.AmazonResourceName"
] = None,
authentication_method: Optional[
"capo_iotdeviceadvisor.types.authentication_method.AuthenticationMethod"
] = None,
) -> "capo_iotdeviceadvisor.types.get_endpoint_response.GetEndpointResponse":
"""<p>Gets information about an Device Advisor endpoint.</p>
Args:
thing_arn: <p>The thing ARN of the device. This is an optional parameter.</p>
certificate_arn: <p>The certificate ARN of the device. This is an optional parameter.</p>
device_role_arn: <p>The device role ARN of the device. This is an optional parameter.</p>
authentication_method: <p>The authentication method used during the device connection.</p>
Raises:
capo_iotdeviceadvisor.errors.internal_server_exception.InternalServerException: <p>Sends an Internal Failure exception.</p>
capo_iotdeviceadvisor.errors.resource_not_found_exception.ResourceNotFoundException: <p>Sends a Resource Not Found exception.</p>
capo_iotdeviceadvisor.errors.validation_exception.ValidationException: <p>Sends a validation exception.</p>
capo_iotdeviceadvisor.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iotdeviceadvisor.types.get_endpoint_request.GetEndpointRequest]",
) -> OperationResponse[
"capo_iotdeviceadvisor.types.get_endpoint_response.GetEndpointResponse"
]:
import capo_iotdeviceadvisor._operations.iot_senate_service.get_endpoint
output, http_response = (
capo_iotdeviceadvisor._operations.iot_senate_service.get_endpoint.get_endpoint(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetEndpoint")
)
input_: capo_iotdeviceadvisor.types.get_endpoint_request.GetEndpointRequest = {}
if thing_arn is not None:
input_["thing_arn"] = thing_arn
if certificate_arn is not None:
input_["certificate_arn"] = certificate_arn
if device_role_arn is not None:
input_["device_role_arn"] = device_role_arn
if authentication_method is not None:
input_["authentication_method"] = authentication_method
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|