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

Inherits:

Struct

• Object
• Struct
• Aws::SecretsManager::Types::ListSecretsRequest

Defined in:

gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::Filter>

  The filters to apply to the list of secrets.

• #include_planned_deletion ⇒ Boolean

  Specifies whether to include secrets scheduled for deletion.

• #max_results ⇒ Integer

  The number of results to include in the response.

• #next_token ⇒ String

  A token that indicates where the output should continue from, if a previous call did not show all results.

• #sort_order ⇒ String

  Secrets are listed by CreatedDate.

Instance Attribute Details

#filters ⇒ Array<Types::Filter>

The filters to apply to the list of secrets.

Returns:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1154

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

#include_planned_deletion ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1154

class ListSecretsRequest < Struct.new(
  :include_planned_deletion,
  :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)

# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1154

class ListSecretsRequest < Struct.new(
  :include_planned_deletion,
  :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)

# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1154

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

#sort_order ⇒ String

Secrets are listed by CreatedDate.

Returns:

• (String)

# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1154

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