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>

Lists the secret request filters.

Returns:



1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1182

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

#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) 


1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1182

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

#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) 


1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1182

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) 


1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1182

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