Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
Parameters:
-
scheduled_audit_name
(ScheduledAuditName)
–
The name of the scheduled audit whose information you want to get.
Raises:
Source code in docs_src/capo_iot/_services/async_io_t.py
| async def describe_scheduled_audit(
self,
scheduled_audit_name: "capo_iot.types.scheduled_audit_name.ScheduledAuditName",
*,
config_overrides: Optional[AsyncIoTClientConfig] = None,
) -> "capo_iot.types.describe_scheduled_audit_response.DescribeScheduledAuditResponse":
"""<p>Gets information about a scheduled audit.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeScheduledAudit</a> action.</p>
Args:
scheduled_audit_name: <p>The name of the scheduled audit whose information you want to get.</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.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_iot.types.describe_scheduled_audit_request.DescribeScheduledAuditRequest]",
) -> AsyncOperationResponse[
"capo_iot.types.describe_scheduled_audit_response.DescribeScheduledAuditResponse"
]:
import capo_iot._operations.aws_iot_service.describe_scheduled_audit
(
output,
http_response,
) = await capo_iot._operations.aws_iot_service.describe_scheduled_audit.async_describe_scheduled_audit(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeScheduledAudit")
)
input_: capo_iot.types.describe_scheduled_audit_request.DescribeScheduledAuditRequest = {
"scheduled_audit_name": scheduled_audit_name
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|