@aws-sdk/client-ssm
Version:
AWS SDK for JavaScript Ssm Client for Node.js, Browser and React Native
162 lines (161 loc) • 7.62 kB
TypeScript
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { DescribeInstanceInformationRequest, DescribeInstanceInformationResult } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
/**
* @public
*
* The input for {@link DescribeInstanceInformationCommand}.
*/
export interface DescribeInstanceInformationCommandInput extends DescribeInstanceInformationRequest {
}
/**
* @public
*
* The output of {@link DescribeInstanceInformationCommand}.
*/
export interface DescribeInstanceInformationCommandOutput extends DescribeInstanceInformationResult, __MetadataBearer {
}
declare const DescribeInstanceInformationCommand_base: {
new (input: DescribeInstanceInformationCommandInput): import("@smithy/core/client").CommandImpl<DescribeInstanceInformationCommandInput, DescribeInstanceInformationCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
new (...[input]: [] | [DescribeInstanceInformationCommandInput]): import("@smithy/core/client").CommandImpl<DescribeInstanceInformationCommandInput, DescribeInstanceInformationCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
};
/**
* <p>Provides information about one or more of your managed nodes, including the operating system
* platform, SSM Agent version, association status, and IP address. This operation does not return
* information for nodes that are either Stopped or Terminated.</p>
* <p>If you specify one or more node IDs, the operation returns information for those managed
* nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you
* specify a node ID that isn't valid or a node that you don't own, you receive an error.</p>
* <note>
* <p>The <code>IamRole</code> field returned for this API operation is the role assigned to an
* Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or
* the role assigned to an on-premises managed node.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { SSMClient, DescribeInstanceInformationCommand } from "@aws-sdk/client-ssm"; // ES Modules import
* // const { SSMClient, DescribeInstanceInformationCommand } = 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 = { // DescribeInstanceInformationRequest
* InstanceInformationFilterList: [ // InstanceInformationFilterList
* { // InstanceInformationFilter
* key: "InstanceIds" || "AgentVersion" || "PingStatus" || "PlatformTypes" || "ActivationIds" || "IamRole" || "ResourceType" || "AssociationStatus", // required
* valueSet: [ // InstanceInformationFilterValueSet // required
* "STRING_VALUE",
* ],
* },
* ],
* Filters: [ // InstanceInformationStringFilterList
* { // InstanceInformationStringFilter
* Key: "STRING_VALUE", // required
* Values: [ // required
* "STRING_VALUE",
* ],
* },
* ],
* MaxResults: Number("int"),
* NextToken: "STRING_VALUE",
* };
* const command = new DescribeInstanceInformationCommand(input);
* const response = await client.send(command);
* // { // DescribeInstanceInformationResult
* // InstanceInformationList: [ // InstanceInformationList
* // { // InstanceInformation
* // InstanceId: "STRING_VALUE",
* // PingStatus: "Online" || "ConnectionLost" || "Inactive",
* // LastPingDateTime: new Date("TIMESTAMP"),
* // AgentVersion: "STRING_VALUE",
* // IsLatestVersion: true || false,
* // PlatformType: "Windows" || "Linux" || "MacOS",
* // PlatformName: "STRING_VALUE",
* // PlatformVersion: "STRING_VALUE",
* // ActivationId: "STRING_VALUE",
* // IamRole: "STRING_VALUE",
* // RegistrationDate: new Date("TIMESTAMP"),
* // ResourceType: "ManagedInstance" || "EC2Instance",
* // Name: "STRING_VALUE",
* // IPAddress: "STRING_VALUE",
* // ComputerName: "STRING_VALUE",
* // AssociationStatus: "STRING_VALUE",
* // LastAssociationExecutionDate: new Date("TIMESTAMP"),
* // LastSuccessfulAssociationExecutionDate: new Date("TIMESTAMP"),
* // AssociationOverview: { // InstanceAggregatedAssociationOverview
* // DetailedStatus: "STRING_VALUE",
* // InstanceAssociationStatusAggregatedCount: { // InstanceAssociationStatusAggregatedCount
* // "<keys>": Number("int"),
* // },
* // },
* // SourceId: "STRING_VALUE",
* // SourceType: "AWS::EC2::Instance" || "AWS::IoT::Thing" || "AWS::SSM::ManagedInstance" || "Microsoft.Compute/virtualMachines",
* // SourceLocation: "STRING_VALUE",
* // },
* // ],
* // NextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param DescribeInstanceInformationCommandInput - {@link DescribeInstanceInformationCommandInput}
* @returns {@link DescribeInstanceInformationCommandOutput}
* @see {@link DescribeInstanceInformationCommandInput} for command's `input` shape.
* @see {@link DescribeInstanceInformationCommandOutput} 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 InvalidFilterKey} (client fault)
* <p>The specified key isn't valid.</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 InvalidInstanceInformationFilterValue} (client fault)
* <p>The specified filter value isn't valid.</p>
*
* @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 DescribeInstanceInformationCommand extends DescribeInstanceInformationCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: DescribeInstanceInformationRequest;
output: DescribeInstanceInformationResult;
};
sdk: {
input: DescribeInstanceInformationCommandInput;
output: DescribeInstanceInformationCommandOutput;
};
};
}