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.SSM.Types.InstanceInformation

Description

Synopsis

data InstanceInformation = InstanceInformation' {
- activationId :: Maybe Text
- agentVersion :: Maybe Text
- associationOverview :: Maybe InstanceAggregatedAssociationOverview
- associationStatus :: Maybe Text
- computerName :: Maybe Text
- iPAddress :: Maybe Text
- iamRole :: Maybe Text
- instanceId :: Maybe Text
- isLatestVersion :: Maybe Bool
- lastAssociationExecutionDate :: Maybe POSIX
- lastPingDateTime :: Maybe POSIX
- lastSuccessfulAssociationExecutionDate :: Maybe POSIX
- name :: Maybe Text
- pingStatus :: Maybe PingStatus
- platformName :: Maybe Text
- platformType :: Maybe PlatformType
- platformVersion :: Maybe Text
- registrationDate :: Maybe POSIX
- resourceType :: Maybe ResourceType
- sourceId :: Maybe Text
- sourceType :: Maybe SourceType
}
newInstanceInformation :: InstanceInformation
instanceInformation_activationId :: Lens' InstanceInformation (Maybe Text)
instanceInformation_agentVersion :: Lens' InstanceInformation (Maybe Text)
instanceInformation_associationOverview :: Lens' InstanceInformation (Maybe InstanceAggregatedAssociationOverview)
instanceInformation_associationStatus :: Lens' InstanceInformation (Maybe Text)
instanceInformation_computerName :: Lens' InstanceInformation (Maybe Text)
instanceInformation_iPAddress :: Lens' InstanceInformation (Maybe Text)
instanceInformation_iamRole :: Lens' InstanceInformation (Maybe Text)
instanceInformation_instanceId :: Lens' InstanceInformation (Maybe Text)
instanceInformation_isLatestVersion :: Lens' InstanceInformation (Maybe Bool)
instanceInformation_lastAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime)
instanceInformation_lastPingDateTime :: Lens' InstanceInformation (Maybe UTCTime)
instanceInformation_lastSuccessfulAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime)
instanceInformation_name :: Lens' InstanceInformation (Maybe Text)
instanceInformation_pingStatus :: Lens' InstanceInformation (Maybe PingStatus)
instanceInformation_platformName :: Lens' InstanceInformation (Maybe Text)
instanceInformation_platformType :: Lens' InstanceInformation (Maybe PlatformType)
instanceInformation_platformVersion :: Lens' InstanceInformation (Maybe Text)
instanceInformation_registrationDate :: Lens' InstanceInformation (Maybe UTCTime)
instanceInformation_resourceType :: Lens' InstanceInformation (Maybe ResourceType)
instanceInformation_sourceId :: Lens' InstanceInformation (Maybe Text)
instanceInformation_sourceType :: Lens' InstanceInformation (Maybe SourceType)

Documentation

data InstanceInformation Source #

Describes a filter for a specific list of managed nodes.

See: newInstanceInformation smart constructor.

Constructors

InstanceInformation'

Fields

activationId :: Maybe Text
The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
agentVersion :: Maybe Text
The version of SSM Agent running on your Linux managed node.
associationOverview :: Maybe InstanceAggregatedAssociationOverview
Information about the association.
associationStatus :: Maybe Text
The status of the association.
computerName :: Maybe Text
The fully qualified host name of the managed node.
iPAddress :: Maybe Text
The IP address of the managed node.
iamRole :: Maybe Text
The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.
instanceId :: Maybe Text
The managed node ID.
isLatestVersion :: Maybe Bool
Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.
lastAssociationExecutionDate :: Maybe POSIX
The date the association was last run.
lastPingDateTime :: Maybe POSIX
The date and time when the agent last pinged the Systems Manager service.
lastSuccessfulAssociationExecutionDate :: Maybe POSIX
The last date the association was successfully run.
name :: Maybe Text
The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.
pingStatus :: Maybe PingStatus
Connection status of SSM Agent.
The status Inactive has been deprecated and is no longer in use.
platformName :: Maybe Text
The name of the operating system platform running on your managed node.
platformType :: Maybe PlatformType
The operating system platform type.
platformVersion :: Maybe Text
The version of the OS platform running on your managed node.
registrationDate :: Maybe POSIX
The date the server or VM was registered with Amazon Web Services as a managed node.
resourceType :: Maybe ResourceType
The type of instance. Instances are either EC2 instances or managed instances.
sourceId :: Maybe Text
The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.
sourceType :: Maybe SourceType
The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.

Instances

Instances details

FromJSON InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods parseJSON :: Value -> Parser InstanceInformation # parseJSONList :: Value -> Parser [InstanceInformation] #
Generic InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Associated Types type Rep InstanceInformation :: Type -> Type # Methods from :: InstanceInformation -> Rep InstanceInformation x # to :: Rep InstanceInformation x -> InstanceInformation #
Read InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods readsPrec :: Int -> ReadS InstanceInformation # readList :: ReadS [InstanceInformation] # readPrec :: ReadPrec InstanceInformation # readListPrec :: ReadPrec [InstanceInformation] #
Show InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods showsPrec :: Int -> InstanceInformation -> ShowS # show :: InstanceInformation -> String # showList :: [InstanceInformation] -> ShowS #
NFData InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods rnf :: InstanceInformation -> () #
Eq InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods (==) :: InstanceInformation -> InstanceInformation -> Bool # (/=) :: InstanceInformation -> InstanceInformation -> Bool #
Hashable InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods hashWithSalt :: Int -> InstanceInformation -> Int # hash :: InstanceInformation -> Int #
type Rep InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation type Rep InstanceInformation = D1 ('MetaData "InstanceInformation" "Amazonka.SSM.Types.InstanceInformation" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "InstanceInformation'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "activationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "agentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "associationOverview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceAggregatedAssociationOverview)) :: (S1 ('MetaSel ('Just "associationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "computerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "iPAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "isLatestVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "lastAssociationExecutionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :: (((S1 ('MetaSel ('Just "lastPingDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastSuccessfulAssociationExecutionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PingStatus)) :: S1 ('MetaSel ('Just "platformName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "platformType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlatformType)) :: (S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "registrationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :: (S1 ('MetaSel ('Just "sourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType))))))))

newInstanceInformation :: InstanceInformation Source #

Create a value of InstanceInformation 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:activationId:InstanceInformation', instanceInformation_activationId - The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.

$sel:agentVersion:InstanceInformation', instanceInformation_agentVersion - The version of SSM Agent running on your Linux managed node.

$sel:associationOverview:InstanceInformation', instanceInformation_associationOverview - Information about the association.

$sel:associationStatus:InstanceInformation', instanceInformation_associationStatus - The status of the association.

$sel:computerName:InstanceInformation', instanceInformation_computerName - The fully qualified host name of the managed node.

$sel:iPAddress:InstanceInformation', instanceInformation_iPAddress - The IP address of the managed node.

$sel:iamRole:InstanceInformation', instanceInformation_iamRole - The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

$sel:instanceId:InstanceInformation', instanceInformation_instanceId - The managed node ID.

$sel:isLatestVersion:InstanceInformation', instanceInformation_isLatestVersion - Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.

$sel:lastAssociationExecutionDate:InstanceInformation', instanceInformation_lastAssociationExecutionDate - The date the association was last run.

$sel:lastPingDateTime:InstanceInformation', instanceInformation_lastPingDateTime - The date and time when the agent last pinged the Systems Manager service.

$sel:lastSuccessfulAssociationExecutionDate:InstanceInformation', instanceInformation_lastSuccessfulAssociationExecutionDate - The last date the association was successfully run.

$sel:name:InstanceInformation', instanceInformation_name - The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

$sel:pingStatus:InstanceInformation', instanceInformation_pingStatus - Connection status of SSM Agent.

The status Inactive has been deprecated and is no longer in use.

$sel:platformName:InstanceInformation', instanceInformation_platformName - The name of the operating system platform running on your managed node.

$sel:platformType:InstanceInformation', instanceInformation_platformType - The operating system platform type.

$sel:platformVersion:InstanceInformation', instanceInformation_platformVersion - The version of the OS platform running on your managed node.

$sel:registrationDate:InstanceInformation', instanceInformation_registrationDate - The date the server or VM was registered with Amazon Web Services as a managed node.

$sel:resourceType:InstanceInformation', instanceInformation_resourceType - The type of instance. Instances are either EC2 instances or managed instances.

$sel:sourceId:InstanceInformation', instanceInformation_sourceId - The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.

$sel:sourceType:InstanceInformation', instanceInformation_sourceType - The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.

instanceInformation_activationId :: Lens' InstanceInformation (Maybe Text) Source #

The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.

instanceInformation_agentVersion :: Lens' InstanceInformation (Maybe Text) Source #

The version of SSM Agent running on your Linux managed node.

instanceInformation_associationOverview :: Lens' InstanceInformation (Maybe InstanceAggregatedAssociationOverview) Source #

Information about the association.

instanceInformation_associationStatus :: Lens' InstanceInformation (Maybe Text) Source #

The status of the association.

instanceInformation_computerName :: Lens' InstanceInformation (Maybe Text) Source #

The fully qualified host name of the managed node.

instanceInformation_iPAddress :: Lens' InstanceInformation (Maybe Text) Source #

The IP address of the managed node.

instanceInformation_iamRole :: Lens' InstanceInformation (Maybe Text) Source #

The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

instanceInformation_instanceId :: Lens' InstanceInformation (Maybe Text) Source #

The managed node ID.

instanceInformation_isLatestVersion :: Lens' InstanceInformation (Maybe Bool) Source #

Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.

instanceInformation_lastAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime) Source #

The date the association was last run.

instanceInformation_lastPingDateTime :: Lens' InstanceInformation (Maybe UTCTime) Source #

The date and time when the agent last pinged the Systems Manager service.

instanceInformation_lastSuccessfulAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime) Source #

The last date the association was successfully run.

instanceInformation_name :: Lens' InstanceInformation (Maybe Text) Source #

The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

instanceInformation_pingStatus :: Lens' InstanceInformation (Maybe PingStatus) Source #

Connection status of SSM Agent.

The status Inactive has been deprecated and is no longer in use.

instanceInformation_platformName :: Lens' InstanceInformation (Maybe Text) Source #

The name of the operating system platform running on your managed node.

instanceInformation_platformType :: Lens' InstanceInformation (Maybe PlatformType) Source #

The operating system platform type.

instanceInformation_platformVersion :: Lens' InstanceInformation (Maybe Text) Source #

The version of the OS platform running on your managed node.

instanceInformation_registrationDate :: Lens' InstanceInformation (Maybe UTCTime) Source #

The date the server or VM was registered with Amazon Web Services as a managed node.

instanceInformation_resourceType :: Lens' InstanceInformation (Maybe ResourceType) Source #

The type of instance. Instances are either EC2 instances or managed instances.

instanceInformation_sourceId :: Lens' InstanceInformation (Maybe Text) Source #

The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.

instanceInformation_sourceType :: Lens' InstanceInformation (Maybe SourceType) Source #

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.