AmazonSecrets Class

Properties   Methods   Events   Config Settings   Errors  

The AmazonSecrets class provides an easy-to-use interface for Amazon's Secrets Manager service.

Syntax

class cloudkeys.AmazonSecrets

Remarks

The AmazonSecrets class makes it easy to work with the Amazon Secrets Manager service in a secure manner using TLS. Amazon Secrets Manager allows you to securely store secrets (e.g., passwords, symmetric keys, etc.) in the cloud so that the aren't persisted locally. This class helps you to create, manage, and access those secrets.

To begin, register for an AWS account and obtain an access_key and secret_key to use for authentication.

Resource Terminology

A secret in Amazon Secrets Manager is a container for one or more secret versions, which is where secret data is actually stored. Each secret version can have between zero and 20 staging labels attached to it at any given time.

A staging label is a simple string that can be used instead of a version Id to refer to a particular secret version when retrieving secret data. A staging label can only be attached to one version of a secret at any given time. The server ensures that there is always exactly one version of a secret with the special staging label AWSCURRENT, but otherwise you are free to apply any staging labels to any secret versions you choose.

Secret versions that do not have any staging labels attached to them are considered deprecated, and the server may delete them at any time without warning. Deprecated secret versions are not shown in a secret's version list unless explicitly asked for.

Using the Class

The create_secret method will create a new secret with an initial secret version that holds the specified secret data. To change a secret's data, create a new version of it using the create_version method.

To retrieve a secret's data, call the get_secret method, and specify the specific version (either by Id or using a staging label) whose data should be retrieved. If no particular version is specified, the version with the AWSCURRENT staging label is used.

Secrets that will no longer be used can be deleted using the delete_secret method, either immediately or after a waiting period. If a secret is scheduled for deletion later, then during said waiting period the deletion can be canceled using cancel_deletion. // Creates a new secret with the textual data "Test123" named MySecret. // The initial secret version will have only the "AWSCURRENT" staging label. amazonsecrets.SecretString = "Test123"; amazonsecrets.CreateSecret("MySecret", "A description of my secret."); // Creates a new secret version with the textual data "Cats456" and // attaches the staging labels "AWSCURRENT" (which gets moved from the previous version) // and "best-version" to it. amazonsecrets.SecretString = "Cats456"; amazonsecrets.CreateVersion("MySecret", "AWSCURRENT,best-version"); // Downloads the latest secret version's data to a local file. amazonsecrets.LocalFile = "C:\temp\secret.txt"; amazonsecrets.GetSecret("MySecret", "", ""); // Schedules the secret, and all its versions, for deletion after 10 days. amazonsecrets.DeleteSecret("MySecret", 10); // Cancels the scheduled deletion. amazonsecrets.CancelDeletion("MySecret");

To list secrets, use the list_secrets method. To list a secret's versions, use the list_versions method. // If there are many secrets to list, there may be multiple pages of results. This will // cause all pages of results to be accumulated into the Secrets collection property. do { amazonsecrets.ListSecrets(); } while (!string.IsNullOrEmpty(amazonsecrets.SecretMarker)); // A similar thing applies to secret versions as well. do { amazonsecrets.ListVersions("MySecret"); } while (!string.IsNullOrEmpty(amazonsecrets.VersionMarker));

The class also supports other functionality, including:

• Adding, removing, and moving staging labels between secret versions using move_staging_label.
• Retrieval of information for a single secret with get_secret_info.
• Random password generation using gen_random_password.
• And more!

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

access_key Property

The access key to use for authentication.

Syntax

def get_access_key() -> str: ...
def set_access_key(value: str) -> None: ...

access_key = property(get_access_key, set_access_key)

Default Value

""

Remarks

This property specifies the access key that should be used for authentication. Both this property and secret_key must be set before attempting any operations which connect to the server.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

local_file Property

The local file to write data to, or whose data should be sent.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property specifies the location of a local file on disk. This is used as the source file when calling create_secret or create_version, and as the destination file when calling get_secret.

When creating a secret, the class assumes that data specified via a local file is binary in nature; the PreferBinary configuration setting can be used to control this behavior, refer to its documentation for more information.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

other_headers Property

This property includes other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

overwrite Property

Whether the local file should be overwritten if necessary.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property controls whether the specified local_file should be overwritten if it already exists.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

This property contains a user name, if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

query_param_count Property

The number of records in the QueryParam arrays.

Syntax

def get_query_param_count() -> int: ...
def set_query_param_count(value: int) -> None: ...

query_param_count = property(get_query_param_count, set_query_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• query_param_name
• query_param_value

The array indices start at 0 and end at query_param_count - 1.

query_param_name Property

The name of the query parameter.

Syntax

def get_query_param_name(query_param_index: int) -> str: ...
def set_query_param_name(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

query_param_value Property

The value of the query parameter.

Syntax

def get_query_param_value(query_param_index: int) -> str: ...
def set_query_param_value(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

region Property

The region that the class will make requests against.

Syntax

def get_region() -> str: ...
def set_region(value: str) -> None: ...

region = property(get_region, set_region)

Default Value

"us-east-1"

Remarks

This property controls which region the class will make requests against. By default the class uses us-east-1, the US East (N. Virginia) region. This property should be changed in order to create or access resources in other regions, as secrets are region-specific resources.

Regions:

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.

secret_data Property

The binary secret data that was retrieved or that should be sent.

Syntax

def get_secret_data() -> bytes: ...
def set_secret_data(value: bytes) -> None: ...

secret_data = property(get_secret_data, set_secret_data)

Remarks

Either this property or the secret_string property is populated with secret data after calling get_secret, depending on whether the secret data is binary or textual, so long as local_file is not set.

This property (or the secret_string property) can also be set before calling create_secret or create_version; its data will be sent if local_file is not set.

This property and secret_string are mutually exclusive; setting one will clear the other.

secret_key Property

The secret key to use for authentication.

Syntax

def get_secret_key() -> str: ...
def set_secret_key(value: str) -> None: ...

secret_key = property(get_secret_key, set_secret_key)

Default Value

""

Remarks

This property specifies the secret key that should be used for authentication. Both this property and access_key must be set before attempting any operations which connect to the server.

secret_marker Property

A marker indicating what page of secrets to return next.

Syntax

def get_secret_marker() -> str: ...
def set_secret_marker(value: str) -> None: ...

secret_marker = property(get_secret_marker, set_secret_marker)

Default Value

""

Remarks

This property will be populated when list_secrets is called if the results are paged and there are more pages. To list all secrets, continue to call list_secrets until this property returns empty string.

Refer to list_secrets for more information.

secret_count Property

The number of records in the Secret arrays.

Syntax

def get_secret_count() -> int: ...

secret_count = property(get_secret_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• secret_arn
• secret_creation_date
• secret_deletion_date
• secret_description
• secret_kms_key_id
• secret_last_access_date
• secret_last_change_date
• secret_name
• secret_owning_service

The array indices start at 0 and end at secret_count - 1.

This property is read-only.

secret_arn Property

The Amazon resource name (ARN) of the secret.

Syntax

def get_secret_arn(secret_index: int) -> str: ...

Default Value

""

Remarks

The Amazon resource name (ARN) of the secret.

This property reflects the Amazon resource name (ARN) of the secret.

The secret_index parameter specifies the index of the item in the array. The size of the array is controlled by the secret_count property.

This property is read-only.

secret_creation_date Property

The creation date of the secret.

Syntax

def get_secret_creation_date(secret_index: int) -> str: ...

Default Value

""

Remarks

The creation date of the secret.

This property reflects the creation date of the secret, in seconds since the Unix epoch (including fractional seconds).

The secret_index parameter specifies the index of the item in the array. The size of the array is controlled by the secret_count property.

This property is read-only.

secret_deletion_date Property

The deletion date of the secret.

Syntax

def get_secret_deletion_date(secret_index: int) -> str: ...

Default Value

""

Remarks

The deletion date of the secret.

This property reflects the deletion date of the secret, in seconds since the Unix epoch (including fractional seconds).

The secret_index parameter specifies the index of the item in the array. The size of the array is controlled by the secret_count property.

This property is read-only.

secret_description Property

The secret's description.

Syntax

def get_secret_description(secret_index: int) -> str: ...

Default Value

""

Remarks

The secret's description.

This property reflects the secret's description.

The secret_index parameter specifies the index of the item in the array. The size of the array is controlled by the secret_count property.

This property is read-only.

secret_kms_key_id Property

The ARN or alias of the Amazon KMS KMS key used to encrypt the secret.

Syntax

def get_secret_kms_key_id(secret_index: int) -> str: ...

Default Value

""

Remarks

The ARN or alias of the Amazon KMS KMS key used to encrypt the secret.

This property reflects the ARN or alias of the Amazon KMS key used to encrypt the secret.

The secret_index parameter specifies the index of the item in the array. The size of the array is controlled by the secret_count property.

This property is read-only.

secret_last_access_date Property

The last access date of the secret.

Syntax

def get_secret_last_access_date(secret_index: int) -> str: ...

Default Value

""

Remarks

The last access date of the secret.

This property reflects the last access date of the secret, in seconds since the Unix epoch.

Note that this property offers date-level resolution, time is not included.

The secret_index parameter specifies the index of the item in the array. The size of the array is controlled by the secret_count property.

This property is read-only.

secret_last_change_date Property

The last change date of the secret.

Syntax

def get_secret_last_change_date(secret_index: int) -> str: ...

Default Value

""

Remarks

The last change date of the secret.

This property reflects the last change date of the secret, in seconds since the Unix epoch (including fractional seconds).

The secret_index parameter specifies the index of the item in the array. The size of the array is controlled by the secret_count property.

This property is read-only.

secret_name Property

The name of the secret.

Syntax

def get_secret_name(secret_index: int) -> str: ...

Default Value

""

Remarks

The name of the secret.

This property reflects the name of the secret.

The secret_index parameter specifies the index of the item in the array. The size of the array is controlled by the secret_count property.

This property is read-only.

secret_owning_service Property

The name of the service that created the secret.

Syntax

def get_secret_owning_service(secret_index: int) -> str: ...

Default Value

""

Remarks

The name of the service that created the secret.

This property reflects the name of the AWS service that created the secret.

The secret_index parameter specifies the index of the item in the array. The size of the array is controlled by the secret_count property.

This property is read-only.

secret_string Property

The textual secret data that was retrieved or that should be sent.

Syntax

def get_secret_string() -> str: ...
def set_secret_string(value: str) -> None: ...

secret_string = property(get_secret_string, set_secret_string)

Default Value

""

Remarks

Either this property or the secret_data property is populated with secret data after calling get_secret, depending on whether the secret data is binary or textual, so long as local_file is not set.

This property (or the secret_data property) can also be set before calling create_secret or create_version; its data will be sent if local_file is not set.

This property and secret_data are mutually exclusive; setting one will clear the other.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

version_marker Property

A marker indicating what page of secret versions to return next.

Syntax

def get_version_marker() -> str: ...
def set_version_marker(value: str) -> None: ...

version_marker = property(get_version_marker, set_version_marker)

Default Value

""

Remarks

This property will be populated when list_versions is called if the results are paged and there are more pages. To list all secret versions, continue to call list_versions until this property returns empty string.

Refer to list_versions for more information.

version_count Property

The number of records in the Version arrays.

Syntax

def get_version_count() -> int: ...

version_count = property(get_version_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• version_creation_date
• version_last_access_date
• version_secret_arn
• version_secret_name
• version_staging_labels
• version_version_id

The array indices start at 0 and end at version_count - 1.

This property is read-only.

version_creation_date Property

The creation date of the secret version.

Syntax

def get_version_creation_date(version_index: int) -> str: ...

Default Value

""

Remarks

The creation date of the secret version.

This property reflects the creation date of the secret version, in seconds since the Unix epoch (including fractional seconds).

The version_index parameter specifies the index of the item in the array. The size of the array is controlled by the version_count property.

This property is read-only.

version_last_access_date Property

The last access date of the secret version.

Syntax

def get_version_last_access_date(version_index: int) -> str: ...

Default Value

""

Remarks

The last access date of the secret version.

This property reflects the last access date of the secret version, in seconds since the Unix epoch.

Note that this property offers date-level resolution, time is not included.

The version_index parameter specifies the index of the item in the array. The size of the array is controlled by the version_count property.

This property is read-only.

version_secret_arn Property

The Amazon resource name (ARN) of the secret this is a version of.

Syntax

def get_version_secret_arn(version_index: int) -> str: ...

Default Value

""

Remarks

The Amazon resource name (ARN) of the secret this is a version of.

This property reflects the Amazon resource name (ARN) of the secret that this is a version of.

The version_index parameter specifies the index of the item in the array. The size of the array is controlled by the version_count property.

This property is read-only.

version_secret_name Property

The name of the secret that this is a version of.

Syntax

def get_version_secret_name(version_index: int) -> str: ...

Default Value

""

Remarks

The name of the secret that this is a version of.

This property reflects the name of the secret that this is a version of.

The version_index parameter specifies the index of the item in the array. The size of the array is controlled by the version_count property.

This property is read-only.

version_staging_labels Property

The staging labels attached to the secret version.

Syntax

def get_version_staging_labels(version_index: int) -> str: ...

Default Value

""

Remarks

The staging labels attached to the secret version.

This property reflects a comma-separated list of staging labels attached to the secret version.

Each secret version can have up to 20 staging labels attached to it at once, and a particular staging label can only be attached to one secret version at any given time.

The version_index parameter specifies the index of the item in the array. The size of the array is controlled by the version_count property.

This property is read-only.

version_version_id Property

The Id of the secret version.

Syntax

def get_version_version_id(version_index: int) -> str: ...

Default Value

""

Remarks

The Id of the secret version.

This property reflects the Id of the secret version.

The version_index parameter specifies the index of the item in the array. The size of the array is controlled by the version_count property.

This property is read-only.

add_query_param Method

Adds a query parameter to the QueryParams properties.

Syntax

def add_query_param(name: str, value: str) -> None: ...

Remarks

This method is used to add a query parameter to the QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

cancel_deletion Method

Cancels the deletion of a secret.

Syntax

def cancel_deletion(secret_id: str) -> None: ...

Remarks

This method cancels the deletion of the secret specified by SecretId. Refer to the delete_secret method's documentation for more information.

The value passed for SecretId must the ARN or name of a secret in the current account and region.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_secret Method

Creates a new secret.

Syntax

def create_secret(secret_name: str, description: str) -> str: ...

Remarks

This method creates a new secret with the given SecretName. The secret data is taken from the specified local_file or the secret_data or secret_string property; it may be up to 65536 bytes in length. The Id of the initial secret version is returned.

The value passed for SecretName may be up to 512 characters long, and must consist solely of ASCII letters, digits, and the following characters: /_+=.@-.

The Description parameter is optional; it can be any string up to 2048 characters long.

If desired, the KMSKeyId configuration setting can be set before calling this method to specify the Amazon KMS CMK (customer master key) to use to encrypt the secret (by default, an AWS-managed one is used).

create_version Method

Creates a new secret version.

Syntax

def create_version(secret_id: str, staging_labels: str) -> str: ...

Remarks

This method creates a new version of the secret specified by SecretId. The secret data is taken from the specified local_file or the secret_data or secret_string property; it may be up to 65536 bytes in length. The Id of the newly-created secret version is returned.

The value passed for SecretId must the ARN or name of a secret in the current account and region.

The value passed for StagingLabels must be a comma-separated list of staging labels to attach to the new version; up to 20 staging labels can be attached to a secret version. If empty string is passed, AWSCURRENT is assumed. The server may do the following things depending on which staging labels are specified:

• If any of the specified staging labels are currently attached to other versions of this secret, they are moved from those versions to the new one.
• If the AWSCURRENT staging label is attached to the new version, the server will automatically move the AWSPREVIOUS staging label to the version that AWSCURRENT was previously attached to.

delete_secret Method

Deletes a secret and all of its versions.

Syntax

def delete_secret(secret_id: str, days_to_wait: int) -> None: ...

Remarks

This method deletes the secret specified by SecretId, and all of its versions, either immediately or after a waiting period depending on the value passed for DaysToWait.

The value passed for SecretId must the ARN or name of a secret in the current account and region.

If 0 is passed for DaysToWait, the secret is deleted immediately. Otherwise, DaysToWait must be a value in the range 7 to 30 (inclusive), which will cause the secret to be scheduled for deletion. During the waiting period:

• The secret's data cannot be retrieved from any secret version.
• The deletion can be canceled by calling the cancel_deletion method.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

gen_random_password Method

Returns a server-generated random password that complies with the given criteria.

Syntax

def gen_random_password(length: int, lowercase: bool, uppercase: bool, numbers: bool, punctuation: bool, spaces: bool, exclude_chars: str, require_each: bool) -> str: ...

Remarks

This method requests and returns a random password generated by the server based on a number of criteria.

The Length parameter specifies how long the password must be; it must be a value in the range 1 to 4096 (inclusive).

The Lowercase, Uppercase, Numbers, Punctuation, and Spaces parameters specify whether the server is allowed to include characters of each type. The Lowercase and Uppercase types cover ASCII characters only. For Punctuation, the applicable characters are: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

The ExcludeChars parameters specifies a list of characters that must not be included in the password. For example, passing &" - would exclude ampersands, double quotes, spaces, and hyphens.

The RequireEach parameter specifies whether the server must include at least one of each allowed character type in the password.

get_secret Method

Retrieves a secret version's data.

Syntax

def get_secret(secret_id: str, version_id: str, staging_label: str) -> None: ...

Remarks

This method retrieves the secret data held by a version of the secret specified by SecretId. The exact version whose data should be retrieved is specified by either VersionId or StagingLabel (if both are specified, the latter is ignored). If neither are specified, the data from the secret version with the AWSCURRENT staging label is retrieved.

The value passed for SecretId must the ARN or name of a secret in the current account and region.

The secret data is returned via the specified local_file or the secret_data or secret_string property.

get_secret_info Method

Gets information about a secret.

Syntax

def get_secret_info(secret_id: str) -> None: ...

Remarks

This method gets information about the secret specified by SecretId.

When the information is returned, the class clears the Secret* properties and repopulates them with a single item that contains the secret's information, and also repopulates the Version* properties (however, not all properties are populated). The on_secret_list and on_version_list events are also fired.

list_secrets Method

Lists secrets in the current account and region.

Syntax

def list_secrets() -> None: ...

Remarks

This method lists the secrets in the current account and region. Note that, by default, secrets that have been scheduled for deletion are not included in the results; the IncludeDeleted configuration setting can be used to control this behavior.

Calling this method will fire the on_secret_list event once for each secret, and will also populate the Secret* properties. If the AlwaysParseVersions configuration setting is enabled, each secret's basic version information will also be parsed and used to populate the Version* properties and fire the on_version_list event.

If there are still more secrets available to list when this method returns, the secret_marker property will be populated. Continue to call this method until secret_marker is empty to accumulate all pages of results in the Secret* properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.

list_versions Method

List the secret versions for the specified secret.

Syntax

def list_versions(secret_id: str) -> None: ...

Remarks

This method lists the secret versions for the secret specified by SecretId. Note that by default, only non-deprecated versions are returned (i.e., those with at least one staging label attached to them); the IncludeDeprecated configuration setting can be used to control this behavior.

Calling this method will fire the on_version_list event once for each secret version, and will also populate the Version* properties.

If there are still more secret versions available to list when this method returns, the version_marker property will be populated. Continue to call this method until version_marker is empty to accumulate all pages of results in the Version* properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.

move_staging_label Method

Adds, removes, or moves a staging label.

Syntax

def move_staging_label(secret_id: str, staging_label: str, from_version_id: str, to_version_id: str) -> None: ...

Remarks

This method adds, removes, or moves a staging label between versions of the secret specified by SecretId.

The value passed for SecretId must the ARN or name of a secret in the current account and region.

The StagingLabel parameter specifies the staging label that should be added, removed, or moved. If the staging label is AWSCURRENT, it cannot be removed, only moved, and the server will automatically move the AWSPREVIOUS staging label to the secret version specified by FromVersionId.

The FromVersionId and ToVersionId parameters specify which version(s) to operate against. When adding a new staging label to a secret version, only ToVersionId must be specified. When removing a staging label from a version, only FromVersionId must be specified. When moving an existing staging label from one version to another, both FromVersionId and ToVersionId must be specified.

reset Method

Resets the class to its initial state.

Syntax

def reset() -> None: ...

Remarks

This method resets the class to its initial state.

send_custom_request Method

Sends a custom request to the server.

Syntax

def send_custom_request(action: str, body: str) -> None: ...

Remarks

This method can be used to send arbitrary requests to the server. The value passed for the Action parameter must be one of the actions described in the Amazon Secrets Manager documentation.

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, based on the following:
   • region
   • QueryParam*
2. Adds request headers from other_headers.
3. Adds the specified request Body, if non-empty.
4. Signs the request.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeader* properties; and the response body in the specified local_file or secret_data.

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

update_secret Method

Updates a secret's information.

Syntax

def update_secret(secret_id: str, description: str) -> None: ...

Remarks

This method updates the information of the secret specified by SecretId.

The value passed for SecretId must the ARN or name of a secret in the current account and region.

The Description parameter specifies the secret's new description (which may be empty).

The KMSKeyId configuration setting can also be set before calling this method to change the AWS KMS key used to encrypt the secret. However, if the KMS key used to encrypt a secret is changed, it is important that the secret's data be updated at least once using create_version. When a new version is created, the server decrypts the secret using the old KMS key and re-encrypts it using the new one. If the old KMS key is deleted or disabled before this occurs, the server will no longer be able to decrypt the secret, effectively causing its data to be lost.

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

class AmazonSecretsEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class AmazonSecrets:
@property
def on_end_transfer() -> Callable[[AmazonSecretsEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[AmazonSecretsEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error Event

Information about errors during data delivery.

Syntax

class AmazonSecretsErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class AmazonSecrets:
@property
def on_error() -> Callable[[AmazonSecretsErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AmazonSecretsErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_header Event

This event is fired every time a header line comes in.

Syntax

class AmazonSecretsHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class AmazonSecrets:
@property
def on_header() -> Callable[[AmazonSecretsHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[AmazonSecretsHeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log Event

This event fires once for each log message.

Syntax

class AmazonSecretsLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class AmazonSecrets:
@property
def on_log() -> Callable[[AmazonSecretsLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[AmazonSecretsLogEventParams], None]) -> None: ...

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_secret_list Event

Fires once for each secret when listing secrets.

Syntax

class AmazonSecretsSecretListEventParams(object):
  @property
  def arn() -> str: ...

  @property
  def name() -> str: ...

  @property
  def description() -> str: ...

  @property
  def creation_date() -> str: ...

  @property
  def deletion_date() -> str: ...

  @property
  def last_access_date() -> str: ...

  @property
  def last_change_date() -> str: ...

# In class AmazonSecrets:
@property
def on_secret_list() -> Callable[[AmazonSecretsSecretListEventParams], None]: ...
@on_secret_list.setter
def on_secret_list(event_hook: Callable[[AmazonSecretsSecretListEventParams], None]) -> None: ...

Remarks

This event fires once for each secret returned when list_secrets or get_secret_info is called.

ARN reflects the Amazon resource name of the secret.

Name reflects the name of the secret.

Description reflects the secret's description.

CreationDate reflects the secret's creation date, in seconds since the Unix epoch (including fractional seconds).

DeletionDate reflects the secret's scheduled deletion date, if applicable, in seconds since the Unix epoch (including fractional seconds).

LastAccessDate reflects the secret's last access date, in seconds since the Unix epoch. It provides date-level resolution only, the time is not included.

LastChangeDate reflects the secret's last change date, in seconds since the Unix epoch (including fractional seconds).

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class AmazonSecretsSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class AmazonSecrets:
@property
def on_ssl_server_authentication() -> Callable[[AmazonSecretsSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[AmazonSecretsSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class AmazonSecretsSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class AmazonSecrets:
@property
def on_ssl_status() -> Callable[[AmazonSecretsSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[AmazonSecretsSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer Event

This event fires when a document starts transferring (after the headers).

Syntax

class AmazonSecretsStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class AmazonSecrets:
@property
def on_start_transfer() -> Callable[[AmazonSecretsStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[AmazonSecretsStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_transfer Event

This event is fired while a document transfers (delivers document).

Syntax

class AmazonSecretsTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class AmazonSecrets:
@property
def on_transfer() -> Callable[[AmazonSecretsTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[AmazonSecretsTransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

on_version_list Event

Fires once for each secret version when listing secret versions.

Syntax

class AmazonSecretsVersionListEventParams(object):
  @property
  def secret_arn() -> str: ...

  @property
  def secret_name() -> str: ...

  @property
  def version_id() -> str: ...

  @property
  def staging_labels() -> str: ...

  @property
  def creation_date() -> str: ...

  @property
  def last_access_date() -> str: ...

# In class AmazonSecrets:
@property
def on_version_list() -> Callable[[AmazonSecretsVersionListEventParams], None]: ...
@on_version_list.setter
def on_version_list(event_hook: Callable[[AmazonSecretsVersionListEventParams], None]) -> None: ...

Remarks

This event fires once for each secret version returned when list_versions, get_secret_info, or (if the AlwaysParseVersions configuration setting is enabled) list_secrets is called. Note that CreationDate and LastAccessDate are only populated when list_versions is called.

SecretARN reflects the Amazon resource name of the secret this is a version of.

SecretName reflects the name of the secret this is a version of.

VersionId reflects the Id of the secret version.

StagingLabels reflects a comma-separated list of staging labels attached to the secret version.

CreationDate reflects the secret version's creation date, in seconds since the Unix epoch (including fractional seconds).

LastAccessDate reflects the secret version's last access date, in seconds since the Unix epoch. It provides date-level resolution only, the time is not included.

AmazonSecrets Config Settings

AmazonSecrets Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

AmazonSecrets Errors

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors