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.

Container for the parameters to the DescribeParameters operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
      Amazon.SimpleSystemsManagement.Model.DescribeParametersRequest

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

Syntax

C#
public class DescribeParametersRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The DescribeParametersRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeParametersRequest()

Properties

NameTypeDescription
Public Property Filters System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.ParametersFilter>

Gets and sets the property Filters.

This data type is deprecated. Instead, use ParameterFilters.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token for the next set of items to return. (You received this token from a previous call.)

Public Property ParameterFilters System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.ParameterStringFilter>

Gets and sets the property ParameterFilters.

Filters to limit the request results.

Public Property Shared System.Boolean

Gets and sets the property Shared.

Lists parameters that are shared with you.

By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.

For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5