/AWS1/CL_SMRGETSECRETVALUERSP¶
GetSecretValueResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_arn TYPE /AWS1/SMRSECRETARNTYPE /AWS1/SMRSECRETARNTYPE¶
The ARN of the secret.
iv_name TYPE /AWS1/SMRSECRETNAMETYPE /AWS1/SMRSECRETNAMETYPE¶
The friendly name of the secret.
iv_versionid TYPE /AWS1/SMRSECRETVERSIONIDTYPE /AWS1/SMRSECRETVERSIONIDTYPE¶
The unique identifier of this version of the secret.
iv_secretbinary TYPE /AWS1/SMRSECRETBINARYTYPE /AWS1/SMRSECRETBINARYTYPE¶
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a
SecretBinaryusing the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in
SecretStringinstead.Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
iv_secretstring TYPE /AWS1/SMRSECRETSTRINGTYPE /AWS1/SMRSECRETSTRINGTYPE¶
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
it_versionstages TYPE /AWS1/CL_SMRSECRETVRSSTAGEST00=>TT_SECRETVERSIONSTAGESTYPE TT_SECRETVERSIONSTAGESTYPE¶
A list of all of the staging labels currently attached to this version of the secret.
iv_createddate TYPE /AWS1/SMRCREATEDDATETYPE /AWS1/SMRCREATEDDATETYPE¶
The date and time that this version of the secret was created. If you don't specify which version in
VersionIdorVersionStage, then Secrets Manager uses theAWSCURRENTversion.
Queryable Attributes¶
ARN¶
The ARN of the secret.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
Name¶
The friendly name of the secret.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
VersionId¶
The unique identifier of this version of the secret.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSIONID() |
Getter for VERSIONID, with configurable default |
ASK_VERSIONID() |
Getter for VERSIONID w/ exceptions if field has no value |
HAS_VERSIONID() |
Determine if VERSIONID has a value |
SecretBinary¶
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a
SecretBinaryusing the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in
SecretStringinstead.Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECRETBINARY() |
Getter for SECRETBINARY, with configurable default |
ASK_SECRETBINARY() |
Getter for SECRETBINARY w/ exceptions if field has no value |
HAS_SECRETBINARY() |
Determine if SECRETBINARY has a value |
SecretString¶
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECRETSTRING() |
Getter for SECRETSTRING, with configurable default |
ASK_SECRETSTRING() |
Getter for SECRETSTRING w/ exceptions if field has no value |
HAS_SECRETSTRING() |
Determine if SECRETSTRING has a value |
VersionStages¶
A list of all of the staging labels currently attached to this version of the secret.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSIONSTAGES() |
Getter for VERSIONSTAGES, with configurable default |
ASK_VERSIONSTAGES() |
Getter for VERSIONSTAGES w/ exceptions if field has no value |
HAS_VERSIONSTAGES() |
Determine if VERSIONSTAGES has a value |
CreatedDate¶
The date and time that this version of the secret was created. If you don't specify which version in
VersionIdorVersionStage, then Secrets Manager uses theAWSCURRENTversion.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDDATE() |
Getter for CREATEDDATE, with configurable default |
ASK_CREATEDDATE() |
Getter for CREATEDDATE w/ exceptions if field has no value |
HAS_CREATEDDATE() |
Determine if CREATEDDATE has a value |