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

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.

Returns:

  • (Boolean)

1095
1096
1097
1098
1099
1100
1101
1102
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1095

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)

1095
1096
1097
1098
1099
1100
1101
1102
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1095

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)

1095
1096
1097
1098
1099
1100
1101
1102
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1095

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].

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

Returns:

  • (String)

1095
1096
1097
1098
1099
1100
1101
1102
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1095

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