Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

","ParameterFilters",{"_6951":6967},[6968,6970],{"_6954":6969},"#/definitions/397566",{"_23":6971},"

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

","WithDecryption",{"_6951":6974},[6975,6976],{"_6954":6962},{"_23":6977},"Retrieve all parameters in a hierarchy with their value decrypted.",{"_6951":6979},[6980,6982],{"_6954":6981},"#/definitions/397672",{"_23":6983},"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.",{"_6951":6985},[6986,6988],{"_6954":6987},"#/definitions/397534",{"_23":6989},"A token to start the list. Use this token to get the next set of results. ","x--orders",[6947,6958,6965,6972,4333,4338],"definitions",{"_6994":6995,"_6996":6997,"_6999":7000,"_7006":7007,"_7008":7009,"_7014":7015,"_7020":7021,"_7022":7023,"_7029":7030,"_7034":7035,"_7061":7062},"397100",{"_5":6944,"_6945":6946,"_30":2108,"_6948":6949,"_6990":6991,"_22":2108},"397270",{"_5":6998,"_30":2988,"_22":2988},"boolean","397519",{"_5":7001,"_7002":7003,"_7004":7005,"_30":4283,"_22":4283},"string","minLength",1,"maxLength",2048,"397534",{"_5":7001,"_30":4338,"_22":4338},"397566",{"_5":7010,"_7011":7012,"_30":4553,"_22":4553},"array","items",{"_6954":7013},"#/definitions/397882","397672",{"_5":7016,"_7017":7003,"_7018":7019,"_30":5083,"_22":5083},"integer","minimum","maximum",10,"397878",{"_5":7001,"_7002":7003,"_7004":7019,"_30":6158,"_22":6158},"397880",{"_5":7010,"_7011":7024,"_7026":7003,"_7027":7028,"_30":6163,"_22":6163},{"_6954":7025},"#/definitions/397883","minItems","maxItems",50,"397881",{"_5":7001,"_7031":7032,"_7002":7003,"_7004":7033,"_30":6153,"_22":6153},"pattern","tag:.+|Name|Type|KeyId|Path|Label|Tier|DataType",132,"397882",{"_5":6944,"_6945":7036,"_6948":7038,"_23":7059,"_6990":7060,"_30":6168,"_22":6168},[7037],"Key",{"_7037":7039,"_7045":7046,"_7052":7053},{"_6951":7040},[7041,7043],{"_6954":7042},"#/definitions/397881",{"_23":7044},"

The name of the filter.

The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for Key can be used with both operations.

For DescribeParameters, all of the listed patterns are valid except Label.

For GetParametersByPath, the following patterns listed for Key aren't valid: tag, DataType, Name, Path, and Tier.

For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

","Option",{"_6951":7047},[7048,7050],{"_6954":7049},"#/definitions/397878",{"_23":7051},"

For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using Label as the Key name, the only valid option is Equals.)

","Values",{"_6951":7054},[7055,7057],{"_6954":7056},"#/definitions/397880",{"_23":7058},"The value you want to search for.","One or more filters. Use a filter to return a more specific list of results.",[7037,7045,7052],"397883",{"_5":7001,"_7002":7003,"_7004":7063,"_30":6173,"_22":6173},1024,"extraData",{"_7066":7067,"_7068":6993,"_7069":7070,"_23":115,"_7071":2108},"apiFieldList",[],"dataSchemaDefinitions","example","{\n \"Path\": \"string\",\n \"Recursive\": true,\n \"ParameterFilters\": [],\n \"WithDecryption\": true,\n \"MaxResults\": 0,\n \"NextToken\": \"string\"\n}","displayName","docsIdTypeData",{"_7074":7075,"_7076":7077,"_7078":7077,"_7079":7080,"_7081":7082,"_7083":7084,"_7085":115,"_7086":-7},"onlineType","APIDOC","onlineId",345650,"projectId","teamId",97,"branchId",308784,"visitType","customDomain","subdirectory","specialFileType","notification",[],"footerBanner",[],"projectSetting",{"_7093":7094,"_7095":7096,"_7111":7112,"_7113":7114,"_7115":7116,"_7117":7118},"auth",{},"advancedSettings",{"_7097":154,"_7098":154,"_7099":51,"_7100":7101,"_7102":154,"_7103":154,"_7104":7105},"enableJsonc","enableBigint","responseValidate","isDefaultUrlEncoding",3,"enableTestScenarioSetting","enableYAPICompatScript","publishedDocUrlRules",{"_7106":7107,"_7108":7109,"_7110":51},"defaultRule","RESOURCE_KEY_ONLY","resourceKeyStandard","LEGACY","enableResourceKeyStandard","securityScheme",{},"mockSettings",{},"preProcessors",[],"postProcessors",[],"environments",{"_7121":7122,"_7164":7165,"_7225":7226},"selectedEnvironment",{"_172":7123,"_22":7124,"_7125":7126,"_7127":7128,"_7130":7131,"_7132":7133,"_7134":7135,"_7136":7137,"_7138":7139,"_7148":7149,"_5":7150,"_7151":7152,"_7078":7077,"_7153":7154,"_7155":7156,"_7157":182,"_184":7158,"_7159":7156,"_7160":7161,"_7162":7163},356112,"The Amazon SSM multi-region endpoint","baseUrl","http://ssm.{region}.amazonaws.com","baseUrls",{"_7129":7126},"default","websocketBaseUrls",{},"socketioBaseUrls",{},"requestProxyAgentSettings",{},"variables",[],"parameters",{"_7140":7141,"_7142":7143,"_7144":7145,"_7146":7147},"cookie",[],"query",[],"header",[],"body",[],"registrationCenters",[],"normal","visibility","protected","projectType","HTTP","creatorId",345038,"ordering",[],"editorId","createdAt","2022-09-10T18:21:21.000Z","updatedAt","2022-09-13T02:21:27.000Z","environmentList",[7166,7179,7194,7210],{"_172":7123,"_22":7124,"_7125":7126,"_7127":7167,"_7130":7168,"_7132":7169,"_7134":7170,"_7136":7171,"_7138":7172,"_7148":7177,"_5":7150,"_7151":7152,"_7078":7077,"_7153":7154,"_7155":7156,"_7157":182,"_184":7178,"_7159":7156,"_7160":7161,"_7162":7163},{"_7129":7126},{},{},{},[],{"_7140":7173,"_7142":7174,"_7144":7175,"_7146":7176},[],[],[],[],[],[],{"_172":7180,"_22":7124,"_7125":7181,"_7127":7182,"_7130":7183,"_7132":7184,"_7134":7185,"_7136":7186,"_7138":7187,"_7148":7192,"_5":7150,"_7151":7152,"_7078":7077,"_7153":7154,"_7155":7156,"_7157":182,"_184":7193,"_7159":7156,"_7160":7161,"_7162":7163},356113,"https://ssm.{region}.amazonaws.com",{"_7129":7181},{},{},{},[],{"_7140":7188,"_7142":7189,"_7144":7190,"_7146":7191},[],[],[],[],[],[],{"_172":7195,"_22":7196,"_7125":7197,"_7127":7198,"_7130":7199,"_7132":7200,"_7134":7201,"_7136":7202,"_7138":7203,"_7148":7208,"_5":7150,"_7151":7152,"_7078":7077,"_7153":7154,"_7155":7156,"_7157":182,"_184":7209,"_7159":7156,"_7160":7161,"_7162":7163},356114,"The Amazon SSM endpoint for China (Beijing) and China (Ningxia)","http://ssm.{region}.amazonaws.com.cn",{"_7129":7197},{},{},{},[],{"_7140":7204,"_7142":7205,"_7144":7206,"_7146":7207},[],[],[],[],[],[],{"_172":7211,"_22":7196,"_7125":7212,"_7127":7213,"_7130":7214,"_7132":7215,"_7134":7216,"_7136":7217,"_7138":7218,"_7148":7223,"_5":7150,"_7151":7152,"_7078":7077,"_7153":7154,"_7155":7156,"_7157":182,"_184":7224,"_7159":7156,"_7160":7161,"_7162":7163},356115,"https://ssm.{region}.amazonaws.com.cn",{"_7129":7212},{},{},{},[],{"_7140":7219,"_7142":7220,"_7144":7221,"_7146":7222},[],[],[],[],[],[],"servers",[7227],{"_172":7129,"_22":7228},"Default Server","searchSettings",{},"versionSettings",[7233],{"_7081":7082,"_7234":51,"_22":6938,"_7235":6938,"_7119":7236},"isDefaultVersion","slug",{"_7237":7238,"_7239":7123},"environmentIds",[7123,7180,7195,7211],"defaultEnvironmentId","seoInfos",["M"],"itemPathPrefix",{"_7125":115,"_7244":115,"_7085":115,"_7245":154},"versionSlug","isSharedDocIndependentDomain","appEnvMap",{"_7248":127},"appBrowserExtensionAdapterKey","customCodes",{"_7251":115},"javascript","primaryColorVariable",{"_6846":7254,"_6850":7255},"--ui-primary-color-hover: var(--ui-primary-5);--ui-primary-color-active: var(--ui-primary-7);--ui-picker-basic-cell-hover-with-range-color: #36139c;--ui-picker-date-hover-range-border-color: #4e1be0;--ui-primary-base: #9373EE;--ui-primary-base-p: 147, 115, 238;--ui-primary-color-p: 147, 115, 238;--ui-primary-color: #9373EE;--ui-primary-10: #362b50;--ui-primary-9: #51407e;--ui-primary-8: #634e9b;--ui-primary-7: #7a60c4;--ui-primary-7-p: 122, 96, 196;--ui-primary-6: #9373EE;--ui-primary-6-p: 147, 115, 238;--ui-primary-5: #b499f4;--ui-primary-5-p: 180, 153, 244;--ui-primary-4: #cebaf8;--ui-primary-3: #dfd1fb;--ui-primary-2: #ebe2fc;--ui-primary-1: #f3eefe;--ui-primary-1-p: 243, 238, 254;--ui-primary-a: #f7f3fe;--ui-primary-b: #fbf9ff;--g-color-primary: #9373EE;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #ffffff;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","--ui-primary-color-hover: var(--ui-primary-7);--ui-primary-color-active: var(--ui-primary-5);--ui-picker-basic-cell-hover-with-range-color: #312865;--ui-picker-date-hover-range-border-color: #4b3d9c;--ui-primary-base: #8276C9;--ui-primary-base-p: 130, 118, 201;--ui-primary-color-p: 130, 118, 201;--ui-primary-color: #8276C9;--ui-primary-10: #dcd7f0;--ui-primary-9: #a69bd9;--ui-primary-8: #b0a5dd;--ui-primary-7: #9c90d4;--ui-primary-7-p: 156, 144, 212;--ui-primary-6: #8276C9;--ui-primary-6-p: 130, 118, 201;--ui-primary-5: #635a96;--ui-primary-5-p: 99, 90, 150;--ui-primary-4: #49436c;--ui-primary-3: #393452;--ui-primary-2: #312d46;--ui-primary-1: #252333;--ui-primary-1-p: 37, 35, 51;--ui-primary-a: #21202d;--ui-primary-b: #1e1c28;--g-color-primary: #8276C9;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #1a1922;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","routes/_index/route","actionData","errors"]

GetParametersByPathRequest(GetParametersByPathRequest)