Network.AWS.CloudWatchLogs.CreateExportTask

Creates an ExportTask which allows you to efficiently export data from a Log Group to your Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, DescribeExportTasks can be used to get the status of an export task. You can only have one active (RUNNING or PENDING) export task at a time, per account.

You can export logs from multiple log groups or multiple time ranges to the same Amazon 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.

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
• cetTaskName
• cetLogStreamNamePrefix
• cetLogGroupName
• cetFrom
• cetTo
• cetDestination

data CreateExportTask

See: createExportTask smart constructor.

Instances

Eq CreateExportTask

Methods

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

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

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

Methods

readsPrec :: Int -> ReadS CreateExportTask

readList :: ReadS [CreateExportTask]

readPrec :: ReadPrec CreateExportTask

readListPrec :: ReadPrec [CreateExportTask]

Show CreateExportTask

Methods

showsPrec :: Int -> CreateExportTask -> ShowS

show :: CreateExportTask -> String

showList :: [CreateExportTask] -> ShowS

Generic CreateExportTask

Associated Types

type Rep CreateExportTask :: * -> *

Methods

from :: CreateExportTask -> Rep CreateExportTask x

to :: Rep CreateExportTask x -> CreateExportTask

ToJSON CreateExportTask

Methods

toJSON :: CreateExportTask -> Value

toEncoding :: CreateExportTask -> Encoding

Hashable CreateExportTask

Methods

hashWithSalt :: Int -> CreateExportTask -> Int

hash :: CreateExportTask -> Int

NFData CreateExportTask

Methods

rnf :: CreateExportTask -> ()

AWSRequest CreateExportTask

Associated Types

type Rs CreateExportTask :: *

Methods

request :: CreateExportTask -> Request CreateExportTask

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

ToPath CreateExportTask

Methods

toPath :: CreateExportTask -> ByteString

ToHeaders CreateExportTask

Methods

toHeaders :: CreateExportTask -> [Header]

ToQuery CreateExportTask

Methods

toQuery :: CreateExportTask -> QueryString

type Rep CreateExportTask

type Rep CreateExportTask = D1 (MetaData "CreateExportTask" "Network.AWS.CloudWatchLogs.CreateExportTask" "amazonka-cloudwatch-logs-1.4.2-Guhy1kU17hv1viJ0bxq77f" 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

type Rs CreateExportTask = CreateExportTaskResponse

Request Lenses

cetDestinationPrefix :: Lens' CreateExportTask (Maybe Text)

Prefix that will be used as the start of Amazon S3 key for every object exported. If not specified, this defaults to 'exportedlogs'.

cetTaskName :: Lens' CreateExportTask (Maybe Text)

The name of the export task.

cetLogStreamNamePrefix :: Lens' CreateExportTask (Maybe Text)

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

cetLogGroupName :: Lens' CreateExportTask Text

The name of the log group to export.

cetFrom :: Lens' CreateExportTask Natural

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the start time of the range for the request. Events with a timestamp prior to this time will not be exported.

cetTo :: Lens' CreateExportTask Natural

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the end time of the range for the request. Events with a timestamp later than this time will not be exported.

cetDestination :: Lens' CreateExportTask Text

Name of Amazon S3 bucket to which the log data will be exported.

Note: Only buckets in the same AWS region are supported.

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
• cetrsResponseStatus

data CreateExportTaskResponse

See: createExportTaskResponse smart constructor.

Instances

Eq CreateExportTaskResponse

Methods

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

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

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

Methods

readsPrec :: Int -> ReadS CreateExportTaskResponse

readList :: ReadS [CreateExportTaskResponse]

readPrec :: ReadPrec CreateExportTaskResponse

readListPrec :: ReadPrec [CreateExportTaskResponse]

Show CreateExportTaskResponse

Methods

showsPrec :: Int -> CreateExportTaskResponse -> ShowS

show :: CreateExportTaskResponse -> String

showList :: [CreateExportTaskResponse] -> ShowS

Generic CreateExportTaskResponse

Associated Types

type Rep CreateExportTaskResponse :: * -> *

Methods

from :: CreateExportTaskResponse -> Rep CreateExportTaskResponse x

to :: Rep CreateExportTaskResponse x -> CreateExportTaskResponse

NFData CreateExportTaskResponse

Methods

rnf :: CreateExportTaskResponse -> ()

type Rep CreateExportTaskResponse

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

Response Lenses

cetrsTaskId :: Lens' CreateExportTaskResponse (Maybe Text)

Id of the export task that got created.

cetrsResponseStatus :: Lens' CreateExportTaskResponse Int

The response status code.