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

Amazonka.Discovery.StartDataCollectionByAgentIds

Description

Instructs the specified agents or connectors to start collecting data.

Synopsis

Creating a Request

data StartDataCollectionByAgentIds Source #

See: newStartDataCollectionByAgentIds smart constructor.

Constructors

StartDataCollectionByAgentIds' 

Fields

  • agentIds :: [Text]

    The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.

Instances

Instances details
Eq StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

Read StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

Show StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

Generic StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

Associated Types

type Rep StartDataCollectionByAgentIds :: Type -> Type #

NFData StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

Hashable StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

ToJSON StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

AWSRequest StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

ToHeaders StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

ToPath StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

ToQuery StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

type Rep StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

type Rep StartDataCollectionByAgentIds = D1 ('MetaData "StartDataCollectionByAgentIds" "Amazonka.Discovery.StartDataCollectionByAgentIds" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "StartDataCollectionByAgentIds'" 'PrefixI 'True) (S1 ('MetaSel ('Just "agentIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))
type AWSResponse StartDataCollectionByAgentIds Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

newStartDataCollectionByAgentIds :: StartDataCollectionByAgentIds Source #

Create a value of StartDataCollectionByAgentIds with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:agentIds:StartDataCollectionByAgentIds', startDataCollectionByAgentIds_agentIds - The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.

Request Lenses

startDataCollectionByAgentIds_agentIds :: Lens' StartDataCollectionByAgentIds [Text] Source #

The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.

Destructuring the Response

data StartDataCollectionByAgentIdsResponse Source #

Constructors

StartDataCollectionByAgentIdsResponse' 

Fields

  • agentsConfigurationStatus :: Maybe [AgentConfigurationStatus]

    Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq StartDataCollectionByAgentIdsResponse Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

Read StartDataCollectionByAgentIdsResponse Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

Show StartDataCollectionByAgentIdsResponse Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

Generic StartDataCollectionByAgentIdsResponse Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

NFData StartDataCollectionByAgentIdsResponse Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

type Rep StartDataCollectionByAgentIdsResponse Source # 
Instance details

Defined in Amazonka.Discovery.StartDataCollectionByAgentIds

type Rep StartDataCollectionByAgentIdsResponse = D1 ('MetaData "StartDataCollectionByAgentIdsResponse" "Amazonka.Discovery.StartDataCollectionByAgentIds" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "StartDataCollectionByAgentIdsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "agentsConfigurationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AgentConfigurationStatus])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartDataCollectionByAgentIdsResponse Source #

Create a value of StartDataCollectionByAgentIdsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:agentsConfigurationStatus:StartDataCollectionByAgentIdsResponse', startDataCollectionByAgentIdsResponse_agentsConfigurationStatus - Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

$sel:httpStatus:StartDataCollectionByAgentIdsResponse', startDataCollectionByAgentIdsResponse_httpStatus - The response's http status code.

Response Lenses

startDataCollectionByAgentIdsResponse_agentsConfigurationStatus :: Lens' StartDataCollectionByAgentIdsResponse (Maybe [AgentConfigurationStatus]) Source #

Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.