@aws-sdk/client-ssm
Version:
AWS SDK for JavaScript Ssm Client for Node.js, Browser and React Native
108 lines (107 loc) • 5.03 kB
TypeScript
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { DescribeEffectiveInstanceAssociationsRequest, DescribeEffectiveInstanceAssociationsResult } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
/**
* @public
*
* The input for {@link DescribeEffectiveInstanceAssociationsCommand}.
*/
export interface DescribeEffectiveInstanceAssociationsCommandInput extends DescribeEffectiveInstanceAssociationsRequest {
}
/**
* @public
*
* The output of {@link DescribeEffectiveInstanceAssociationsCommand}.
*/
export interface DescribeEffectiveInstanceAssociationsCommandOutput extends DescribeEffectiveInstanceAssociationsResult, __MetadataBearer {
}
declare const DescribeEffectiveInstanceAssociationsCommand_base: {
new (input: DescribeEffectiveInstanceAssociationsCommandInput): import("@smithy/core/client").CommandImpl<DescribeEffectiveInstanceAssociationsCommandInput, DescribeEffectiveInstanceAssociationsCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
new (input: DescribeEffectiveInstanceAssociationsCommandInput): import("@smithy/core/client").CommandImpl<DescribeEffectiveInstanceAssociationsCommandInput, DescribeEffectiveInstanceAssociationsCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
};
/**
* <p>All associations for the managed nodes.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { SSMClient, DescribeEffectiveInstanceAssociationsCommand } from "@aws-sdk/client-ssm"; // ES Modules import
* // const { SSMClient, DescribeEffectiveInstanceAssociationsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
* // import type { SSMClientConfig } from "@aws-sdk/client-ssm";
* const config = {}; // type is SSMClientConfig
* const client = new SSMClient(config);
* const input = { // DescribeEffectiveInstanceAssociationsRequest
* InstanceId: "STRING_VALUE", // required
* MaxResults: Number("int"),
* NextToken: "STRING_VALUE",
* };
* const command = new DescribeEffectiveInstanceAssociationsCommand(input);
* const response = await client.send(command);
* // { // DescribeEffectiveInstanceAssociationsResult
* // Associations: [ // InstanceAssociationList
* // { // InstanceAssociation
* // AssociationId: "STRING_VALUE",
* // InstanceId: "STRING_VALUE",
* // Content: "STRING_VALUE",
* // AssociationVersion: "STRING_VALUE",
* // },
* // ],
* // NextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param DescribeEffectiveInstanceAssociationsCommandInput - {@link DescribeEffectiveInstanceAssociationsCommandInput}
* @returns {@link DescribeEffectiveInstanceAssociationsCommandOutput}
* @see {@link DescribeEffectiveInstanceAssociationsCommandInput} for command's `input` shape.
* @see {@link DescribeEffectiveInstanceAssociationsCommandOutput} for command's `response` shape.
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
*
* @throws {@link InternalServerError} (server fault)
* <p>An error occurred on the server side.</p>
*
* @throws {@link InvalidInstanceId} (client fault)
* <p>The following problems can cause this exception:</p>
* <ul>
* <li>
* <p>You don't have permission to access the managed node.</p>
* </li>
* <li>
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
* running.</p>
* </li>
* <li>
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
* </li>
* <li>
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
* </li>
* </ul>
*
* @throws {@link InvalidNextToken} (client fault)
* <p>The specified token isn't valid.</p>
*
* @throws {@link SSMServiceException}
* <p>Base exception class for all service exceptions from SSM service.</p>
*
*
* @public
*/
export declare class DescribeEffectiveInstanceAssociationsCommand extends DescribeEffectiveInstanceAssociationsCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: DescribeEffectiveInstanceAssociationsRequest;
output: DescribeEffectiveInstanceAssociationsResult;
};
sdk: {
input: DescribeEffectiveInstanceAssociationsCommandInput;
output: DescribeEffectiveInstanceAssociationsCommandOutput;
};
};
}