amazonka-cloudwatch-logs-1.4.5: Amazon CloudWatch Logs SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudWatchLogs.CreateExportTask

Contents

Description

Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING ) export task at a time. To cancel an export task, use CancelExportTask .

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects.

Synopsis

Creating a Request

createExportTask #

Creates a value of CreateExportTask with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cetDestinationPrefix - The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs .
  • cetTaskName - The name of the export task.
  • cetLogStreamNamePrefix - Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.
  • cetLogGroupName - The name of the log group.
  • cetFrom - The start time of the range for the request, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.
  • cetTo - The end time of the range for the request, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.
  • cetDestination - The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.

data CreateExportTask #

See: createExportTask smart constructor.

Instances

Eq CreateExportTask # 
Data CreateExportTask # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateExportTask -> c CreateExportTask #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateExportTask #

toConstr :: CreateExportTask -> Constr #

dataTypeOf :: CreateExportTask -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateExportTask) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateExportTask) #

gmapT :: (forall b. Data b => b -> b) -> CreateExportTask -> CreateExportTask #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateExportTask -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateExportTask -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateExportTask -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateExportTask -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateExportTask -> m CreateExportTask #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateExportTask -> m CreateExportTask #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateExportTask -> m CreateExportTask #

Read CreateExportTask # 
Show CreateExportTask # 
Generic CreateExportTask # 
Hashable CreateExportTask # 
ToJSON CreateExportTask # 
NFData CreateExportTask # 

Methods

rnf :: CreateExportTask -> () #

AWSRequest CreateExportTask # 
ToQuery CreateExportTask # 
ToPath CreateExportTask # 
ToHeaders CreateExportTask # 
type Rep CreateExportTask # 
type Rep CreateExportTask = D1 (MetaData "CreateExportTask" "Network.AWS.CloudWatchLogs.CreateExportTask" "amazonka-cloudwatch-logs-1.4.5-9QRzQX2AFAcp9HWg8eJiT" False) (C1 (MetaCons "CreateExportTask'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cetDestinationPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cetTaskName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cetLogStreamNamePrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cetLogGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cetFrom") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_cetTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)) (S1 (MetaSel (Just Symbol "_cetDestination") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs CreateExportTask # 

Request Lenses

cetDestinationPrefix :: Lens' CreateExportTask (Maybe Text) #

The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs .

cetTaskName :: Lens' CreateExportTask (Maybe Text) #

The name of the export task.

cetLogStreamNamePrefix :: Lens' CreateExportTask (Maybe Text) #

Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

cetLogGroupName :: Lens' CreateExportTask Text #

The name of the log group.

cetFrom :: Lens' CreateExportTask Natural #

The start time of the range for the request, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.

cetTo :: Lens' CreateExportTask Natural #

The end time of the range for the request, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

cetDestination :: Lens' CreateExportTask Text #

The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.

Destructuring the Response

createExportTaskResponse #

Creates a value of CreateExportTaskResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateExportTaskResponse #

See: createExportTaskResponse smart constructor.

Instances

Eq CreateExportTaskResponse # 
Data CreateExportTaskResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateExportTaskResponse -> c CreateExportTaskResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateExportTaskResponse #

toConstr :: CreateExportTaskResponse -> Constr #

dataTypeOf :: CreateExportTaskResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateExportTaskResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateExportTaskResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateExportTaskResponse -> CreateExportTaskResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateExportTaskResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateExportTaskResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateExportTaskResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateExportTaskResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateExportTaskResponse -> m CreateExportTaskResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateExportTaskResponse -> m CreateExportTaskResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateExportTaskResponse -> m CreateExportTaskResponse #

Read CreateExportTaskResponse # 
Show CreateExportTaskResponse # 
Generic CreateExportTaskResponse # 
NFData CreateExportTaskResponse # 
type Rep CreateExportTaskResponse # 
type Rep CreateExportTaskResponse = D1 (MetaData "CreateExportTaskResponse" "Network.AWS.CloudWatchLogs.CreateExportTask" "amazonka-cloudwatch-logs-1.4.5-9QRzQX2AFAcp9HWg8eJiT" False) (C1 (MetaCons "CreateExportTaskResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cetrsTaskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cetrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

cetrsTaskId :: Lens' CreateExportTaskResponse (Maybe Text) #

The ID of the export task.

cetrsResponseStatus :: Lens' CreateExportTaskResponse Int #

  • - | The response status code.