Network.AWS.CloudWatchLogs.CreateExportTask

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 to be used as the Amazon S3 key prefix for all exported objects.

Creating a Request

createExportTask

Arguments

:: Text

cetLogGroupName

-> Natural

cetFrom

-> Natural

cetTo

-> Text

cetDestination

-> 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 after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.
• cetTo - The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp 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

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

(==) :: CreateExportTask -> CreateExportTask -> Bool

(/=) :: CreateExportTask -> CreateExportTask -> Bool

Data CreateExportTask

Defined in Network.AWS.CloudWatchLogs.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

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

readsPrec :: Int -> ReadS CreateExportTask

readList :: ReadS [CreateExportTask]

readPrec :: ReadPrec CreateExportTask

readListPrec :: ReadPrec [CreateExportTask]

Show CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

showsPrec :: Int -> CreateExportTask -> ShowS

show :: CreateExportTask -> String

showList :: [CreateExportTask] -> ShowS

Generic CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Associated Types

type Rep CreateExportTask :: Type -> Type

Methods

from :: CreateExportTask -> Rep CreateExportTask x

to :: Rep CreateExportTask x -> CreateExportTask

Hashable CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

hashWithSalt :: Int -> CreateExportTask -> Int

hash :: CreateExportTask -> Int

ToJSON CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

toJSON :: CreateExportTask -> Value

toEncoding :: CreateExportTask -> Encoding

toJSONList :: [CreateExportTask] -> Value

toEncodingList :: [CreateExportTask] -> Encoding

AWSRequest CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Associated Types

type Rs CreateExportTask :: Type

Methods

request :: CreateExportTask -> Request CreateExportTask

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateExportTask -> ClientResponse -> m (Response CreateExportTask)

ToHeaders CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

toHeaders :: CreateExportTask -> [Header]

ToPath CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

toPath :: CreateExportTask -> ByteString

ToQuery CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

toQuery :: CreateExportTask -> QueryString

NFData CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

rnf :: CreateExportTask -> ()

type Rep CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

type Rep CreateExportTask = D1 (MetaData "CreateExportTask" "Network.AWS.CloudWatchLogs.CreateExportTask" "amazonka-cloudwatch-logs-1.6.1-3MDuvRaDmjeBjiAkGx8qXs" False) (C1 (MetaCons "CreateExportTask'" PrefixI True) ((S1 (MetaSel (Just "_cetDestinationPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_cetTaskName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cetLogStreamNamePrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_cetLogGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cetFrom") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)) :*: (S1 (MetaSel (Just "_cetTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat) :*: S1 (MetaSel (Just "_cetDestination") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs CreateExportTask

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

type Rs CreateExportTask = CreateExportTaskResponse

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 after Jan 1, 1970 00:00:00 UTC. Events with a time stamp 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 after Jan 1, 1970 00:00:00 UTC. Events with a time stamp 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

Arguments

:: Int

cetrsResponseStatus

-> 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:

• cetrsTaskId - The ID of the export task.
• cetrsResponseStatus - -- | The response status code.

data CreateExportTaskResponse

See: createExportTaskResponse smart constructor.

Instances

Eq CreateExportTaskResponse

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

(==) :: CreateExportTaskResponse -> CreateExportTaskResponse -> Bool

(/=) :: CreateExportTaskResponse -> CreateExportTaskResponse -> Bool

Data CreateExportTaskResponse

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

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

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

readsPrec :: Int -> ReadS CreateExportTaskResponse

readList :: ReadS [CreateExportTaskResponse]

readPrec :: ReadPrec CreateExportTaskResponse

readListPrec :: ReadPrec [CreateExportTaskResponse]

Show CreateExportTaskResponse

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

showsPrec :: Int -> CreateExportTaskResponse -> ShowS

show :: CreateExportTaskResponse -> String

showList :: [CreateExportTaskResponse] -> ShowS

Generic CreateExportTaskResponse

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Associated Types

type Rep CreateExportTaskResponse :: Type -> Type

Methods

from :: CreateExportTaskResponse -> Rep CreateExportTaskResponse x

to :: Rep CreateExportTaskResponse x -> CreateExportTaskResponse

NFData CreateExportTaskResponse

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

Methods

rnf :: CreateExportTaskResponse -> ()

type Rep CreateExportTaskResponse

Defined in Network.AWS.CloudWatchLogs.CreateExportTask

type Rep CreateExportTaskResponse = D1 (MetaData "CreateExportTaskResponse" "Network.AWS.CloudWatchLogs.CreateExportTask" "amazonka-cloudwatch-logs-1.6.1-3MDuvRaDmjeBjiAkGx8qXs" False) (C1 (MetaCons "CreateExportTaskResponse'" PrefixI True) (S1 (MetaSel (Just "_cetrsTaskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cetrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

cetrsTaskId :: Lens' CreateExportTaskResponse (Maybe Text)

The ID of the export task.

cetrsResponseStatus :: Lens' CreateExportTaskResponse Int

• - | The response status code.