association_versions

Creates, updates, deletes, gets or lists an association_versions resource.

Overview

Name	association_versions
Type	Resource
Id	aws.ssm.association_versions

Fields

The following fields are returned by SELECT queries:

list_association_versions

Name	Datatype	Description
apply_only_at_cron_interval	boolean	By default, when you create 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_dispatch_assume_role	string	A role used by association to take actions on your behalf. State Manager will assume this role and call required APIs when dispatching configurations to nodes. If not specified, service-linked role for Systems Manager will be used by default. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
association_id	string	The ID created by the system when the association was created. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
association_name	string	The name specified for the association version when the association version was created. (pattern: <code>^[a-zA-Z0-9_-.]{3,128}$</code>)
association_version	string	The association version. (pattern: <code>([$]LATEST)|([1-9][0-9]*)</code>)
calendar_names	array	The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
compliance_severity	string	The severity level that is assigned to the association. (CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED)
created_date	string (date-time)	The date the association version was created.
document_version	string	The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created. (pattern: <code>([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)</code>)
duration	integer	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.
max_concurrency	string	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. (pattern: <code>^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$</code>)
max_errors	string	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. (pattern: <code>^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$</code>)
name	string	The name specified when the association was created. (pattern: <code>^[a-zA-Z0-9_-.:/]{3,128}$</code>)
output_location	object	The location in Amazon S3 specified for the association when the association version was created.
parameters	object	Parameters specified when the association version was created.
schedule_expression	string	The cron or rate schedule specified for the association when the association version was created.
schedule_offset	integer	Number of days to wait after the scheduled day to run an association.
sync_compliance	string	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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation. By default, all associations use AUTO mode. (AUTO, MANUAL)
target_locations	array	The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.
target_maps	array	A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
targets	array	The targets specified for the association when the association version was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_association_versions	select	region		Retrieves all versions of an association for a specific association ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_association_versions

Retrieves all versions of an association for a specific association ID.

SELECT
apply_only_at_cron_interval,
association_dispatch_assume_role,
association_id,
association_name,
association_version,
calendar_names,
compliance_severity,
created_date,
document_version,
duration,
max_concurrency,
max_errors,
name,
output_location,
parameters,
schedule_expression,
schedule_offset,
sync_compliance,
target_locations,
target_maps,
targets
FROM aws.ssm.association_versions
WHERE region = '{{ region }}' -- required
;