You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecretsManager::Types::ListSecretsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListSecretsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  max_results: 1,
  next_token: "NextTokenType",
  filters: [
    {
      key: "description", # accepts description, name, tag-key, tag-value, all
      values: ["FilterValueStringType"],
    },
  ],
  sort_order: "asc", # accepts asc, desc
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Array<Types::Filter>

Lists the secret request filters.

Returns:

#max_results ⇒ Integer

(Optional) Limits the number of results you want to include in the response. If you don\'t include this parameter, it defaults to a value that\'s specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn\'t null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

  • (Integer) —

    (Optional) Limits the number of results you want to include in the response.

#next_token ⇒ String

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there\'s more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Returns:

  • (String) —

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there\'s more output available.

#sort_order ⇒ String

Lists secrets in the requested order.

Possible values:

  • asc
  • desc

Returns:

  • (String) —

    Lists secrets in the requested order.