Skip to content

describe_scheduled_query

describe_scheduled_query(
    scheduled_query_arn: AmazonResourceName,
    *,
    config_overrides: Optional[TimestreamQueryClientConfig] = None,
) -> DescribeScheduledQueryResponse

Provides detailed information about a scheduled query.

Parameters:

Raises:

Source code in docs_src/capo_timestream_query/_services/timestream_query.py
def describe_scheduled_query(
    self,
    scheduled_query_arn: "capo_timestream_query.types.amazon_resource_name.AmazonResourceName",
    *,
    config_overrides: Optional[TimestreamQueryClientConfig] = None,
) -> "capo_timestream_query.types.describe_scheduled_query_response.DescribeScheduledQueryResponse":
    """<p>Provides detailed information about a scheduled query.</p>

    Args:
        scheduled_query_arn: <p>The ARN of the scheduled query.</p>

    Raises:
        capo_timestream_query.errors.access_denied_exception.AccessDeniedException: <p>You do not have the necessary permissions to access the account settings.</p>
        capo_timestream_query.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred while processing the request.</p>
        capo_timestream_query.errors.invalid_endpoint_exception.InvalidEndpointException: <p>The requested endpoint is invalid.</p>
        capo_timestream_query.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_timestream_query.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to excessive requests.</p>
        capo_timestream_query.errors.validation_exception.ValidationException: <p> Invalid or malformed request. </p>
        capo_timestream_query.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_timestream_query.types.describe_scheduled_query_request.DescribeScheduledQueryRequest]",
    ) -> OperationResponse[
        "capo_timestream_query.types.describe_scheduled_query_response.DescribeScheduledQueryResponse"
    ]:
        import capo_timestream_query._operations.timestream_20181101.describe_scheduled_query

        output, http_response = (
            capo_timestream_query._operations.timestream_20181101.describe_scheduled_query.describe_scheduled_query(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_timestream_query.types.describe_scheduled_query_response.DescribeScheduledQueryResponse",
    ) -> dict[str, Any]:
        import capo_timestream_query.types.describe_scheduled_query_response

        return capo_timestream_query.types.describe_scheduled_query_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeScheduledQuery", redact_output=_redact_output),
    )
    input_: capo_timestream_query.types.describe_scheduled_query_request.DescribeScheduledQueryRequest = {
        "scheduled_query_arn": scheduled_query_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output