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.

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing.

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 BeginDescribeParameters and EndDescribeParameters.

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

Syntax

C#
public virtual Task<DescribeParametersResponse> DescribeParametersAsync(
         DescribeParametersRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.SimpleSystemsManagement.Model.DescribeParametersRequest

Container for the necessary parameters to execute the DescribeParameters 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 DescribeParameters service method, as returned by SimpleSystemsManagement.

Exceptions

ExceptionCondition
InternalServerErrorException An error occurred on the server side.
InvalidFilterKeyException The specified key isn't valid.
InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
InvalidNextTokenException The specified token isn't valid.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also