1{
2  "version":"2.0",
3  "metadata":{
4    "apiVersion":"2018-05-10",
5    "endpointPrefix":"license-manager-linux-subscriptions",
6    "jsonVersion":"1.1",
7    "protocol":"rest-json",
8    "serviceFullName":"AWS License Manager Linux Subscriptions",
9    "serviceId":"License Manager Linux Subscriptions",
10    "signatureVersion":"v4",
11    "signingName":"license-manager-linux-subscriptions",
12    "uid":"license-manager-linux-subscriptions-2018-05-10"
13  },
14  "operations":{
15    "GetServiceSettings":{
16      "name":"GetServiceSettings",
17      "http":{
18        "method":"POST",
19        "requestUri":"/subscription/GetServiceSettings",
20        "responseCode":200
21      },
22      "input":{"shape":"GetServiceSettingsRequest"},
23      "output":{"shape":"GetServiceSettingsResponse"},
24      "errors":[
25        {"shape":"InternalServerException"},
26        {"shape":"ThrottlingException"},
27        {"shape":"ValidationException"}
28      ],
29      "documentation":"<p>Lists the Linux subscriptions service settings.</p>",
30      "idempotent":true
31    },
32    "ListLinuxSubscriptionInstances":{
33      "name":"ListLinuxSubscriptionInstances",
34      "http":{
35        "method":"POST",
36        "requestUri":"/subscription/ListLinuxSubscriptionInstances",
37        "responseCode":200
38      },
39      "input":{"shape":"ListLinuxSubscriptionInstancesRequest"},
40      "output":{"shape":"ListLinuxSubscriptionInstancesResponse"},
41      "errors":[
42        {"shape":"InternalServerException"},
43        {"shape":"ThrottlingException"},
44        {"shape":"ValidationException"}
45      ],
46      "documentation":"<p>Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.</p>",
47      "idempotent":true
48    },
49    "ListLinuxSubscriptions":{
50      "name":"ListLinuxSubscriptions",
51      "http":{
52        "method":"POST",
53        "requestUri":"/subscription/ListLinuxSubscriptions",
54        "responseCode":200
55      },
56      "input":{"shape":"ListLinuxSubscriptionsRequest"},
57      "output":{"shape":"ListLinuxSubscriptionsResponse"},
58      "errors":[
59        {"shape":"InternalServerException"},
60        {"shape":"ThrottlingException"},
61        {"shape":"ValidationException"}
62      ],
63      "documentation":"<p>Lists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations.</p>",
64      "idempotent":true
65    },
66    "UpdateServiceSettings":{
67      "name":"UpdateServiceSettings",
68      "http":{
69        "method":"POST",
70        "requestUri":"/subscription/UpdateServiceSettings",
71        "responseCode":200
72      },
73      "input":{"shape":"UpdateServiceSettingsRequest"},
74      "output":{"shape":"UpdateServiceSettingsResponse"},
75      "errors":[
76        {"shape":"InternalServerException"},
77        {"shape":"ThrottlingException"},
78        {"shape":"ValidationException"}
79      ],
80      "documentation":"<p>Updates the service settings for Linux subscriptions.</p>",
81      "idempotent":true
82    }
83  },
84  "shapes":{
85    "Boolean":{
86      "type":"boolean",
87      "box":true
88    },
89    "BoxInteger":{
90      "type":"integer",
91      "box":true
92    },
93    "BoxLong":{
94      "type":"long",
95      "box":true
96    },
97    "Filter":{
98      "type":"structure",
99      "members":{
100        "Name":{
101          "shape":"String",
102          "documentation":"<p>The type of name to filter by.</p>"
103        },
104        "Operator":{
105          "shape":"Operator",
106          "documentation":"<p>An operator for filtering results.</p>"
107        },
108        "Values":{
109          "shape":"StringList",
110          "documentation":"<p>One or more values for the name to filter by.</p>"
111        }
112      },
113      "documentation":"<p>A filter object that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.</p>"
114    },
115    "FilterList":{
116      "type":"list",
117      "member":{"shape":"Filter"}
118    },
119    "GetServiceSettingsRequest":{
120      "type":"structure",
121      "members":{
122      }
123    },
124    "GetServiceSettingsResponse":{
125      "type":"structure",
126      "members":{
127        "HomeRegions":{
128          "shape":"StringList",
129          "documentation":"<p>The Region in which License Manager displays the aggregated data for Linux subscriptions.</p>"
130        },
131        "LinuxSubscriptionsDiscovery":{
132          "shape":"LinuxSubscriptionsDiscovery",
133          "documentation":"<p>Lists if discovery has been enabled for Linux subscriptions.</p>"
134        },
135        "LinuxSubscriptionsDiscoverySettings":{
136          "shape":"LinuxSubscriptionsDiscoverySettings",
137          "documentation":"<p>Lists the settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.</p>"
138        },
139        "Status":{
140          "shape":"Status",
141          "documentation":"<p>Indicates the status of Linux subscriptions settings being applied.</p>"
142        },
143        "StatusMessage":{
144          "shape":"StringMap",
145          "documentation":"<p>A message which details the Linux subscriptions service settings current status.</p>"
146        }
147      }
148    },
149    "Instance":{
150      "type":"structure",
151      "members":{
152        "AccountID":{
153          "shape":"String",
154          "documentation":"<p>The account ID which owns the instance.</p>"
155        },
156        "AmiId":{
157          "shape":"String",
158          "documentation":"<p>The AMI ID used to launch the instance.</p>"
159        },
160        "InstanceID":{
161          "shape":"String",
162          "documentation":"<p>The instance ID of the resource.</p>"
163        },
164        "InstanceType":{
165          "shape":"String",
166          "documentation":"<p>The instance type of the resource.</p>"
167        },
168        "LastUpdatedTime":{
169          "shape":"String",
170          "documentation":"<p>The time in which the last discovery updated the instance details.</p>"
171        },
172        "ProductCode":{
173          "shape":"ProductCodeList",
174          "documentation":"<p>The product code for the instance. For more information, see <a href=\"https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html\">Usage operation values</a> in the <i>License Manager User Guide</i> .</p>"
175        },
176        "Region":{
177          "shape":"String",
178          "documentation":"<p>The Region the instance is running in.</p>"
179        },
180        "Status":{
181          "shape":"String",
182          "documentation":"<p>The status of the instance.</p>"
183        },
184        "SubscriptionName":{
185          "shape":"String",
186          "documentation":"<p>The name of the subscription being used by the instance.</p>"
187        },
188        "UsageOperation":{
189          "shape":"String",
190          "documentation":"<p>The usage operation of the instance. For more information, see For more information, see <a href=\"https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html\">Usage operation values</a> in the <i>License Manager User Guide</i>.</p>"
191        }
192      },
193      "documentation":"<p>Details discovered information about a running instance using Linux subscriptions.</p>"
194    },
195    "InstanceList":{
196      "type":"list",
197      "member":{"shape":"Instance"}
198    },
199    "InternalServerException":{
200      "type":"structure",
201      "members":{
202        "message":{"shape":"String"}
203      },
204      "documentation":"<p>An exception occurred with the service.</p>",
205      "exception":true,
206      "fault":true
207    },
208    "LinuxSubscriptionsDiscovery":{
209      "type":"string",
210      "enum":[
211        "Enabled",
212        "Disabled"
213      ]
214    },
215    "LinuxSubscriptionsDiscoverySettings":{
216      "type":"structure",
217      "required":[
218        "OrganizationIntegration",
219        "SourceRegions"
220      ],
221      "members":{
222        "OrganizationIntegration":{
223          "shape":"OrganizationIntegration",
224          "documentation":"<p>Details if you have enabled resource discovery across your accounts in Organizations.</p>"
225        },
226        "SourceRegions":{
227          "shape":"StringList",
228          "documentation":"<p>The Regions in which to discover data for Linux subscriptions.</p>"
229        }
230      },
231      "documentation":"<p>Lists the settings defined for discovering Linux subscriptions.</p>"
232    },
233    "ListLinuxSubscriptionInstancesRequest":{
234      "type":"structure",
235      "members":{
236        "Filters":{
237          "shape":"FilterList",
238          "documentation":"<p>An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of <code>AmiID</code> with an optional operator to see subscriptions that match, partially match, or don't match a certain Amazon Machine Image (AMI) ID.</p> <p>The valid names for this filter are:</p> <ul> <li> <p> <code>AmiID</code> </p> </li> <li> <p> <code>InstanceID</code> </p> </li> <li> <p> <code>AccountID</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>Region</code> </p> </li> <li> <p> <code>UsageOperation</code> </p> </li> <li> <p> <code>ProductCode</code> </p> </li> <li> <p> <code>InstanceType</code> </p> </li> </ul> <p>The valid Operators for this filter are:</p> <ul> <li> <p> <code>contains</code> </p> </li> <li> <p> <code>equals</code> </p> </li> <li> <p> <code>Notequal</code> </p> </li> </ul>"
239        },
240        "MaxResults":{
241          "shape":"BoxInteger",
242          "documentation":"<p>Maximum number of results to return in a single call.</p>"
243        },
244        "NextToken":{
245          "shape":"ListLinuxSubscriptionInstancesRequestNextTokenString",
246          "documentation":"<p>Token for the next set of results.</p>"
247        }
248      },
249      "documentation":"<p>NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.</p>"
250    },
251    "ListLinuxSubscriptionInstancesRequestNextTokenString":{
252      "type":"string",
253      "max":16384,
254      "min":1
255    },
256    "ListLinuxSubscriptionInstancesResponse":{
257      "type":"structure",
258      "members":{
259        "Instances":{
260          "shape":"InstanceList",
261          "documentation":"<p>An array that contains instance objects.</p>"
262        },
263        "NextToken":{
264          "shape":"String",
265          "documentation":"<p>Token for the next set of results.</p>"
266        }
267      }
268    },
269    "ListLinuxSubscriptionsRequest":{
270      "type":"structure",
271      "members":{
272        "Filters":{
273          "shape":"FilterList",
274          "documentation":"<p>An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of <code>Subscription</code> with an optional operator to see subscriptions that match, partially match, or don't match a certain subscription's name.</p> <p>The valid names for this filter are:</p> <ul> <li> <p> <code>Subscription</code> </p> </li> </ul> <p>The valid Operators for this filter are:</p> <ul> <li> <p> <code>contains</code> </p> </li> <li> <p> <code>equals</code> </p> </li> <li> <p> <code>Notequal</code> </p> </li> </ul>"
275        },
276        "MaxResults":{
277          "shape":"BoxInteger",
278          "documentation":"<p>Maximum number of results to return in a single call.</p>"
279        },
280        "NextToken":{
281          "shape":"ListLinuxSubscriptionsRequestNextTokenString",
282          "documentation":"<p>Token for the next set of results.</p>"
283        }
284      },
285      "documentation":"<p>NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.</p>"
286    },
287    "ListLinuxSubscriptionsRequestNextTokenString":{
288      "type":"string",
289      "max":16384,
290      "min":1
291    },
292    "ListLinuxSubscriptionsResponse":{
293      "type":"structure",
294      "members":{
295        "NextToken":{
296          "shape":"String",
297          "documentation":"<p>Token for the next set of results.</p>"
298        },
299        "Subscriptions":{
300          "shape":"SubscriptionList",
301          "documentation":"<p>An array that contains subscription objects.</p>"
302        }
303      }
304    },
305    "Operator":{
306      "type":"string",
307      "enum":[
308        "Equal",
309        "NotEqual",
310        "Contains"
311      ],
312      "max":20,
313      "min":1
314    },
315    "OrganizationIntegration":{
316      "type":"string",
317      "enum":[
318        "Enabled",
319        "Disabled"
320      ]
321    },
322    "ProductCodeList":{
323      "type":"list",
324      "member":{"shape":"String"}
325    },
326    "Status":{
327      "type":"string",
328      "enum":[
329        "InProgress",
330        "Completed",
331        "Successful",
332        "Failed"
333      ]
334    },
335    "String":{"type":"string"},
336    "StringList":{
337      "type":"list",
338      "member":{"shape":"StringListMemberString"},
339      "max":100,
340      "min":1
341    },
342    "StringListMemberString":{
343      "type":"string",
344      "max":100,
345      "min":1
346    },
347    "StringMap":{
348      "type":"map",
349      "key":{"shape":"String"},
350      "value":{"shape":"String"}
351    },
352    "Subscription":{
353      "type":"structure",
354      "members":{
355        "InstanceCount":{
356          "shape":"BoxLong",
357          "documentation":"<p>The total amount of running instances using this subscription.</p>"
358        },
359        "Name":{
360          "shape":"String",
361          "documentation":"<p>The name of the subscription.</p>"
362        },
363        "Type":{
364          "shape":"String",
365          "documentation":"<p>The type of subscription. The type can be subscription-included with Amazon EC2, Bring Your Own Subscription model (BYOS), or from the Amazon Web Services Marketplace. Certain subscriptions may use licensing from the Amazon Web Services Marketplace as well as OS licensing from Amazon EC2 or BYOS.</p>"
366        }
367      },
368      "documentation":"<p>An object which details a discovered Linux subscription.</p>"
369    },
370    "SubscriptionList":{
371      "type":"list",
372      "member":{"shape":"Subscription"}
373    },
374    "ThrottlingException":{
375      "type":"structure",
376      "members":{
377        "message":{"shape":"String"}
378      },
379      "documentation":"<p>The request was denied due to request throttling.</p>",
380      "exception":true
381    },
382    "UpdateServiceSettingsRequest":{
383      "type":"structure",
384      "required":[
385        "LinuxSubscriptionsDiscovery",
386        "LinuxSubscriptionsDiscoverySettings"
387      ],
388      "members":{
389        "AllowUpdate":{
390          "shape":"Boolean",
391          "documentation":"<p>Describes if updates are allowed to the service settings for Linux subscriptions. If you allow updates, you can aggregate Linux subscription data in more than one home Region.</p>"
392        },
393        "LinuxSubscriptionsDiscovery":{
394          "shape":"LinuxSubscriptionsDiscovery",
395          "documentation":"<p>Describes if the discovery of Linux subscriptions is enabled.</p>"
396        },
397        "LinuxSubscriptionsDiscoverySettings":{
398          "shape":"LinuxSubscriptionsDiscoverySettings",
399          "documentation":"<p>The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.</p>"
400        }
401      }
402    },
403    "UpdateServiceSettingsResponse":{
404      "type":"structure",
405      "members":{
406        "HomeRegions":{
407          "shape":"StringList",
408          "documentation":"<p>The Region in which License Manager displays the aggregated data for Linux subscriptions.</p>"
409        },
410        "LinuxSubscriptionsDiscovery":{
411          "shape":"LinuxSubscriptionsDiscovery",
412          "documentation":"<p>Lists if discovery has been enabled for Linux subscriptions.</p>"
413        },
414        "LinuxSubscriptionsDiscoverySettings":{
415          "shape":"LinuxSubscriptionsDiscoverySettings",
416          "documentation":"<p>The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.</p>"
417        },
418        "Status":{
419          "shape":"Status",
420          "documentation":"<p>Indicates the status of Linux subscriptions settings being applied.</p>"
421        },
422        "StatusMessage":{
423          "shape":"StringMap",
424          "documentation":"<p>A message which details the Linux subscriptions service settings current status.</p>"
425        }
426      }
427    },
428    "ValidationException":{
429      "type":"structure",
430      "members":{
431        "message":{"shape":"String"}
432      },
433      "documentation":"<p>The provided input is not valid. Try your request again.</p>",
434      "exception":true
435    }
436  },
437  "documentation":"<p>With License Manager, you can discover and track your commercial Linux subscriptions on running Amazon EC2 instances.</p>"
438}
439