Network.AWS.Discovery.StartExportTask

Begins the export of discovered data to an S3 bucket.

If you specify agentId in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime . Export of detailed agent data is limited to five concurrently running exports.

If you do not include an agentId filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day.

Creating a Request

startExportTask :: StartExportTask

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

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

• setExportDataFormat - The file format for the returned export data. Default value is CSV .
• setStartTime - The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.
• setFilters - If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.
• setEndTime - The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.

data StartExportTask

See: startExportTask smart constructor.

Instances

Eq StartExportTask

Methods

(==) :: StartExportTask -> StartExportTask -> Bool

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

Data StartExportTask

Methods

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

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

toConstr :: StartExportTask -> Constr

dataTypeOf :: StartExportTask -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> StartExportTask -> StartExportTask

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

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

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

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

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

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

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

Read StartExportTask

Methods

readsPrec :: Int -> ReadS StartExportTask

readList :: ReadS [StartExportTask]

readPrec :: ReadPrec StartExportTask

readListPrec :: ReadPrec [StartExportTask]

Show StartExportTask

Methods

showsPrec :: Int -> StartExportTask -> ShowS

show :: StartExportTask -> String

showList :: [StartExportTask] -> ShowS

Generic StartExportTask

Associated Types

type Rep StartExportTask :: * -> *

Methods

from :: StartExportTask -> Rep StartExportTask x

to :: Rep StartExportTask x -> StartExportTask

Hashable StartExportTask

Methods

hashWithSalt :: Int -> StartExportTask -> Int

hash :: StartExportTask -> Int

ToJSON StartExportTask

Methods

toJSON :: StartExportTask -> Value

toEncoding :: StartExportTask -> Encoding

toJSONList :: [StartExportTask] -> Value

toEncodingList :: [StartExportTask] -> Encoding

NFData StartExportTask

Methods

rnf :: StartExportTask -> ()

AWSRequest StartExportTask

Associated Types

type Rs StartExportTask :: *

Methods

request :: StartExportTask -> Request StartExportTask

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

ToQuery StartExportTask

Methods

toQuery :: StartExportTask -> QueryString

ToPath StartExportTask

Methods

toPath :: StartExportTask -> ByteString

ToHeaders StartExportTask

Methods

toHeaders :: StartExportTask -> [Header]

type Rep StartExportTask

type Rep StartExportTask = D1 (MetaData "StartExportTask" "Network.AWS.Discovery.StartExportTask" "amazonka-discovery-1.5.0-9zAudG659YgC8BiK47CJ9D" False) (C1 (MetaCons "StartExportTask'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_setExportDataFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ExportDataFormat]))) (S1 (MetaSel (Just Symbol "_setStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_setFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ExportFilter]))) (S1 (MetaSel (Just Symbol "_setEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))))))

type Rs StartExportTask

type Rs StartExportTask = StartExportTaskResponse

Request Lenses

setExportDataFormat :: Lens' StartExportTask [ExportDataFormat]

The file format for the returned export data. Default value is CSV .

setStartTime :: Lens' StartExportTask (Maybe UTCTime)

The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.

setFilters :: Lens' StartExportTask [ExportFilter]

If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.

setEndTime :: Lens' StartExportTask (Maybe UTCTime)

The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.

Destructuring the Response

startExportTaskResponse

Arguments

:: Int

setrsResponseStatus

-> StartExportTaskResponse

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

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

• setrsExportId - A unique identifier used to query the status of an export request.
• setrsResponseStatus - -- | The response status code.

data StartExportTaskResponse

See: startExportTaskResponse smart constructor.

Instances

Eq StartExportTaskResponse

Methods

(==) :: StartExportTaskResponse -> StartExportTaskResponse -> Bool

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

Data StartExportTaskResponse

Methods

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

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

toConstr :: StartExportTaskResponse -> Constr

dataTypeOf :: StartExportTaskResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> StartExportTaskResponse -> StartExportTaskResponse

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

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

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

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

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

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

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

Read StartExportTaskResponse

Methods

readsPrec :: Int -> ReadS StartExportTaskResponse

readList :: ReadS [StartExportTaskResponse]

readPrec :: ReadPrec StartExportTaskResponse

readListPrec :: ReadPrec [StartExportTaskResponse]

Show StartExportTaskResponse

Methods

showsPrec :: Int -> StartExportTaskResponse -> ShowS

show :: StartExportTaskResponse -> String

showList :: [StartExportTaskResponse] -> ShowS

Generic StartExportTaskResponse

Associated Types

type Rep StartExportTaskResponse :: * -> *

Methods

from :: StartExportTaskResponse -> Rep StartExportTaskResponse x

to :: Rep StartExportTaskResponse x -> StartExportTaskResponse

NFData StartExportTaskResponse

Methods

rnf :: StartExportTaskResponse -> ()

type Rep StartExportTaskResponse

type Rep StartExportTaskResponse = D1 (MetaData "StartExportTaskResponse" "Network.AWS.Discovery.StartExportTask" "amazonka-discovery-1.5.0-9zAudG659YgC8BiK47CJ9D" False) (C1 (MetaCons "StartExportTaskResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_setrsExportId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_setrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

setrsExportId :: Lens' StartExportTaskResponse (Maybe Text)

A unique identifier used to query the status of an export request.

setrsResponseStatus :: Lens' StartExportTaskResponse Int

• - | The response status code.