Describe Association

ssm_describe_association

R Documentation

Describes the association for the specified target or managed node

Description

Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.

Usage

ssm_describe_association(Name, InstanceId, AssociationId,
  AssociationVersion)

Arguments

Name

The name of the SSM document.

InstanceId

The managed node ID.

AssociationId

The association ID for which you want information.

AssociationVersion

Specify the association version to retrieve. To view the latest version, either specify ⁠$LATEST⁠ for this parameter, or omit this parameter. To view a list of all associations for a managed node, use list_associations. To get a list of versions for a specific association, use list_association_versions.

Value

A list with the following syntax:

list(
  AssociationDescription = list(
    Name = "string",
    InstanceId = "string",
    AssociationVersion = "string",
    Date = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdateAssociationDate = as.POSIXct(
      "2015-01-01"
    ),
    Status = list(
      Date = as.POSIXct(
        "2015-01-01"
      ),
      Name = "Pending"|"Success"|"Failed",
      Message = "string",
      AdditionalInfo = "string"
    ),
    Overview = list(
      Status = "string",
      DetailedStatus = "string",
      AssociationStatusAggregatedCount = list(
        123
      )
    ),
    DocumentVersion = "string",
    AutomationTargetParameterName = "string",
    Parameters = list(
      list(
        "string"
      )
    ),
    AssociationId = "string",
    Targets = list(
      list(
        Key = "string",
        Values = list(
          "string"
        )
      )
    ),
    ScheduleExpression = "string",
    OutputLocation = list(
      S3Location = list(
        OutputS3Region = "string",
        OutputS3BucketName = "string",
        OutputS3KeyPrefix = "string"
      )
    ),
    LastExecutionDate = as.POSIXct(
      "2015-01-01"
    ),
    LastSuccessfulExecutionDate = as.POSIXct(
      "2015-01-01"
    ),
    AssociationName = "string",
    MaxErrors = "string",
    MaxConcurrency = "string",
    ComplianceSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"UNSPECIFIED",
    SyncCompliance = "AUTO"|"MANUAL",
    ApplyOnlyAtCronInterval = TRUE|FALSE,
    CalendarNames = list(
      "string"
    ),
    TargetLocations = list(
      list(
        Accounts = list(
          "string"
        ),
        Regions = list(
          "string"
        ),
        TargetLocationMaxConcurrency = "string",
        TargetLocationMaxErrors = "string",
        ExecutionRoleName = "string",
        TargetLocationAlarmConfiguration = list(
          IgnorePollAlarmFailure = TRUE|FALSE,
          Alarms = list(
            list(
              Name = "string"
            )
          )
        )
      )
    ),
    ScheduleOffset = 123,
    Duration = 123,
    TargetMaps = list(
      list(
        list(
          "string"
        )
      )
    ),
    AlarmConfiguration = list(
      IgnorePollAlarmFailure = TRUE|FALSE,
      Alarms = list(
        list(
          Name = "string"
        )
      )
    ),
    TriggeredAlarms = list(
      list(
        Name = "string",
        State = "UNKNOWN"|"ALARM"
      )
    )
  )
)

Request syntax

svc$describe_association(
  Name = "string",
  InstanceId = "string",
  AssociationId = "string",
  AssociationVersion = "string"
)