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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#include_deprecatedBoolean

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)


1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1085

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

Returns:

  • (Integer)


1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1085

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

Returns:

  • (String)


1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1085

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

#secret_idString

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.

Returns:

  • (String)


1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1085

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