Contents

module Fog
  module Storage
    class AWS
      class Real
        require 'fog/aws/parsers/storage/get_bucket_logging'

        # Get logging status for an S3 bucket
        #
        # @param bucket_name [String] name of bucket to get logging status for
        #
        # @return [Excon::Response] response:
        #   * body [Hash]:
        #     * BucketLoggingStatus (will be empty if logging is disabled) [Hash]:
        #       * LoggingEnabled [Hash]:
        #         * TargetBucket [String] - bucket where logs are stored
        #         * TargetPrefix [String] - prefix logs are stored with
        #         * TargetGrants [Array]:
        #           * Grant [Hash]:
        #             * Grantee [Hash]:
        #               * DisplayName [String] - Display name of grantee
        #               * ID [String] - Id of grantee
        #               or
        #               * URI [String] - URI of group to grant access for
        #             * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
        #
        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html

        def get_bucket_logging(bucket_name)
          unless bucket_name
            raise ArgumentError.new('bucket_name is required')
          end
          request({
            :expects    => 200,
            :headers    => {},
            :bucket_name => bucket_name,
            :idempotent => true,
            :method     => 'GET',
            :parser     => Fog::Parsers::Storage::AWS::GetBucketLogging.new,
            :query      => {'logging' => nil}
          })
        end
      end
    end
  end
end

Version data entries

61 entries across 59 versions & 6 rubygems

Version	Path
fog-1.22.1	lib/fog/aws/requests/storage/get_bucket_logging.rb