This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_ssm_instance

account_id

Type: STRING

activation_id

Type: STRING
Provider name: ActivationId
Description: The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.

agent_version

Type: STRING
Provider name: AgentVersion
Description: The version of SSM Agent running on your Linux managed node.

association_overview

Type: STRUCT
Provider name: AssociationOverview
Description: Information about the association.

  • detailed_status
    Type: STRING
    Provider name: DetailedStatus
    Description: Detailed status information about the aggregated associations.
  • instance_association_status_aggregated_count
    Type: MAP_STRING_INT32
    Provider name: InstanceAssociationStatusAggregatedCount
    Description: The number of associations for the managed nodes.

association_status

Type: STRING
Provider name: AssociationStatus
Description: The status of the association.

compliance_items

Type: UNORDERED_LIST_STRUCT
Provider name: ComplianceItems
Description: A list of compliance information for the specified resource ID.

  • compliance_type
    Type: STRING
    Provider name: ComplianceType
    Description: The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.
  • details
    Type: MAP_STRING_STRING
    Provider name: Details
    Description: A “Key”: “Value” tag combination for the compliance item.
  • execution_summary
    Type: STRUCT
    Provider name: ExecutionSummary
    Description: A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.
    • execution_id
      Type: STRING
      Provider name: ExecutionId
      Description: An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.
    • execution_time
      Type: TIMESTAMP
      Provider name: ExecutionTime
      Description: The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd’T’HH:mm:ss’Z’
    • execution_type
      Type: STRING
      Provider name: ExecutionType
      Description: The type of execution. For example, Command is a valid execution type.
  • id
    Type: STRING
    Provider name: Id
    Description: An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.
  • resource_id
    Type: STRING
    Provider name: ResourceId
    Description: An ID for the resource. For a managed node, this is the node ID.
  • resource_type
    Type: STRING
    Provider name: ResourceType
    Description: The type of resource. ManagedInstance is currently the only supported resource type.
  • severity
    Type: STRING
    Provider name: Severity
    Description: The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren’t applicable).
  • title
    Type: STRING
    Provider name: Title
    Description: A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

computer_name

Type: STRING
Provider name: ComputerName
Description: The fully qualified host name of the managed node.

iam_role

Type: STRING
Provider name: IamRole
Description: 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.

instance_arn

Type: STRING

instance_id

Type: STRING
Provider name: InstanceId
Description: The managed node ID.

ip_address

Type: STRING
Provider name: IPAddress
Description: The IP address of the managed node.

is_latest_version

Type: BOOLEAN
Provider name: IsLatestVersion
Description: 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.

last_association_execution_date

Type: TIMESTAMP
Provider name: LastAssociationExecutionDate
Description: The date the association was last run.

last_ping_date_time

Type: TIMESTAMP
Provider name: LastPingDateTime
Description: The date and time when the agent last pinged the Systems Manager service.

last_successful_association_execution_date

Type: TIMESTAMP
Provider name: LastSuccessfulAssociationExecutionDate
Description: The last date the association was successfully run.

name

Type: STRING
Provider name: Name
Description: 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 and multicloud environment (Linux) and Install SSM Agent for a hybrid and multicloud 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.

ping_status

Type: STRING
Provider name: PingStatus
Description: Connection status of SSM Agent. The status Inactive has been deprecated and is no longer in use.

platform_name

Type: STRING
Provider name: PlatformName
Description: The name of the operating system platform running on your managed node.

platform_type

Type: STRING
Provider name: PlatformType
Description: The operating system platform type.

platform_version

Type: STRING
Provider name: PlatformVersion
Description: The version of the OS platform running on your managed node.

registration_date

Type: TIMESTAMP
Provider name: RegistrationDate
Description: The date the server or VM was registered with Amazon Web Services as a managed node.

resource_type

Type: STRING
Provider name: ResourceType
Description: The type of instance. Instances are either EC2 instances or managed instances.

source_id

Type: STRING
Provider name: SourceId
Description: The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.

source_type

Type: STRING
Provider name: SourceType
Description: The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.

tags

Type: UNORDERED_LIST_STRING