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

Inherits:

Struct

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

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",
}

Instance Attribute Summary collapse

#max_results ⇒ Integer

(Optional) Limits the number of results that 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 that indicates that there’s more output available.

Instance Attribute Details

#max_results ⇒ `Integer`

(Optional) Limits the number of results that 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)

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

class ListSecretsRequest < Struct.new(
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_token ⇒ `String`

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