Class: Aws::SecretsManager::Types::BatchGetSecretValueRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Array<Types::Filter>

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

Returns:



69
70
71
72
73
74
75
76
 
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 69

class BatchGetSecretValueRequest < Struct.new(
  :secret_id_list,
  :filters,
  :max_results,
  :next_token)
  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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

Returns:

  • (Integer) 


69
70
71
72
73
74
75
76
 
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 69

class BatchGetSecretValueRequest < Struct.new(
  :secret_id_list,
  :filters,
  :max_results,
  :next_token)
  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 BatchGetSecretValue again with this value.

Returns:

  • (String) 


69
70
71
72
73
74
75
76
 
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 69

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

#secret_id_list ⇒ Array<String>

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

Returns:

  • (Array<String>) 


69
70
71
72
73
74
75
76
 
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 69

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