get_parameter¶
- ParameterStoreApi.get_parameter(key, role_id, projection_expression=None, action=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Get a parameter including its decrypted value
Returns parameter metadata and the decrypted SSM value when the caller has access. Set action=get_dependent_resources to list Jobs, CodeRepositories, and Datalabs that reference the parameter instead.
- Parameters:
key (str) – Full stored ParameterKey, URL-decoded (for example /adp/amorphic/pstore/user/amp-db-host). (required)
role_id (str) – Amorphic role ID sent for authorization. Missing this header returns AUTH-1001. (required)
projection_expression (str) – Comma-separated attribute names to include after enrichment. When omitted, all returned fields are included. Example: ParameterKey,ParameterValue,Scope,AccessType.
action (str) – Set to get_dependent_resources to return Jobs, CodeRepositories, and Datalabs that reference this parameter instead of the parameter detail. Omit to return the decrypted parameter.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Return type:
- Returns:
Returns the result object.
Request and Response Examples¶
HTTP: GET /parameters/{key}
Success (HTTP 200)¶
Parameter details with decrypted ParameterValue, or dependent resources when action=get_dependent_resources.
Parameter with decrypted value
{
"ParameterKey": "/adp/amorphic/pstore/user/amp-db-host",
"DisplayName": "amp-db-host",
"ParameterValue": "analytics-db.example.com",
"ParameterType": "String",
"Description": "Analytics DB hostname",
"Scope": "user",
"Owner": "jdoe",
"CreatedBy": "jdoe",
"CreationTime": "2026-08-15 10:00:00",
"LastModifiedBy": "jdoe",
"LastModifiedTime": "2026-08-15 12:00:00",
"NewConvention": true,
"AccessType": "owner"
}
action=get_dependent_resources
{
"DependentResources": [
{
"ResourceType": "Jobs",
"Resources": [
{
"JobName": "sales_etl_daily",
"JobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
},
{
"ResourceType": "CodeRepositories",
"Resources": [
{
"RepositoryName": "feature-store-utils"
}
]
}
]
}
Errors¶
Documented error codes: IPV-1002, AUTH-1002, RTE-1001.
HTTP 400
Parameter not found or caller has no read access. Body is {“Message”: “<CODE> - <text>”}.
Parameter does not exist
{
"Message": "IPV-1002 - Invalid ParameterKey - /adp/amorphic/pstore/user/missing, resource not found."
}
Caller cannot read the parameter
{
"Message": "AUTH-1002 - User action is not permitted"
}
HTTP 500
Uncaught backend failure. Typical Message is “RTE-1001 - {exception}.”
Request / response example
{
"Message": "RTE-1001 - Could not complete the request. Please try again."
}