Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

Association

Describes an association of a Systems Manager document and an instance.

Contents

AssociationId

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

Type: String

Pattern: [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}

Required: No

AssociationName

The association name.

Type: String

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

Required: No

AssociationVersion

The association version.

Type: String

Pattern: ([$]LATEST)|([1-9][0-9]*)

Required: No

DocumentVersion

The version of the document used in the association.

Type: String

Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Required: No

InstanceId

The ID of the instance.

Type: String

Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

Required: No

LastExecutionDate

The date on which the association was last run.

Type: Timestamp

Required: No

Name

The name of the Systems Manager document.

Type: String

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

Required: No

Overview

Information about the association.

Type: AssociationOverview object

Required: No

ScheduleExpression

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Targets

The instances targeted by the request to create an association.

Type: Array of Target objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: