-
Notifications
You must be signed in to change notification settings - Fork 314
Expand file tree
/
Copy pathmanagement.SDK.LogStreamsClient.html
More file actions
203 lines (170 loc) · 82.3 KB
/
management.SDK.LogStreamsClient.html
File metadata and controls
203 lines (170 loc) · 82.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LogStreamsClient | Auth0 Node.js SDK - v5.10.0</title><meta name="description" content="Documentation for Auth0 Node.js SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Auth0 Node.js SDK - v5.10.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/management.html">management</a></li><li><a href="../modules/management.SDK.html">SDK</a></li><li><a href="" aria-current="page">LogStreamsClient</a></li></ul><h1>Class LogStreamsClient</h1></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#list" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list</span></a>
<a href="#create" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a>
<a href="#get" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a>
<a href="#delete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a>
<a href="#update" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#_options" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>options</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorlogstreamsclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">LogStreamsClient</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/management.SDK.BaseClientOptions.html" class="tsd-signature-type tsd-kind-type-alias">BaseClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">LogStreamsClient</a><a href="#constructorlogstreamsclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/management.SDK.BaseClientOptions.html" class="tsd-signature-type tsd-kind-type-alias">BaseClientOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LogStreamsClient</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="list"><span>list</span><a href="#list" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="list-1"><span class="tsd-kind-call-signature">list</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/management.Management.LogStreamResponseSchema.html" class="tsd-signature-type tsd-kind-type-alias">LogStreamResponseSchema</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#list-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve details on <a href="https://auth0.com/docs/logs/streams">log streams</a>.</p>
<p><strong>Sample Response</strong></p>
<pre><code class="json"><span class="hl-1">[{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"eventbridge"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"awsAccountId"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"awsRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"awsPartnerEventSource"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}, {</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"http"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentFormat"</span><span class="hl-1">: </span><span class="hl-2">"JSONLINES|JSONARRAY"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentType"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpEndpoint"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpAuthorization"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">},</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"eventgrid"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"azureSubscriptionId"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"azureResourceGroup"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"azureRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"azurePartnerTopic"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">},</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"splunk"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkDomain"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkToken"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkPort"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkSecure"</span><span class="hl-1">: </span><span class="hl-2">"boolean"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">},</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"sumo"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"sumoSourceAddress"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">},</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"datadog"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogApiKey"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}]</span>
</code><button type="button">Copy</button></pre>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/management.Management.LogStreamResponseSchema.html" class="tsd-signature-type tsd-kind-type-alias">LogStreamResponseSchema</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.NotFoundError.html" class="tsd-kind-class">Management.NotFoundError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">logStreams</span><span class="hl-1">.</span><span class="hl-0">list</span><span class="hl-1">()</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="create"><span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="create-1"><span class="tsd-kind-call-signature">create</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="../types/management.Management.CreateLogStreamRequestContent.html" class="tsd-signature-type tsd-kind-type-alias">CreateLogStreamRequestContent</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/management.Management.CreateLogStreamResponseContent.html" class="tsd-signature-type tsd-kind-type-alias">CreateLogStreamResponseContent</a><span class="tsd-signature-symbol">></span><a href="#create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a log stream.</p>
<p><strong>Log Stream Types</strong></p>
<p>The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload.</p>
<p><strong>HTTP Stream</strong></p>
<p>For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below.</p>
<p><strong>Request:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"http"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"httpEndpoint"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentType"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentFormat"</span><span class="hl-1">: </span><span class="hl-2">"JSONLINES|JSONARRAY"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpAuthorization"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Response:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"http"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"httpEndpoint"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentType"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentFormat"</span><span class="hl-1">: </span><span class="hl-2">"JSONLINES|JSONARRAY"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpAuthorization"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Amazon EventBridge Stream</strong></p>
<p>For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below.</p>
<p><strong>Request:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"eventbridge"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"awsRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"awsAccountId"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p>The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>:</p>
<p><strong>Response:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"eventbridge"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"awsAccountId"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"awsRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"awsPartnerEventSource"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Azure Event Grid Stream</strong></p>
<p>For an <code>Azure Event Grid</code> Stream, the <code>sink</code> properties are listed in the payload below.</p>
<p><strong>Request:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"eventgrid"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"azureSubscriptionId"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"azureResourceGroup"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"azureRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Response:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"http"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"azureSubscriptionId"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"azureResourceGroup"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"azureRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"azurePartnerTopic"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Datadog Stream</strong></p>
<p>For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below.</p>
<p><strong>Request:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"datadog"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogApiKey"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Response:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"datadog"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogApiKey"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Splunk Stream</strong></p>
<p>For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below.</p>
<p><strong>Request:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"splunk"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkDomain"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkToken"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkPort"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkSecure"</span><span class="hl-1">: </span><span class="hl-2">"boolean"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Response:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"splunk"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkDomain"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkToken"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkPort"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkSecure"</span><span class="hl-1">: </span><span class="hl-2">"boolean"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Sumo Logic Stream</strong></p>
<p>For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below.</p>
<p><strong>Request:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"sumo"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"sumoSourceAddress"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Response:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"sumo"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"sumoSourceAddress"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="../types/management.Management.CreateLogStreamRequestContent.html" class="tsd-signature-type tsd-kind-type-alias">CreateLogStreamRequestContent</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/management.Management.CreateLogStreamResponseContent.html" class="tsd-signature-type tsd-kind-type-alias">CreateLogStreamResponseContent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-6">Throws<a href="#throws-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ConflictError.html" class="tsd-kind-class">Management.ConflictError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-8">Throws<a href="#throws-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">logStreams</span><span class="hl-1">.</span><span class="hl-0">create</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">type:</span><span class="hl-1"> </span><span class="hl-2">"http"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">sink:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">httpEndpoint:</span><span class="hl-1"> </span><span class="hl-2">"httpEndpoint"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> })</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get-1"><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/management.Management.GetLogStreamResponseContent.html" class="tsd-signature-type tsd-kind-type-alias">GetLogStreamResponseContent</a><span class="tsd-signature-symbol">></span><a href="#get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve a log stream configuration and status.</p>
<p><strong>Sample responses</strong></p>
<p><strong>Amazon EventBridge Log Stream</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"eventbridge"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"awsAccountId"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"awsRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"awsPartnerEventSource"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>HTTP Log Stream</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"http"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentFormat"</span><span class="hl-1">: </span><span class="hl-2">"JSONLINES|JSONARRAY"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentType"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpEndpoint"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpAuthorization"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Datadog Log Stream</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"datadog"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogApiKey"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Mixpanel</strong></p>
<p><strong>Request:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"mixpanel"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"mixpanelRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"mixpanelProjectId"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"mixpanelServiceAccountUsername"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"mixpanelServiceAccountPassword"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Response:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"mixpanel"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"mixpanelRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"mixpanelProjectId"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"mixpanelServiceAccountUsername"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"mixpanelServiceAccountPassword"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Segment</strong></p>
<p><strong>Request:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"segment"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"segmentWriteKey"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Response:</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"segment"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"segmentWriteKey"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Splunk Log Stream</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"splunk"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkDomain"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkToken"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkPort"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkSecure"</span><span class="hl-1">: </span><span class="hl-2">"boolean"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Sumo Logic Log Stream</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"id"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"type"</span><span class="hl-1">: </span><span class="hl-2">"sumo"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused|suspended"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"sumoSourceAddress"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Status</strong></p>
<p>The <code>status</code> of a log stream maybe any of the following:</p>
<ol>
<li><code>active</code> - Stream is currently enabled.</li>
<li><code>paused</code> - Stream is currently user disabled and will not attempt log delivery.</li>
<li><code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.</li>
</ol>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the log stream to get</p>
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/management.Management.GetLogStreamResponseContent.html" class="tsd-signature-type tsd-kind-type-alias">GetLogStreamResponseContent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-10">Throws<a href="#throws-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-11">Throws<a href="#throws-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.NotFoundError.html" class="tsd-kind-class">Management.NotFoundError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-12">Throws<a href="#throws-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">logStreams</span><span class="hl-1">.</span><span class="hl-0">get</span><span class="hl-1">(</span><span class="hl-2">"id"</span><span class="hl-1">)</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="delete"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="delete-1"><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete a log stream.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the log stream to delete</p>
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-13">Throws<a href="#throws-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-14">Throws<a href="#throws-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-15">Throws<a href="#throws-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-16">Throws<a href="#throws-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.NotFoundError.html" class="tsd-kind-class">Management.NotFoundError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-17">Throws<a href="#throws-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">logStreams</span><span class="hl-1">.</span><span class="hl-0">delete</span><span class="hl-1">(</span><span class="hl-2">"id"</span><span class="hl-1">)</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="update"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="update-1"><span class="tsd-kind-call-signature">update</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/management.Management.UpdateLogStreamRequestContent.html" class="tsd-signature-type tsd-kind-interface">UpdateLogStreamRequestContent</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/management.Management.UpdateLogStreamResponseContent.html" class="tsd-signature-type tsd-kind-type-alias">UpdateLogStreamResponseContent</a><span class="tsd-signature-symbol">></span><a href="#update-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update a log stream.</p>
<p><strong>Examples of how to use the PATCH endpoint.</strong></p>
<p>The following fields may be updated in a PATCH operation:</p>
<ul>
<li>name</li>
<li>status</li>
<li>sink</li>
</ul>
<p>Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.</p>
<p><strong>Update the status of a log stream</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"status"</span><span class="hl-1">: </span><span class="hl-2">"active|paused"</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Update the name of a log stream</strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"name"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Update the sink properties of a stream of type <code>http</code></strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"httpEndpoint"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentType"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpContentFormat"</span><span class="hl-1">: </span><span class="hl-2">"JSONARRAY|JSONLINES"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"httpAuthorization"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Update the sink properties of a stream of type <code>datadog</code></strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogRegion"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"datadogApiKey"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Update the sink properties of a stream of type <code>splunk</code></strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkDomain"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkToken"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkPort"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"splunkSecure"</span><span class="hl-1">: </span><span class="hl-2">"boolean"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p><strong>Update the sink properties of a stream of type <code>sumo</code></strong></p>
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"sink"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"sumoSourceAddress"</span><span class="hl-1">: </span><span class="hl-2">"string"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the log stream to get</p>
</div></li><li><span><span class="tsd-kind-parameter">request</span>: <a href="../interfaces/management.Management.UpdateLogStreamRequestContent.html" class="tsd-signature-type tsd-kind-interface">UpdateLogStreamRequestContent</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.LogStreamsClient.html" class="tsd-signature-type tsd-kind-namespace">LogStreamsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.LogStreamsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/management.Management.UpdateLogStreamResponseContent.html" class="tsd-signature-type tsd-kind-type-alias">UpdateLogStreamResponseContent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-18">Throws<a href="#throws-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-19">Throws<a href="#throws-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-20">Throws<a href="#throws-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-21">Throws<a href="#throws-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">logStreams</span><span class="hl-1">.</span><span class="hl-0">update</span><span class="hl-1">(</span><span class="hl-2">"id"</span><span class="hl-1">)</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="_options"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>_<wbr/>options</span><a href="#_options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_options</span><span class="tsd-signature-symbol">:</span> <a href="../types/management.SDK.NormalizedClientOptionsWithAuth.html" class="tsd-signature-type tsd-kind-type-alias">NormalizedClientOptionsWithAuth</a><span class="tsd-signature-symbol"><</span><a href="../types/management.SDK.BaseClientOptions.html" class="tsd-signature-type tsd-kind-type-alias">BaseClientOptions</a><span class="tsd-signature-symbol">></span></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#list"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list</span></a><a href="#create"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a><a href="#get"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#delete"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#update"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_options" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>options</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Auth0 Node.js SDK - v5.10.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>