amazonka-discovery-1.6.0: Amazon Application Discovery Service SDK.

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

Network.AWS.Discovery.StartExportTask

Contents

Description

Begins the export of discovered data to an S3 bucket.

If you specify agentIds 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 agentIds 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.

Synopsis

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 . Note: The GRAPHML option has been deprecated.
  • 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 # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Data StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.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 # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Show StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Generic StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Associated Types

type Rep StartExportTask :: * -> * #

Hashable StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

ToJSON StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

AWSRequest StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Associated Types

type Rs StartExportTask :: * #

ToHeaders StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

ToPath StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

ToQuery StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

NFData StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Methods

rnf :: StartExportTask -> () #

type Rep StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

type Rep StartExportTask = D1 (MetaData "StartExportTask" "Network.AWS.Discovery.StartExportTask" "amazonka-discovery-1.6.0-3AQTWUOAhJuIASAaS4emtL" False) (C1 (MetaCons "StartExportTask'" PrefixI True) ((S1 (MetaSel (Just "_setExportDataFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ExportDataFormat])) :*: S1 (MetaSel (Just "_setStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 (MetaSel (Just "_setFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ExportFilter])) :*: S1 (MetaSel (Just "_setEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))))
type Rs StartExportTask # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Request Lenses

setExportDataFormat :: Lens' StartExportTask [ExportDataFormat] #

The file format for the returned export data. Default value is CSV . Note: The GRAPHML option has been deprecated.

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 #

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:

data StartExportTaskResponse #

See: startExportTaskResponse smart constructor.

Instances
Eq StartExportTaskResponse # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Data StartExportTaskResponse # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

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 # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Show StartExportTaskResponse # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Generic StartExportTaskResponse # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Associated Types

type Rep StartExportTaskResponse :: * -> * #

NFData StartExportTaskResponse # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

Methods

rnf :: StartExportTaskResponse -> () #

type Rep StartExportTaskResponse # 
Instance details

Defined in Network.AWS.Discovery.StartExportTask

type Rep StartExportTaskResponse = D1 (MetaData "StartExportTaskResponse" "Network.AWS.Discovery.StartExportTask" "amazonka-discovery-1.6.0-3AQTWUOAhJuIASAaS4emtL" False) (C1 (MetaCons "StartExportTaskResponse'" PrefixI True) (S1 (MetaSel (Just "_setrsExportId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_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.