Class: Aws::SecretsManager::Types::ListSecretVersionIdsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#include_deprecated ⇒ Boolean

Specifies whether to include versions of secrets that don’t have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager. By default, versions without staging labels aren’t included.

Returns:

  • (Boolean) 


1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1108

class ListSecretVersionIdsRequest < Struct.new(
  :secret_id,
  :max_results,
  :next_token,
  :include_deprecated)
  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 `ListSecretVersionIds` again with the value from `NextToken`.

Returns:

  • (Integer) 


1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1108

class ListSecretVersionIdsRequest < Struct.new(
  :secret_id,
  :max_results,
  :next_token,
  :include_deprecated)
  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 ‘ListSecretVersionIds` again with this value.

Returns:

  • (String) 


1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1108

class ListSecretVersionIdsRequest < Struct.new(
  :secret_id,
  :max_results,
  :next_token,
  :include_deprecated)
  SENSITIVE = []
  include Aws::Structure
end

#secret_id ⇒ String

The ARN or name of the secret whose versions you want to list.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See [Finding a secret from a partial ARN].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

Returns:

  • (String) 


1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1108

class ListSecretVersionIdsRequest < Struct.new(
  :secret_id,
  :max_results,
  :next_token,
  :include_deprecated)
  SENSITIVE = []
  include Aws::Structure
end