import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DescribeAssociationRequest, DescribeAssociationResult } from "../models/models_0"; import { ServiceInputTypes, ServiceOutputTypes, SSMClientResolvedConfig } from "../SSMClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeAssociationCommand}. */ export interface DescribeAssociationCommandInput extends DescribeAssociationRequest { } /** * @public * * The output of {@link DescribeAssociationCommand}. */ export interface DescribeAssociationCommandOutput extends DescribeAssociationResult, __MetadataBearer { } declare const DescribeAssociationCommand_base: { new (input: DescribeAssociationCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [DescribeAssociationCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, DescribeAssociationCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, DescribeAssociationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import * const client = new SSMClient(config); * const input = { // DescribeAssociationRequest * Name: "STRING_VALUE", * InstanceId: "STRING_VALUE", * AssociationId: "STRING_VALUE", * AssociationVersion: "STRING_VALUE", * }; * const command = new DescribeAssociationCommand(input); * const response = await client.send(command); * // { // DescribeAssociationResult * // AssociationDescription: { // AssociationDescription * // Name: "STRING_VALUE", * // InstanceId: "STRING_VALUE", * // AssociationVersion: "STRING_VALUE", * // Date: new Date("TIMESTAMP"), * // LastUpdateAssociationDate: new Date("TIMESTAMP"), * // Status: { // AssociationStatus * // Date: new Date("TIMESTAMP"), // required * // Name: "Pending" || "Success" || "Failed", // required * // Message: "STRING_VALUE", // required * // AdditionalInfo: "STRING_VALUE", * // }, * // Overview: { // AssociationOverview * // Status: "STRING_VALUE", * // DetailedStatus: "STRING_VALUE", * // AssociationStatusAggregatedCount: { // AssociationStatusAggregatedCount * // "": Number("int"), * // }, * // }, * // DocumentVersion: "STRING_VALUE", * // AutomationTargetParameterName: "STRING_VALUE", * // Parameters: { // Parameters * // "": [ // ParameterValueList * // "STRING_VALUE", * // ], * // }, * // AssociationId: "STRING_VALUE", * // Targets: [ // Targets * // { // Target * // Key: "STRING_VALUE", * // Values: [ // TargetValues * // "STRING_VALUE", * // ], * // }, * // ], * // ScheduleExpression: "STRING_VALUE", * // OutputLocation: { // InstanceAssociationOutputLocation * // S3Location: { // S3OutputLocation * // OutputS3Region: "STRING_VALUE", * // OutputS3BucketName: "STRING_VALUE", * // OutputS3KeyPrefix: "STRING_VALUE", * // }, * // }, * // LastExecutionDate: new Date("TIMESTAMP"), * // LastSuccessfulExecutionDate: new Date("TIMESTAMP"), * // AssociationName: "STRING_VALUE", * // MaxErrors: "STRING_VALUE", * // MaxConcurrency: "STRING_VALUE", * // ComplianceSeverity: "CRITICAL" || "HIGH" || "MEDIUM" || "LOW" || "UNSPECIFIED", * // SyncCompliance: "AUTO" || "MANUAL", * // ApplyOnlyAtCronInterval: true || false, * // CalendarNames: [ // CalendarNameOrARNList * // "STRING_VALUE", * // ], * // TargetLocations: [ // TargetLocations * // { // TargetLocation * // Accounts: [ // Accounts * // "STRING_VALUE", * // ], * // Regions: [ // Regions * // "STRING_VALUE", * // ], * // TargetLocationMaxConcurrency: "STRING_VALUE", * // TargetLocationMaxErrors: "STRING_VALUE", * // ExecutionRoleName: "STRING_VALUE", * // TargetLocationAlarmConfiguration: { // AlarmConfiguration * // IgnorePollAlarmFailure: true || false, * // Alarms: [ // AlarmList // required * // { // Alarm * // Name: "STRING_VALUE", // required * // }, * // ], * // }, * // IncludeChildOrganizationUnits: true || false, * // ExcludeAccounts: [ // ExcludeAccounts * // "STRING_VALUE", * // ], * // Targets: [ * // { * // Key: "STRING_VALUE", * // Values: [ * // "STRING_VALUE", * // ], * // }, * // ], * // TargetsMaxConcurrency: "STRING_VALUE", * // TargetsMaxErrors: "STRING_VALUE", * // }, * // ], * // ScheduleOffset: Number("int"), * // Duration: Number("int"), * // TargetMaps: [ // TargetMaps * // { // TargetMap * // "": [ // TargetMapValueList * // "STRING_VALUE", * // ], * // }, * // ], * // AlarmConfiguration: { * // IgnorePollAlarmFailure: true || false, * // Alarms: [ // required * // { * // Name: "STRING_VALUE", // required * // }, * // ], * // }, * // TriggeredAlarms: [ // AlarmStateInformationList * // { // AlarmStateInformation * // Name: "STRING_VALUE", // required * // State: "UNKNOWN" || "ALARM", // required * // }, * // ], * // }, * // }; * * ``` * * @param DescribeAssociationCommandInput - {@link DescribeAssociationCommandInput} * @returns {@link DescribeAssociationCommandOutput} * @see {@link DescribeAssociationCommandInput} for command's `input` shape. * @see {@link DescribeAssociationCommandOutput} for command's `response` shape. * @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape. * * @throws {@link AssociationDoesNotExist} (client fault) *

The specified association doesn't exist.

* * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* * @throws {@link InvalidAssociationVersion} (client fault) *

The version you specified isn't valid. Use ListAssociationVersions to view all versions of * an association according to the association ID. Or, use the $LATEST parameter to * view the latest version of the association.

* * @throws {@link InvalidDocument} (client fault) *

The specified SSM document doesn't exist.

* * @throws {@link InvalidInstanceId} (client fault) *

The following problems can cause this exception:

*
    *
  • *

    You don't have permission to access the managed node.

    *
  • *
  • *

    Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is * running.

    *
  • *
  • *

    SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

    *
  • *
  • *

    The managed node isn't in a valid state. Valid states are: Running, * Pending, Stopped, and Stopping. Invalid states are: * Shutting-down and Terminated.

    *
  • *
* * @throws {@link SSMServiceException} *

Base exception class for all service exceptions from SSM service.

* * * @public */ export declare class DescribeAssociationCommand extends DescribeAssociationCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeAssociationRequest; output: DescribeAssociationResult; }; sdk: { input: DescribeAssociationCommandInput; output: DescribeAssociationCommandOutput; }; }; }