AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeInstanceProperties and EndDescribeInstanceProperties.

Namespace: Amazon.SimpleSystemsManagement
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DescribeInstancePropertiesResponse> DescribeInstancePropertiesAsync(
         DescribeInstancePropertiesRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.SimpleSystemsManagement.Model.DescribeInstancePropertiesRequest

Container for the necessary parameters to execute the DescribeInstanceProperties service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeInstanceProperties service method, as returned by SimpleSystemsManagement.

Exceptions

ExceptionCondition
InternalServerErrorException An error occurred on the server side.
InvalidActivationIdException The activation ID isn't valid. Verify that you entered the correct ActivationId or ActivationCode and try again.
InvalidDocumentException The specified SSM document doesn't exist.
InvalidFilterKeyException The specified key isn't valid.
InvalidInstanceIdException 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.
InvalidInstancePropertyFilterValueException The specified filter value isn't valid.
InvalidNextTokenException The specified token isn't valid.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also