Skip to content

DescribeParametersRequest

Source code in docs_src/capo_ssm/types/describe_parameters_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class DescribeParametersRequest(TypedDict, closed=True):
    filters: NotRequired["capo_ssm.types.parameters_filter_list.ParametersFilterList"]
    """<p>This data type is deprecated. Instead, use <code>ParameterFilters</code>.</p>"""
    parameter_filters: NotRequired[
        "capo_ssm.types.parameter_string_filter_list.ParameterStringFilterList"
    ]
    """<p>Filters to limit the request results.</p>"""
    max_results: NotRequired["capo_ssm.types.max_results.MaxResults"]
    """<p>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.</p>"""
    next_token: NotRequired["capo_ssm.types.next_token.NextToken"]
    """<p>The token for the next set of items to return. (You received this token from a previous call.)</p>"""
    shared: NotRequired["capo_ssm.types.boolean.Boolean"]
    """<p>Lists parameters that are shared with you.</p> <note> <p>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 <a>PutResourcePolicy</a> command to be returned, the associated <code>RAM Resource Share Created From Policy</code> must have been promoted to a standard Resource Share using the RAM <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> API operation.</p> <p>For more information about sharing parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with shared parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </note>"""

filters instance-attribute 

filters: NotRequired[ParametersFilterList]

This data type is deprecated. Instead, use ParameterFilters.

max_results instance-attribute 

max_results: NotRequired[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.

next_token instance-attribute 

next_token: NotRequired[NextToken]

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

parameter_filters instance-attribute 

parameter_filters: NotRequired[ParameterStringFilterList]

Filters to limit the request results.

shared instance-attribute 

shared: NotRequired[Boolean]

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.