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

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

Overview

Note:

When making an API call, you may pass ListSecretVersionIdsRequest data as a hash:

{
  secret_id: "SecretIdType", # required
  max_results: 1,
  next_token: "NextTokenType",
  include_deprecated: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#include_deprecatedBoolean

(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.

Returns:

  • (Boolean)

1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1082

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

#max_resultsInteger

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

1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1082

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

#next_tokenString

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

Returns:

  • (String)

1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1082

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

#secret_idString

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Returns:

  • (String)

1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1082

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