Skip to content

List Associations

ssm_list_associations R Documentation

Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region

Description

Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

Usage

ssm_list_associations(AssociationFilterList, MaxResults, NextToken)

Arguments

AssociationFilterList

One or more filters. Use a filter to return a more specific list of results.

Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the managed node that are part of the Target Attributes ResourceGroup or Tags aren't returned.

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

Value

A list with the following syntax:

list(
  Associations = list(
    list(
      Name = "string",
      InstanceId = "string",
      AssociationId = "string",
      AssociationVersion = "string",
      DocumentVersion = "string",
      Targets = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      LastExecutionDate = as.POSIXct(
        "2015-01-01"
      ),
      Overview = list(
        Status = "string",
        DetailedStatus = "string",
        AssociationStatusAggregatedCount = list(
          123
        )
      ),
      ScheduleExpression = "string",
      AssociationName = "string",
      ScheduleOffset = 123,
      Duration = 123,
      TargetMaps = list(
        list(
          list(
            "string"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_associations(
  AssociationFilterList = list(
    list(
      key = "InstanceId"|"Name"|"AssociationId"|"AssociationStatusName"|"LastExecutedBefore"|"LastExecutedAfter"|"AssociationName"|"ResourceGroupName",
      value = "string"
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)