You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::CloudTrail::Client

Inherits:
AWS::Core::QueryClient show all
Defined in:
lib/aws/cloud_trail/client.rb

Direct Known Subclasses

V20131101

Defined Under Namespace

Classes: V20131101

Constant Summary

API_VERSION = 
'2013-11-01'

Instance Attribute Summary

Attributes inherited from AWS::Core::Client

#config

Instance Method Summary collapse

Methods inherited from AWS::Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#create_trail(options = {}) ⇒ Core::Response

Calls the CreateTrail API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :name - required - (String) Specifies the name of the trail.
    • :s3_bucket_name - required - (String) Specifies the name of the Amazon S3 bucket designated for publishing log files.
    • :s3_key_prefix - (String) Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
    • :sns_topic_name - (String) Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
    • :include_global_service_events - (Boolean) Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :name - (String)
    • :s3_bucket_name - (String)
    • :s3_key_prefix - (String)
    • :sns_topic_name - (String)
    • :include_global_service_events - (Boolean)

#delete_trail(options = {}) ⇒ Core::Response

Calls the DeleteTrail API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :name - required - (String) The name of a trail to be deleted.

Returns:

#describe_trails(options = {}) ⇒ Core::Response

Calls the DescribeTrails API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :trail_name_list - (Array<) The trail returned.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :trail_list - (Array)
      • :name - (String)
      • :s3_bucket_name - (String)
      • :s3_key_prefix - (String)
      • :sns_topic_name - (String)
      • :include_global_service_events - (Boolean)

#get_trail_status(options = {}) ⇒ Core::Response

Calls the GetTrailStatus API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :name - required - (String) The name of the trail for which you are requesting the current status.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :is_logging - (Boolean)
    • :latest_delivery_error - (String)
    • :latest_notification_error - (String)
    • :latest_delivery_time - (Time)
    • :latest_notification_time - (Time)
    • :start_logging_time - (Time)
    • :stop_logging_time - (Time)

#start_logging(options = {}) ⇒ Core::Response

Calls the StartLogging API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :name - required - (String) The name of the trail for which CloudTrail logs AWS API calls.

Returns:

#stop_logging(options = {}) ⇒ Core::Response

Calls the StopLogging API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :name - required - (String) Communicates to CloudTrail the name of the trail for which to stop logging AWS API calls.

Returns:

#update_trail(options = {}) ⇒ Core::Response

Calls the UpdateTrail API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :name - required - (String) Specifies the name of the trail.
    • :s3_bucket_name - (String) Specifies the name of the Amazon S3 bucket designated for publishing log files.
    • :s3_key_prefix - (String) Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
    • :sns_topic_name - (String) Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
    • :include_global_service_events - (Boolean) Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :name - (String)
    • :s3_bucket_name - (String)
    • :s3_key_prefix - (String)
    • :sns_topic_name - (String)
    • :include_global_service_events - (Boolean)