Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DataSync.DescribeAgent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.

Synopsis

data DescribeAgent = DescribeAgent' {
- agentArn :: Text
}
newDescribeAgent :: Text -> DescribeAgent
describeAgent_agentArn :: Lens' DescribeAgent Text
data DescribeAgentResponse = DescribeAgentResponse' {
- agentArn :: Maybe Text
- creationTime :: Maybe POSIX
- endpointType :: Maybe EndpointType
- lastConnectionTime :: Maybe POSIX
- name :: Maybe Text
- privateLinkConfig :: Maybe PrivateLinkConfig
- status :: Maybe AgentStatus
- httpStatus :: Int
}
newDescribeAgentResponse :: Int -> DescribeAgentResponse
describeAgentResponse_agentArn :: Lens' DescribeAgentResponse (Maybe Text)
describeAgentResponse_creationTime :: Lens' DescribeAgentResponse (Maybe UTCTime)
describeAgentResponse_endpointType :: Lens' DescribeAgentResponse (Maybe EndpointType)
describeAgentResponse_lastConnectionTime :: Lens' DescribeAgentResponse (Maybe UTCTime)
describeAgentResponse_name :: Lens' DescribeAgentResponse (Maybe Text)
describeAgentResponse_privateLinkConfig :: Lens' DescribeAgentResponse (Maybe PrivateLinkConfig)
describeAgentResponse_status :: Lens' DescribeAgentResponse (Maybe AgentStatus)
describeAgentResponse_httpStatus :: Lens' DescribeAgentResponse Int

Creating a Request

data DescribeAgent Source #

DescribeAgent

See: newDescribeAgent smart constructor.

Constructors

DescribeAgent'
Fields agentArn :: Text The Amazon Resource Name (ARN) of the agent to describe.

Instances

Instances details

ToJSON DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods toJSON :: DescribeAgent -> Value # toEncoding :: DescribeAgent -> Encoding # toJSONList :: [DescribeAgent] -> Value # toEncodingList :: [DescribeAgent] -> Encoding #
ToHeaders DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods toHeaders :: DescribeAgent -> [Header] #
ToPath DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods toPath :: DescribeAgent -> ByteString #
ToQuery DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods toQuery :: DescribeAgent -> QueryString #
AWSRequest DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Associated Types type AWSResponse DescribeAgent # Methods request :: (Service -> Service) -> DescribeAgent -> Request DescribeAgent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAgent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAgent))) #
Generic DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Associated Types type Rep DescribeAgent :: Type -> Type # Methods from :: DescribeAgent -> Rep DescribeAgent x # to :: Rep DescribeAgent x -> DescribeAgent #
Read DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods readsPrec :: Int -> ReadS DescribeAgent # readList :: ReadS [DescribeAgent] # readPrec :: ReadPrec DescribeAgent # readListPrec :: ReadPrec [DescribeAgent] #
Show DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods showsPrec :: Int -> DescribeAgent -> ShowS # show :: DescribeAgent -> String # showList :: [DescribeAgent] -> ShowS #
NFData DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods rnf :: DescribeAgent -> () #
Eq DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods (==) :: DescribeAgent -> DescribeAgent -> Bool # (/=) :: DescribeAgent -> DescribeAgent -> Bool #
Hashable DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods hashWithSalt :: Int -> DescribeAgent -> Int # hash :: DescribeAgent -> Int #
type AWSResponse DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent type AWSResponse DescribeAgent = DescribeAgentResponse
type Rep DescribeAgent Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent type Rep DescribeAgent = D1 ('MetaData "DescribeAgent" "Amazonka.DataSync.DescribeAgent" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "DescribeAgent'" 'PrefixI 'True) (S1 ('MetaSel ('Just "agentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAgent Source #

Arguments

:: Text	`DescribeAgent`
-> DescribeAgent

Create a value of DescribeAgent 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:

DescribeAgent, describeAgent_agentArn - The Amazon Resource Name (ARN) of the agent to describe.

Request Lenses

describeAgent_agentArn :: Lens' DescribeAgent Text Source #

The Amazon Resource Name (ARN) of the agent to describe.

Destructuring the Response

data DescribeAgentResponse Source #

DescribeAgentResponse

See: newDescribeAgentResponse smart constructor.

Constructors

DescribeAgentResponse'

Fields

agentArn :: Maybe Text
The Amazon Resource Name (ARN) of the agent.
creationTime :: Maybe POSIX
The time that the agent was activated (that is, created in your account).
endpointType :: Maybe EndpointType
The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
lastConnectionTime :: Maybe POSIX
The time that the agent last connected to DataSync.
name :: Maybe Text
The name of the agent.
privateLinkConfig :: Maybe PrivateLinkConfig
The subnet and the security group that DataSync used to access a VPC endpoint.
status :: Maybe AgentStatus
The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Associated Types type Rep DescribeAgentResponse :: Type -> Type # Methods from :: DescribeAgentResponse -> Rep DescribeAgentResponse x # to :: Rep DescribeAgentResponse x -> DescribeAgentResponse #
Read DescribeAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods readsPrec :: Int -> ReadS DescribeAgentResponse # readList :: ReadS [DescribeAgentResponse] # readPrec :: ReadPrec DescribeAgentResponse # readListPrec :: ReadPrec [DescribeAgentResponse] #
Show DescribeAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods showsPrec :: Int -> DescribeAgentResponse -> ShowS # show :: DescribeAgentResponse -> String # showList :: [DescribeAgentResponse] -> ShowS #
NFData DescribeAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods rnf :: DescribeAgentResponse -> () #
Eq DescribeAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent Methods (==) :: DescribeAgentResponse -> DescribeAgentResponse -> Bool # (/=) :: DescribeAgentResponse -> DescribeAgentResponse -> Bool #
type Rep DescribeAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeAgent type Rep DescribeAgentResponse = D1 ('MetaData "DescribeAgentResponse" "Amazonka.DataSync.DescribeAgent" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "DescribeAgentResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "agentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType)) :: S1 ('MetaSel ('Just "lastConnectionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "privateLinkConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrivateLinkConfig))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AgentStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeAgentResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAgentResponse'`
-> DescribeAgentResponse

Create a value of DescribeAgentResponse 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:

DescribeAgent, describeAgentResponse_agentArn - The Amazon Resource Name (ARN) of the agent.

$sel:creationTime:DescribeAgentResponse', describeAgentResponse_creationTime - The time that the agent was activated (that is, created in your account).

$sel:endpointType:DescribeAgentResponse', describeAgentResponse_endpointType - The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.

$sel:lastConnectionTime:DescribeAgentResponse', describeAgentResponse_lastConnectionTime - The time that the agent last connected to DataSync.

DescribeAgentResponse, describeAgentResponse_name - The name of the agent.

$sel:privateLinkConfig:DescribeAgentResponse', describeAgentResponse_privateLinkConfig - The subnet and the security group that DataSync used to access a VPC endpoint.

DescribeAgentResponse, describeAgentResponse_status - The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.

$sel:httpStatus:DescribeAgentResponse', describeAgentResponse_httpStatus - The response's http status code.

Response Lenses

describeAgentResponse_agentArn :: Lens' DescribeAgentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the agent.

describeAgentResponse_creationTime :: Lens' DescribeAgentResponse (Maybe UTCTime) Source #

The time that the agent was activated (that is, created in your account).

describeAgentResponse_endpointType :: Lens' DescribeAgentResponse (Maybe EndpointType) Source #

The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.

describeAgentResponse_lastConnectionTime :: Lens' DescribeAgentResponse (Maybe UTCTime) Source #

The time that the agent last connected to DataSync.

describeAgentResponse_name :: Lens' DescribeAgentResponse (Maybe Text) Source #

The name of the agent.

describeAgentResponse_privateLinkConfig :: Lens' DescribeAgentResponse (Maybe PrivateLinkConfig) Source #

The subnet and the security group that DataSync used to access a VPC endpoint.

describeAgentResponse_status :: Lens' DescribeAgentResponse (Maybe AgentStatus) Source #

The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.

describeAgentResponse_httpStatus :: Lens' DescribeAgentResponse Int Source #

The response's http status code.