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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

The filters to apply to the list of secrets.

Returns:



1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1177

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

#include_planned_deletionBoolean

Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren’t included.

Returns:

  • (Boolean)


1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1177

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

#max_resultsInteger

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)


1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1177

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

#next_tokenString

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)


1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1177

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

#sort_orderString

Secrets are listed by ‘CreatedDate`.

Returns:

  • (String)


1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1177

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