Class: Aws::CloudTrail::Types::DescribeQueryResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudtrail/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_s3_uri ⇒ String

The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

Returns:

  • (String) 


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 1433

class DescribeQueryResponse < Struct.new(
  :query_id,
  :query_string,
  :query_status,
  :query_statistics,
  :error_message,
  :delivery_s3_uri,
  :delivery_status,
  :prompt)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_status ⇒ String

The delivery status.

Returns:

  • (String) 


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 1433

class DescribeQueryResponse < Struct.new(
  :query_id,
  :query_string,
  :query_status,
  :query_statistics,
  :error_message,
  :delivery_s3_uri,
  :delivery_status,
  :prompt)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

The error message returned if a query failed.

Returns:

  • (String) 


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 1433

class DescribeQueryResponse < Struct.new(
  :query_id,
  :query_string,
  :query_status,
  :query_statistics,
  :error_message,
  :delivery_s3_uri,
  :delivery_status,
  :prompt)
  SENSITIVE = []
  include Aws::Structure
end

#prompt ⇒ String

The prompt used for a generated query. For information about generated queries, see [Create CloudTrail Lake queries from natural language prompts] in the CloudTrail user guide.

[1]: docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-query-generator.html

Returns:

  • (String) 


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 1433

class DescribeQueryResponse < Struct.new(
  :query_id,
  :query_string,
  :query_status,
  :query_statistics,
  :error_message,
  :delivery_s3_uri,
  :delivery_status,
  :prompt)
  SENSITIVE = []
  include Aws::Structure
end

#query_id ⇒ String

The ID of the query.

Returns:

  • (String) 


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 1433

class DescribeQueryResponse < Struct.new(
  :query_id,
  :query_string,
  :query_status,
  :query_statistics,
  :error_message,
  :delivery_s3_uri,
  :delivery_status,
  :prompt)
  SENSITIVE = []
  include Aws::Structure
end

#query_statistics ⇒ Types::QueryStatisticsForDescribeQuery

Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query’s creation time.

Returns:



1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 1433

class DescribeQueryResponse < Struct.new(
  :query_id,
  :query_string,
  :query_status,
  :query_statistics,
  :error_message,
  :delivery_s3_uri,
  :delivery_status,
  :prompt)
  SENSITIVE = []
  include Aws::Structure
end

#query_status ⇒ String

The status of a query. Values for ‘QueryStatus` include `QUEUED`, `RUNNING`, `FINISHED`, `FAILED`, `TIMED_OUT`, or `CANCELLED`

Returns:

  • (String) 


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 1433

class DescribeQueryResponse < Struct.new(
  :query_id,
  :query_string,
  :query_status,
  :query_statistics,
  :error_message,
  :delivery_s3_uri,
  :delivery_status,
  :prompt)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

The SQL code of a query.

Returns:

  • (String) 


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 1433

class DescribeQueryResponse < Struct.new(
  :query_id,
  :query_string,
  :query_status,
  :query_statistics,
  :error_message,
  :delivery_s3_uri,
  :delivery_status,
  :prompt)
  SENSITIVE = []
  include Aws::Structure
end