-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon CloudTrail SDK.
--
-- CloudTrail is a web service that records AWS API calls for your AWS
-- account and delivers log files to an Amazon S3 bucket. The recorded
-- information includes the identity of the user, the start time of the
-- AWS API call, the source IP address, the request parameters, and the
-- response elements returned by the service.
--
-- See: AWS API Reference
--
-- Warning: This is an experimental preview release which is still
-- under heavy development and not intended for public consumption,
-- caveat emptor!
@package amazonka-cloudtrail
@version 0.2.2
module Network.AWS.CloudTrail.Types
-- | Version 2013-11-01 of the Amazon CloudTrail service.
data CloudTrail
data JSONError :: *
data Trail
-- | Trail constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
trail :: Trail
-- | Specifies an Amazon Resource Name (ARN), a unique identifier that
-- represents the log group to which CloudTrail logs will be delivered.
tCloudWatchLogsLogGroupArn :: Lens' Trail (Maybe Text)
-- | Specifies the role for the CloudWatch Logs endpoint to assume to write
-- to a user’s log group.
tCloudWatchLogsRoleArn :: Lens' Trail (Maybe Text)
-- | Set to True to include AWS API calls from AWS global services such as
-- IAM. Otherwise, False.
tIncludeGlobalServiceEvents :: Lens' Trail (Maybe Bool)
-- | Name of the trail set by calling CreateTrail.
tName :: Lens' Trail (Maybe Text)
-- | Name of the Amazon S3 bucket into which CloudTrail delivers your trail
-- files.
tS3BucketName :: Lens' Trail (Maybe Text)
-- | Value of the Amazon S3 prefix.
tS3KeyPrefix :: Lens' Trail (Maybe Text)
-- | Name of the existing Amazon SNS topic that CloudTrail uses to notify
-- the account owner when new CloudTrail log files have been delivered.
tSnsTopicName :: Lens' Trail (Maybe Text)
instance Eq Trail
instance Ord Trail
instance Read Trail
instance Show Trail
instance ToJSON Trail
instance FromJSON Trail
instance AWSService CloudTrail
-- | From the command line, use 'update-subscription'.
--
-- Updates the settings that specify delivery of log files. Changes to a
-- trail do not require stopping the CloudTrail service. Use this action
-- to designate an existing bucket for log delivery. If the existing
-- bucket has previously been a target for CloudTrail log files, an IAM
-- policy exists for the bucket.
--
--
-- http://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_UpdateTrail.html
module Network.AWS.CloudTrail.UpdateTrail
data UpdateTrail
-- | UpdateTrail constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
updateTrail :: Text -> UpdateTrail
-- | Specifies a log group name using an Amazon Resource Name (ARN), a
-- unique identifier that represents the log group to which CloudTrail
-- logs will be delivered. Not required unless you specify
-- CloudWatchLogsRoleArn.
utCloudWatchLogsLogGroupArn :: Lens' UpdateTrail (Maybe Text)
-- | Specifies the role for the CloudWatch Logs endpoint to assume to write
-- to a user’s log group.
utCloudWatchLogsRoleArn :: Lens' UpdateTrail (Maybe Text)
-- | Specifies whether the trail is publishing events from global services
-- such as IAM to the log files.
utIncludeGlobalServiceEvents :: Lens' UpdateTrail (Maybe Bool)
-- | Specifies the name of the trail.
utName :: Lens' UpdateTrail Text
-- | Specifies the name of the Amazon S3 bucket designated for publishing
-- log files.
utS3BucketName :: Lens' UpdateTrail (Maybe Text)
-- | Specifies the Amazon S3 key prefix that precedes the name of the
-- bucket you have designated for log file delivery.
utS3KeyPrefix :: Lens' UpdateTrail (Maybe Text)
-- | Specifies the name of the Amazon SNS topic defined for notification of
-- log file delivery.
utSnsTopicName :: Lens' UpdateTrail (Maybe Text)
data UpdateTrailResponse
-- | UpdateTrailResponse constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
updateTrailResponse :: UpdateTrailResponse
-- | Specifies the Amazon Resource Name (ARN) of the log group to which
-- CloudTrail logs will be delivered.
utrCloudWatchLogsLogGroupArn :: Lens' UpdateTrailResponse (Maybe Text)
-- | Specifies the role for the CloudWatch Logs endpoint to assume to write
-- to a user’s log group.
utrCloudWatchLogsRoleArn :: Lens' UpdateTrailResponse (Maybe Text)
-- | Specifies whether the trail is publishing events from global services
-- such as IAM to the log files.
utrIncludeGlobalServiceEvents :: Lens' UpdateTrailResponse (Maybe Bool)
-- | Specifies the name of the trail.
utrName :: Lens' UpdateTrailResponse (Maybe Text)
-- | Specifies the name of the Amazon S3 bucket designated for publishing
-- log files.
utrS3BucketName :: Lens' UpdateTrailResponse (Maybe Text)
-- | Specifies the Amazon S3 key prefix that precedes the name of the
-- bucket you have designated for log file delivery.
utrS3KeyPrefix :: Lens' UpdateTrailResponse (Maybe Text)
-- | Specifies the name of the Amazon SNS topic defined for notification of
-- log file delivery.
utrSnsTopicName :: Lens' UpdateTrailResponse (Maybe Text)
instance Eq UpdateTrail
instance Ord UpdateTrail
instance Read UpdateTrail
instance Show UpdateTrail
instance Eq UpdateTrailResponse
instance Ord UpdateTrailResponse
instance Read UpdateTrailResponse
instance Show UpdateTrailResponse
instance FromJSON UpdateTrailResponse
instance AWSRequest UpdateTrail
instance ToJSON UpdateTrail
instance ToHeaders UpdateTrail
instance ToQuery UpdateTrail
instance ToPath UpdateTrail
-- | Suspends the recording of AWS API calls and log file delivery for the
-- specified trail. Under most circumstances, there is no need to use
-- this action. You can update a trail without stopping it first. This
-- action is the only way to stop recording.
--
--
-- http://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_StopLogging.html
module Network.AWS.CloudTrail.StopLogging
data StopLogging
-- | StopLogging constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
stopLogging :: Text -> StopLogging
-- | Communicates to CloudTrail the name of the trail for which to stop
-- logging AWS API calls.
slName :: Lens' StopLogging Text
data StopLoggingResponse
-- | StopLoggingResponse constructor.
stopLoggingResponse :: StopLoggingResponse
instance Eq StopLogging
instance Ord StopLogging
instance Read StopLogging
instance Show StopLogging
instance Monoid StopLogging
instance IsString StopLogging
instance Eq StopLoggingResponse
instance Ord StopLoggingResponse
instance Read StopLoggingResponse
instance Show StopLoggingResponse
instance Generic StopLoggingResponse
instance Datatype D1StopLoggingResponse
instance Constructor C1_0StopLoggingResponse
instance AWSRequest StopLogging
instance ToJSON StopLogging
instance ToHeaders StopLogging
instance ToQuery StopLogging
instance ToPath StopLogging
-- | Starts the recording of AWS API calls and log file delivery for a
-- trail.
--
--
-- http://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_StartLogging.html
module Network.AWS.CloudTrail.StartLogging
data StartLogging
-- | StartLogging constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
startLogging :: Text -> StartLogging
-- | The name of the trail for which CloudTrail logs AWS API calls.
sl1Name :: Lens' StartLogging Text
data StartLoggingResponse
-- | StartLoggingResponse constructor.
startLoggingResponse :: StartLoggingResponse
instance Eq StartLogging
instance Ord StartLogging
instance Read StartLogging
instance Show StartLogging
instance Monoid StartLogging
instance IsString StartLogging
instance Eq StartLoggingResponse
instance Ord StartLoggingResponse
instance Read StartLoggingResponse
instance Show StartLoggingResponse
instance Generic StartLoggingResponse
instance Datatype D1StartLoggingResponse
instance Constructor C1_0StartLoggingResponse
instance AWSRequest StartLogging
instance ToJSON StartLogging
instance ToHeaders StartLogging
instance ToQuery StartLogging
instance ToPath StartLogging
-- | Returns a JSON-formatted list of information about the specified
-- trail. Fields include information on delivery errors, Amazon SNS and
-- Amazon S3 errors, and start and stop logging times for each trail.
--
--
-- http://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_GetTrailStatus.html
module Network.AWS.CloudTrail.GetTrailStatus
data GetTrailStatus
-- | GetTrailStatus constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
getTrailStatus :: Text -> GetTrailStatus
-- | The name of the trail for which you are requesting the current status.
gtsName :: Lens' GetTrailStatus Text
data GetTrailStatusResponse
-- | GetTrailStatusResponse constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
getTrailStatusResponse :: GetTrailStatusResponse
-- | Whether the CloudTrail is currently logging AWS API calls.
gtsrIsLogging :: Lens' GetTrailStatusResponse (Maybe Bool)
-- | Displays any CloudWatch Logs error that CloudTrail encountered when
-- attempting to deliver logs to CloudWatch Logs.
gtsrLatestCloudWatchLogsDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)
-- | Displays the most recent date and time when CloudTrail delivered logs
-- to CloudWatch Logs.
gtsrLatestCloudWatchLogsDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
-- | Displays any Amazon S3 error that CloudTrail encountered when
-- attempting to deliver log files to the designated bucket. For more
-- information see the topic Error Responses in the Amazon S3 API
-- Reference.
gtsrLatestDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)
-- | Specifies the date and time that CloudTrail last delivered log files
-- to an account's Amazon S3 bucket.
gtsrLatestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
-- | Displays any Amazon SNS error that CloudTrail encountered when
-- attempting to send a notification. For more information about Amazon
-- SNS errors, see the Amazon SNS Developer Guide.
gtsrLatestNotificationError :: Lens' GetTrailStatusResponse (Maybe Text)
-- | Specifies the date and time of the most recent Amazon SNS notification
-- that CloudTrail has written a new log file to an account's Amazon S3
-- bucket.
gtsrLatestNotificationTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
-- | Specifies the most recent date and time when CloudTrail started
-- recording API calls for an AWS account.
gtsrStartLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
-- | Specifies the most recent date and time when CloudTrail stopped
-- recording API calls for an AWS account.
gtsrStopLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
instance Eq GetTrailStatus
instance Ord GetTrailStatus
instance Read GetTrailStatus
instance Show GetTrailStatus
instance Monoid GetTrailStatus
instance IsString GetTrailStatus
instance Eq GetTrailStatusResponse
instance Ord GetTrailStatusResponse
instance Read GetTrailStatusResponse
instance Show GetTrailStatusResponse
instance FromJSON GetTrailStatusResponse
instance AWSRequest GetTrailStatus
instance ToJSON GetTrailStatus
instance ToHeaders GetTrailStatus
instance ToQuery GetTrailStatus
instance ToPath GetTrailStatus
-- | Retrieves settings for the trail associated with the current region
-- for your account.
--
--
-- http://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_DescribeTrails.html
module Network.AWS.CloudTrail.DescribeTrails
data DescribeTrails
-- | DescribeTrails constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
describeTrails :: DescribeTrails
-- | The trail returned.
dtTrailNameList :: Lens' DescribeTrails [Text]
data DescribeTrailsResponse
-- | DescribeTrailsResponse constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
describeTrailsResponse :: DescribeTrailsResponse
-- | The list of trails.
dtrTrailList :: Lens' DescribeTrailsResponse [Trail]
instance Eq DescribeTrails
instance Ord DescribeTrails
instance Read DescribeTrails
instance Show DescribeTrails
instance Monoid DescribeTrails
instance Semigroup DescribeTrails
instance Eq DescribeTrailsResponse
instance Read DescribeTrailsResponse
instance Show DescribeTrailsResponse
instance Monoid DescribeTrailsResponse
instance Semigroup DescribeTrailsResponse
instance FromJSON DescribeTrailsResponse
instance AWSRequest DescribeTrails
instance ToJSON DescribeTrails
instance ToHeaders DescribeTrails
instance ToQuery DescribeTrails
instance ToPath DescribeTrails
instance IsList DescribeTrailsResponse
instance IsList DescribeTrails
-- | Deletes a trail.
--
--
-- http://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_DeleteTrail.html
module Network.AWS.CloudTrail.DeleteTrail
data DeleteTrail
-- | DeleteTrail constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
deleteTrail :: Text -> DeleteTrail
-- | The name of a trail to be deleted.
dtName :: Lens' DeleteTrail Text
data DeleteTrailResponse
-- | DeleteTrailResponse constructor.
deleteTrailResponse :: DeleteTrailResponse
instance Eq DeleteTrail
instance Ord DeleteTrail
instance Read DeleteTrail
instance Show DeleteTrail
instance Monoid DeleteTrail
instance IsString DeleteTrail
instance Eq DeleteTrailResponse
instance Ord DeleteTrailResponse
instance Read DeleteTrailResponse
instance Show DeleteTrailResponse
instance Generic DeleteTrailResponse
instance Datatype D1DeleteTrailResponse
instance Constructor C1_0DeleteTrailResponse
instance AWSRequest DeleteTrail
instance ToJSON DeleteTrail
instance ToHeaders DeleteTrail
instance ToQuery DeleteTrail
instance ToPath DeleteTrail
-- | From the command line, use 'create-subscription'.
--
-- Creates a trail that specifies the settings for delivery of log data
-- to an Amazon S3 bucket.
--
--
-- http://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_CreateTrail.html
module Network.AWS.CloudTrail.CreateTrail
data CreateTrail
-- | CreateTrail constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
createTrail :: Text -> Text -> CreateTrail
-- | Specifies a log group name using an Amazon Resource Name (ARN), a
-- unique identifier that represents the log group to which CloudTrail
-- logs will be delivered. Not required unless you specify
-- CloudWatchLogsRoleArn.
ctCloudWatchLogsLogGroupArn :: Lens' CreateTrail (Maybe Text)
-- | Specifies the role for the CloudWatch Logs endpoint to assume to write
-- to a user’s log group.
ctCloudWatchLogsRoleArn :: Lens' CreateTrail (Maybe Text)
-- | Specifies whether the trail is publishing events from global services
-- such as IAM to the log files.
ctIncludeGlobalServiceEvents :: Lens' CreateTrail (Maybe Bool)
-- | Specifies the name of the trail.
ctName :: Lens' CreateTrail Text
-- | Specifies the name of the Amazon S3 bucket designated for publishing
-- log files.
ctS3BucketName :: Lens' CreateTrail Text
-- | Specifies the Amazon S3 key prefix that precedes the name of the
-- bucket you have designated for log file delivery.
ctS3KeyPrefix :: Lens' CreateTrail (Maybe Text)
-- | Specifies the name of the Amazon SNS topic defined for notification of
-- log file delivery.
ctSnsTopicName :: Lens' CreateTrail (Maybe Text)
data CreateTrailResponse
-- | CreateTrailResponse constructor.
--
-- The fields accessible through corresponding lenses are:
--
--
createTrailResponse :: CreateTrailResponse
-- | Specifies the Amazon Resource Name (ARN) of the log group to which
-- CloudTrail logs will be delivered.
ctrCloudWatchLogsLogGroupArn :: Lens' CreateTrailResponse (Maybe Text)
-- | Specifies the role for the CloudWatch Logs endpoint to assume to write
-- to a user’s log group.
ctrCloudWatchLogsRoleArn :: Lens' CreateTrailResponse (Maybe Text)
-- | Specifies whether the trail is publishing events from global services
-- such as IAM to the log files.
ctrIncludeGlobalServiceEvents :: Lens' CreateTrailResponse (Maybe Bool)
-- | Specifies the name of the trail.
ctrName :: Lens' CreateTrailResponse (Maybe Text)
-- | Specifies the name of the Amazon S3 bucket designated for publishing
-- log files.
ctrS3BucketName :: Lens' CreateTrailResponse (Maybe Text)
-- | Specifies the Amazon S3 key prefix that precedes the name of the
-- bucket you have designated for log file delivery.
ctrS3KeyPrefix :: Lens' CreateTrailResponse (Maybe Text)
-- | Specifies the name of the Amazon SNS topic defined for notification of
-- log file delivery.
ctrSnsTopicName :: Lens' CreateTrailResponse (Maybe Text)
instance Eq CreateTrail
instance Ord CreateTrail
instance Read CreateTrail
instance Show CreateTrail
instance Eq CreateTrailResponse
instance Ord CreateTrailResponse
instance Read CreateTrailResponse
instance Show CreateTrailResponse
instance FromJSON CreateTrailResponse
instance AWSRequest CreateTrail
instance ToJSON CreateTrail
instance ToHeaders CreateTrail
instance ToQuery CreateTrail
instance ToPath CreateTrail
-- | CloudTrail is a web service that records AWS API calls for your AWS
-- account and delivers log files to an Amazon S3 bucket. The recorded
-- information includes the identity of the user, the start time of the
-- AWS API call, the source IP address, the request parameters, and the
-- response elements returned by the service.
module Network.AWS.CloudTrail