Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.Types.InstanceInformation

Description

Synopsis

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

Documentation

data InstanceInformation Source #

Describes a filter for a specific list of instances.

See: newInstanceInformation smart constructor.

Constructors

InstanceInformation'

Fields

instanceId :: Maybe Text
The instance ID.
pingStatus :: Maybe PingStatus
Connection status of SSM Agent.
The status Inactive has been deprecated and is no longer in use.
iPAddress :: Maybe Text
The IP address of the managed instance.
resourceType :: Maybe ResourceType
The type of instance. Instances are either EC2 instances or managed instances.
registrationDate :: Maybe POSIX
The date the server or VM was registered with Amazon Web Services as a managed instance.
platformVersion :: Maybe Text
The version of the OS platform running on your instance.
isLatestVersion :: Maybe Bool
Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field doesn't indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.
agentVersion :: Maybe Text
The version of SSM Agent running on your Linux instance.
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.
activationId :: Maybe Text
The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
name :: Maybe Text
The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, 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.
platformType :: Maybe PlatformType
The operating system platform type.
associationOverview :: Maybe InstanceAggregatedAssociationOverview
Information about the association.
associationStatus :: Maybe Text
The status of the association.
lastAssociationExecutionDate :: Maybe POSIX
The date the association was last run.
platformName :: Maybe Text
The name of the operating system platform running on your instance.
computerName :: Maybe Text
The fully qualified host name of the managed instance.
iamRole :: Maybe Text
The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance. 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.

Instances

Instances details

Eq InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods (==) :: InstanceInformation -> InstanceInformation -> Bool # (/=) :: InstanceInformation -> InstanceInformation -> Bool #
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 #
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 #
NFData InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods rnf :: InstanceInformation -> () #
Hashable InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods hashWithSalt :: Int -> InstanceInformation -> Int # hash :: InstanceInformation -> Int #
FromJSON InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation Methods parseJSON :: Value -> Parser InstanceInformation # parseJSONList :: Value -> Parser [InstanceInformation] #
type Rep InstanceInformation Source #
Instance details Defined in Amazonka.SSM.Types.InstanceInformation type Rep InstanceInformation = D1 ('MetaData "InstanceInformation" "Amazonka.SSM.Types.InstanceInformation" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "InstanceInformation'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PingStatus))) :: (S1 ('MetaSel ('Just "iPAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)))) :: ((S1 ('MetaSel ('Just "registrationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "isLatestVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "agentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastPingDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :: (((S1 ('MetaSel ('Just "lastSuccessfulAssociationExecutionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "activationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "platformType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlatformType)) :: S1 ('MetaSel ('Just "associationOverview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceAggregatedAssociationOverview))))) :: ((S1 ('MetaSel ('Just "associationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastAssociationExecutionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "platformName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "computerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

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:instanceId:InstanceInformation', instanceInformation_instanceId - The instance ID.

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

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

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

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

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

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

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

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

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

$sel:name:InstanceInformation', instanceInformation_name - The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, 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:platformType:InstanceInformation', instanceInformation_platformType - The operating system platform type.

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

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

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

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

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

$sel:iamRole:InstanceInformation', instanceInformation_iamRole - The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance. 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 instance ID.

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_iPAddress :: Lens' InstanceInformation (Maybe Text) Source #

The IP address of the managed instance.

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

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

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

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

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

The version of the OS platform running on your instance.

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

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

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

The version of SSM Agent running on your Linux instance.

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_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_name :: Lens' InstanceInformation (Maybe Text) Source #

The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, 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_platformType :: Lens' InstanceInformation (Maybe PlatformType) Source #

The operating system platform type.

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

Information about the association.

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

The status of the association.

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

The date the association was last run.

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

The name of the operating system platform running on your instance.

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

The fully qualified host name of the managed instance.

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

The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance. 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.