Skip to content

aws.ssm.describe_association

Example SQL Queries

SELECT * FROM
aws.ssm.describe_association;

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.

Table Definition

Column NameColumn Data Type
association_id Input Column

The association ID for which you want information.

VARCHAR
association_version Input Column

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 ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

VARCHAR
instance_id Input Column

The managed node ID.

VARCHAR
name Input Column

The name of the SSM document.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
association_description

Information about the association.

STRUCT(
"name" VARCHAR,
"instance_id" VARCHAR,
"association_version" VARCHAR,
"date" TIMESTAMP_S,
"last_update_association_date" TIMESTAMP_S,
"status" STRUCT(
"date" TIMESTAMP_S,
"name" VARCHAR,
"message" VARCHAR,
"additional_info" VARCHAR
),
"overview" STRUCT(
"status" VARCHAR,
"detailed_status" VARCHAR,
"association_status_aggregated_count" MAP(VARCHAR, BIGINT)
),
"document_version" VARCHAR,
"automation_target_parameter_name" VARCHAR,
"parameters" MAP(VARCHAR, VARCHAR[]),
"association_id" VARCHAR,
"targets" STRUCT(
"key" VARCHAR,
"values" VARCHAR[]
)[],
"schedule_expression" VARCHAR,
"output_location" STRUCT(
"s3_location" STRUCT(
"output_s3_region" VARCHAR,
"output_s3_bucket_name" VARCHAR,
"output_s3_key_prefix" VARCHAR
)
),
"last_execution_date" TIMESTAMP_S,
"last_successful_execution_date" TIMESTAMP_S,
"association_name" VARCHAR,
"max_errors" VARCHAR,
"max_concurrency" VARCHAR,
"compliance_severity" VARCHAR,
"sync_compliance" VARCHAR,
"apply_only_at_cron_interval" BOOLEAN,
"calendar_names" VARCHAR[],
"target_locations" STRUCT(
"accounts" VARCHAR[],
"regions" VARCHAR[],
"target_location_max_concurrency" VARCHAR,
"target_location_max_errors" VARCHAR,
"execution_role_name" VARCHAR,
"target_location_alarm_configuration" STRUCT(
"ignore_poll_alarm_failure" BOOLEAN,
"alarms" STRUCT(
"name" VARCHAR
)[]
)
)[],
"schedule_offset" BIGINT,
"duration" BIGINT,
"target_maps" MAP(VARCHAR, VARCHAR[])[],
"alarm_configuration" STRUCT(
"ignore_poll_alarm_failure" BOOLEAN,
"alarms" STRUCT(
"name" VARCHAR
)[]
),
"triggered_alarms" STRUCT(
"name" VARCHAR,
"state" VARCHAR
)[]
)
Show child fields
association_description.alarm_configuration

The details for the CloudWatch alarm you want to apply to an automation or command.

Show child fields
association_description.alarm_configuration.alarms[]
Show child fields
association_description.alarm_configuration.alarms[].name

The name of your CloudWatch alarm.

association_description.alarm_configuration.ignore_poll_alarm_failure

When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

association_description.apply_only_at_cron_interval

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

association_description.association_id

The association ID.

association_description.association_name

The association name.

association_description.association_version

The association version.

association_description.automation_target_parameter_name

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

association_description.calendar_names[]
association_description.compliance_severity

The severity level that is assigned to the association.

association_description.date

The date when the association was made.

association_description.document_version

The document version.

association_description.duration

The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

association_description.instance_id

The managed node ID.

association_description.last_execution_date

The date on which the association was last run.

association_description.last_successful_execution_date

The last date on which the association was successfully run.

association_description.last_update_association_date

The date when the association was last updated.

association_description.max_concurrency

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

association_description.max_errors

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

association_description.name

The name of the SSM document.

association_description.output_location

An S3 bucket where you want to store the output details of the request.

Show child fields
association_description.output_location.s3_location

An S3 bucket where you want to store the results of this request.

Show child fields
association_description.output_location.s3_location.output_s3_bucket_name

The name of the S3 bucket.

association_description.output_location.s3_location.output_s3_key_prefix

The S3 bucket subfolder.

association_description.output_location.s3_location.output_s3_region

The Amazon Web Services Region of the S3 bucket.

association_description.overview

Information about the association.

Show child fields
association_description.overview.association_status_aggregated_count

Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.

association_description.overview.detailed_status

A detailed status of the association.

association_description.overview.status

The status of the association. Status can be: Pending, Success, or Failed.

association_description.parameters

A description of the parameters for a document.

association_description.schedule_expression

A cron expression that specifies a schedule when the association runs.

association_description.schedule_offset

Number of days to wait after the scheduled day to run an association.

association_description.status

The association status.

Show child fields
association_description.status.additional_info

A user-defined string.

association_description.status.date

The date when the status changed.

association_description.status.message

The reason for the status.

association_description.status.name

The status.

association_description.sync_compliance

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

association_description.target_locations[]
Show child fields
association_description.target_locations[].accounts[]
association_description.target_locations[].execution_role_name

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

association_description.target_locations[].regions[]
association_description.target_locations[].target_location_alarm_configuration

The details for the CloudWatch alarm you want to apply to an automation or command.

Show child fields
association_description.target_locations[].target_location_alarm_configuration.alarms[]
Show child fields
association_description.target_locations[].target_location_alarm_configuration.alarms[].name

The name of your CloudWatch alarm.

association_description.target_locations[].target_location_alarm_configuration.ignore_poll_alarm_failure

When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

association_description.target_locations[].target_location_max_concurrency

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

association_description.target_locations[].target_location_max_errors

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

association_description.target_maps[]
association_description.targets[]
Show child fields
association_description.targets[].key

User-defined criteria for sending commands that target managed nodes that meet the criteria.

association_description.targets[].values[]
association_description.triggered_alarms[]
Show child fields
association_description.triggered_alarms[].name

The name of your CloudWatch alarm.

association_description.triggered_alarms[].state

The state of your CloudWatch alarm.