ssm_describe_parameters: Get information about a parameter

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Get information about a parameter.

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.

Usage

1
2
ssm_describe_parameters(Filters, ParameterFilters, MaxResults,
  NextToken)

Arguments

Filters

This data type is deprecated. Instead, use ParameterFilters.

ParameterFilters

Filters to limit the request results.

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.

NextToken

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
list(
  Parameters = list(
    list(
      Name = "string",
      Type = "String"|"StringList"|"SecureString",
      KeyId = "string",
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedUser = "string",
      Description = "string",
      AllowedPattern = "string",
      Version = 123,
      Tier = "Standard"|"Advanced"|"Intelligent-Tiering",
      Policies = list(
        list(
          PolicyText = "string",
          PolicyType = "string",
          PolicyStatus = "string"
        )
      ),
      DataType = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
svc$describe_parameters(
  Filters = list(
    list(
      Key = "Name"|"Type"|"KeyId",
      Values = list(
        "string"
      )
    )
  ),
  ParameterFilters = list(
    list(
      Key = "string",
      Option = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.