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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-secretsmanager/types.rb

Overview

Note:

When making an API call, you may pass ListSecretsRequest data as a hash:

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Array<Types::Filter>

The filters to apply to the list of secrets.

Returns:



1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1154

class ListSecretsRequest < Struct.new(
  :max_results,
  :next_token,
  :filters,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes ‘NextToken`. To get the next results, call `ListSecrets` again with the value from `NextToken`.

Returns:

  • (Integer) 


1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1154

class ListSecretsRequest < Struct.new(
  :max_results,
  :next_token,
  :filters,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ‘ListSecrets` again with this value.

Returns:

  • (String) 


1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1154

class ListSecretsRequest < Struct.new(
  :max_results,
  :next_token,
  :filters,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

Lists secrets in the requested order.

Returns:

  • (String) 


1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1154

class ListSecretsRequest < Struct.new(
  :max_results,
  :next_token,
  :filters,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end