api_op_DescribeQueries.go 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. // Code generated by smithy-go-codegen DO NOT EDIT.
  2. package cloudwatchlogs
  3. import (
  4. "context"
  5. awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
  6. "github.com/aws/aws-sdk-go-v2/aws/signer/v4"
  7. "github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs/types"
  8. "github.com/aws/smithy-go/middleware"
  9. smithyhttp "github.com/aws/smithy-go/transport/http"
  10. )
  11. // Returns a list of CloudWatch Logs Insights queries that are scheduled,
  12. // executing, or have been executed recently in this account. You can request all
  13. // queries or limit it to queries of a specific log group or queries with a certain
  14. // status.
  15. func (c *Client) DescribeQueries(ctx context.Context, params *DescribeQueriesInput, optFns ...func(*Options)) (*DescribeQueriesOutput, error) {
  16. if params == nil {
  17. params = &DescribeQueriesInput{}
  18. }
  19. result, metadata, err := c.invokeOperation(ctx, "DescribeQueries", params, optFns, c.addOperationDescribeQueriesMiddlewares)
  20. if err != nil {
  21. return nil, err
  22. }
  23. out := result.(*DescribeQueriesOutput)
  24. out.ResultMetadata = metadata
  25. return out, nil
  26. }
  27. type DescribeQueriesInput struct {
  28. // Limits the returned queries to only those for the specified log group.
  29. LogGroupName *string
  30. // Limits the number of returned queries to the specified number.
  31. MaxResults *int32
  32. // The token for the next set of items to return. The token expires after 24 hours.
  33. NextToken *string
  34. // Limits the returned queries to only those that have the specified status. Valid
  35. // values are Cancelled, Complete, Failed, Running, and Scheduled.
  36. Status types.QueryStatus
  37. noSmithyDocumentSerde
  38. }
  39. type DescribeQueriesOutput struct {
  40. // The token for the next set of items to return. The token expires after 24 hours.
  41. NextToken *string
  42. // The list of queries that match the request.
  43. Queries []types.QueryInfo
  44. // Metadata pertaining to the operation's result.
  45. ResultMetadata middleware.Metadata
  46. noSmithyDocumentSerde
  47. }
  48. func (c *Client) addOperationDescribeQueriesMiddlewares(stack *middleware.Stack, options Options) (err error) {
  49. err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeQueries{}, middleware.After)
  50. if err != nil {
  51. return err
  52. }
  53. err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeQueries{}, middleware.After)
  54. if err != nil {
  55. return err
  56. }
  57. if err = addSetLoggerMiddleware(stack, options); err != nil {
  58. return err
  59. }
  60. if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
  61. return err
  62. }
  63. if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
  64. return err
  65. }
  66. if err = addResolveEndpointMiddleware(stack, options); err != nil {
  67. return err
  68. }
  69. if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
  70. return err
  71. }
  72. if err = addRetryMiddlewares(stack, options); err != nil {
  73. return err
  74. }
  75. if err = addHTTPSignerV4Middleware(stack, options); err != nil {
  76. return err
  77. }
  78. if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
  79. return err
  80. }
  81. if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
  82. return err
  83. }
  84. if err = addClientUserAgent(stack); err != nil {
  85. return err
  86. }
  87. if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
  88. return err
  89. }
  90. if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
  91. return err
  92. }
  93. if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeQueries(options.Region), middleware.Before); err != nil {
  94. return err
  95. }
  96. if err = addRequestIDRetrieverMiddleware(stack); err != nil {
  97. return err
  98. }
  99. if err = addResponseErrorMiddleware(stack); err != nil {
  100. return err
  101. }
  102. if err = addRequestResponseLogging(stack, options); err != nil {
  103. return err
  104. }
  105. return nil
  106. }
  107. func newServiceMetadataMiddleware_opDescribeQueries(region string) *awsmiddleware.RegisterServiceMetadata {
  108. return &awsmiddleware.RegisterServiceMetadata{
  109. Region: region,
  110. ServiceID: ServiceID,
  111. SigningName: "logs",
  112. OperationName: "DescribeQueries",
  113. }
  114. }