oam.d.ts 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class OAM extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: OAM.Types.ClientConfiguration)
  13. config: Config & OAM.Types.ClientConfiguration;
  14. /**
  15. * Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account. Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts. For more information, see CreateSink and PutSinkPolicy. Each monitoring account can be linked to as many as 100,000 source accounts. Each source account can be linked to as many as five monitoring accounts.
  16. */
  17. createLink(params: OAM.Types.CreateLinkInput, callback?: (err: AWSError, data: OAM.Types.CreateLinkOutput) => void): Request<OAM.Types.CreateLinkOutput, AWSError>;
  18. /**
  19. * Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account. Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts. For more information, see CreateSink and PutSinkPolicy. Each monitoring account can be linked to as many as 100,000 source accounts. Each source account can be linked to as many as five monitoring accounts.
  20. */
  21. createLink(callback?: (err: AWSError, data: OAM.Types.CreateLinkOutput) => void): Request<OAM.Types.CreateLinkOutput, AWSError>;
  22. /**
  23. * Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data. After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy. Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.
  24. */
  25. createSink(params: OAM.Types.CreateSinkInput, callback?: (err: AWSError, data: OAM.Types.CreateSinkOutput) => void): Request<OAM.Types.CreateSinkOutput, AWSError>;
  26. /**
  27. * Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data. After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy. Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.
  28. */
  29. createSink(callback?: (err: AWSError, data: OAM.Types.CreateSinkOutput) => void): Request<OAM.Types.CreateSinkOutput, AWSError>;
  30. /**
  31. * Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.
  32. */
  33. deleteLink(params: OAM.Types.DeleteLinkInput, callback?: (err: AWSError, data: OAM.Types.DeleteLinkOutput) => void): Request<OAM.Types.DeleteLinkOutput, AWSError>;
  34. /**
  35. * Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.
  36. */
  37. deleteLink(callback?: (err: AWSError, data: OAM.Types.DeleteLinkOutput) => void): Request<OAM.Types.DeleteLinkOutput, AWSError>;
  38. /**
  39. * Deletes a sink. You must delete all links to a sink before you can delete that sink.
  40. */
  41. deleteSink(params: OAM.Types.DeleteSinkInput, callback?: (err: AWSError, data: OAM.Types.DeleteSinkOutput) => void): Request<OAM.Types.DeleteSinkOutput, AWSError>;
  42. /**
  43. * Deletes a sink. You must delete all links to a sink before you can delete that sink.
  44. */
  45. deleteSink(callback?: (err: AWSError, data: OAM.Types.DeleteSinkOutput) => void): Request<OAM.Types.DeleteSinkOutput, AWSError>;
  46. /**
  47. * Returns complete information about one link. To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
  48. */
  49. getLink(params: OAM.Types.GetLinkInput, callback?: (err: AWSError, data: OAM.Types.GetLinkOutput) => void): Request<OAM.Types.GetLinkOutput, AWSError>;
  50. /**
  51. * Returns complete information about one link. To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
  52. */
  53. getLink(callback?: (err: AWSError, data: OAM.Types.GetLinkOutput) => void): Request<OAM.Types.GetLinkOutput, AWSError>;
  54. /**
  55. * Returns complete information about one monitoring account sink. To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
  56. */
  57. getSink(params: OAM.Types.GetSinkInput, callback?: (err: AWSError, data: OAM.Types.GetSinkOutput) => void): Request<OAM.Types.GetSinkOutput, AWSError>;
  58. /**
  59. * Returns complete information about one monitoring account sink. To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
  60. */
  61. getSink(callback?: (err: AWSError, data: OAM.Types.GetSinkOutput) => void): Request<OAM.Types.GetSinkOutput, AWSError>;
  62. /**
  63. * Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.
  64. */
  65. getSinkPolicy(params: OAM.Types.GetSinkPolicyInput, callback?: (err: AWSError, data: OAM.Types.GetSinkPolicyOutput) => void): Request<OAM.Types.GetSinkPolicyOutput, AWSError>;
  66. /**
  67. * Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.
  68. */
  69. getSinkPolicy(callback?: (err: AWSError, data: OAM.Types.GetSinkPolicyOutput) => void): Request<OAM.Types.GetSinkPolicyOutput, AWSError>;
  70. /**
  71. * Returns a list of source account links that are linked to this monitoring account sink. To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks. To find a list of links for one source account, use ListLinks.
  72. */
  73. listAttachedLinks(params: OAM.Types.ListAttachedLinksInput, callback?: (err: AWSError, data: OAM.Types.ListAttachedLinksOutput) => void): Request<OAM.Types.ListAttachedLinksOutput, AWSError>;
  74. /**
  75. * Returns a list of source account links that are linked to this monitoring account sink. To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks. To find a list of links for one source account, use ListLinks.
  76. */
  77. listAttachedLinks(callback?: (err: AWSError, data: OAM.Types.ListAttachedLinksOutput) => void): Request<OAM.Types.ListAttachedLinksOutput, AWSError>;
  78. /**
  79. * Use this operation in a source account to return a list of links to monitoring account sinks that this source account has. To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
  80. */
  81. listLinks(params: OAM.Types.ListLinksInput, callback?: (err: AWSError, data: OAM.Types.ListLinksOutput) => void): Request<OAM.Types.ListLinksOutput, AWSError>;
  82. /**
  83. * Use this operation in a source account to return a list of links to monitoring account sinks that this source account has. To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
  84. */
  85. listLinks(callback?: (err: AWSError, data: OAM.Types.ListLinksOutput) => void): Request<OAM.Types.ListLinksOutput, AWSError>;
  86. /**
  87. * Use this operation in a monitoring account to return the list of sinks created in that account.
  88. */
  89. listSinks(params: OAM.Types.ListSinksInput, callback?: (err: AWSError, data: OAM.Types.ListSinksOutput) => void): Request<OAM.Types.ListSinksOutput, AWSError>;
  90. /**
  91. * Use this operation in a monitoring account to return the list of sinks created in that account.
  92. */
  93. listSinks(callback?: (err: AWSError, data: OAM.Types.ListSinksOutput) => void): Request<OAM.Types.ListSinksOutput, AWSError>;
  94. /**
  95. * Displays the tags associated with a resource. Both sinks and links support tagging.
  96. */
  97. listTagsForResource(params: OAM.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: OAM.Types.ListTagsForResourceOutput) => void): Request<OAM.Types.ListTagsForResourceOutput, AWSError>;
  98. /**
  99. * Displays the tags associated with a resource. Both sinks and links support tagging.
  100. */
  101. listTagsForResource(callback?: (err: AWSError, data: OAM.Types.ListTagsForResourceOutput) => void): Request<OAM.Types.ListTagsForResourceOutput, AWSError>;
  102. /**
  103. * Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts. You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are: Metrics - Specify with AWS::CloudWatch::Metric Log groups - Specify with AWS::Logs::LogGroup Traces - Specify with AWS::XRay::Trace Application Insights - Applications - Specify with AWS::ApplicationInsights::Application See the examples in this section to see how to specify permitted source accounts and data types.
  104. */
  105. putSinkPolicy(params: OAM.Types.PutSinkPolicyInput, callback?: (err: AWSError, data: OAM.Types.PutSinkPolicyOutput) => void): Request<OAM.Types.PutSinkPolicyOutput, AWSError>;
  106. /**
  107. * Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts. You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are: Metrics - Specify with AWS::CloudWatch::Metric Log groups - Specify with AWS::Logs::LogGroup Traces - Specify with AWS::XRay::Trace Application Insights - Applications - Specify with AWS::ApplicationInsights::Application See the examples in this section to see how to specify permitted source accounts and data types.
  108. */
  109. putSinkPolicy(callback?: (err: AWSError, data: OAM.Types.PutSinkPolicyOutput) => void): Request<OAM.Types.PutSinkPolicyOutput, AWSError>;
  110. /**
  111. * Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.
  112. */
  113. tagResource(params: OAM.Types.TagResourceInput, callback?: (err: AWSError, data: OAM.Types.TagResourceOutput) => void): Request<OAM.Types.TagResourceOutput, AWSError>;
  114. /**
  115. * Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.
  116. */
  117. tagResource(callback?: (err: AWSError, data: OAM.Types.TagResourceOutput) => void): Request<OAM.Types.TagResourceOutput, AWSError>;
  118. /**
  119. * Removes one or more tags from the specified resource. Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.
  120. */
  121. untagResource(params: OAM.Types.UntagResourceInput, callback?: (err: AWSError, data: OAM.Types.UntagResourceOutput) => void): Request<OAM.Types.UntagResourceOutput, AWSError>;
  122. /**
  123. * Removes one or more tags from the specified resource. Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.
  124. */
  125. untagResource(callback?: (err: AWSError, data: OAM.Types.UntagResourceOutput) => void): Request<OAM.Types.UntagResourceOutput, AWSError>;
  126. /**
  127. * Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation. When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account. To update the list of tags associated with the sink, use TagResource.
  128. */
  129. updateLink(params: OAM.Types.UpdateLinkInput, callback?: (err: AWSError, data: OAM.Types.UpdateLinkOutput) => void): Request<OAM.Types.UpdateLinkOutput, AWSError>;
  130. /**
  131. * Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation. When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account. To update the list of tags associated with the sink, use TagResource.
  132. */
  133. updateLink(callback?: (err: AWSError, data: OAM.Types.UpdateLinkOutput) => void): Request<OAM.Types.UpdateLinkOutput, AWSError>;
  134. }
  135. declare namespace OAM {
  136. export type Arn = string;
  137. export interface CreateLinkInput {
  138. /**
  139. * Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account. You can use a custom label or use the following variables: $AccountName is the name of the account $AccountEmail is the globally unique email address of the account $AccountEmailNoDomain is the email address of the account without the domain name
  140. */
  141. LabelTemplate: LabelTemplate;
  142. /**
  143. * Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
  144. */
  145. LinkConfiguration?: LinkConfiguration;
  146. /**
  147. * An array of strings that define which types of data that the source account shares with the monitoring account.
  148. */
  149. ResourceTypes: ResourceTypesInput;
  150. /**
  151. * The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks. For more information about sinks, see CreateSink.
  152. */
  153. SinkIdentifier: ResourceIdentifier;
  154. /**
  155. * Assigns one or more tags (key-value pairs) to the link. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
  156. */
  157. Tags?: TagMapInput;
  158. }
  159. export interface CreateLinkOutput {
  160. /**
  161. * The ARN of the link that is newly created.
  162. */
  163. Arn?: String;
  164. /**
  165. * The random ID string that Amazon Web Services generated as part of the link ARN.
  166. */
  167. Id?: String;
  168. /**
  169. * The label that you assigned to this link. If the labelTemplate includes variables, this field displays the variables resolved to their actual values.
  170. */
  171. Label?: String;
  172. /**
  173. * The exact label template that you specified, with the variables not resolved.
  174. */
  175. LabelTemplate?: String;
  176. /**
  177. * This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
  178. */
  179. LinkConfiguration?: LinkConfiguration;
  180. /**
  181. * The resource types supported by this link.
  182. */
  183. ResourceTypes?: ResourceTypesOutput;
  184. /**
  185. * The ARN of the sink that is used for this link.
  186. */
  187. SinkArn?: String;
  188. /**
  189. * The tags assigned to the link.
  190. */
  191. Tags?: TagMapOutput;
  192. }
  193. export interface CreateSinkInput {
  194. /**
  195. * A name for the sink.
  196. */
  197. Name: SinkName;
  198. /**
  199. * Assigns one or more tags (key-value pairs) to the link. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
  200. */
  201. Tags?: TagMapInput;
  202. }
  203. export interface CreateSinkOutput {
  204. /**
  205. * The ARN of the sink that is newly created.
  206. */
  207. Arn?: String;
  208. /**
  209. * The random ID string that Amazon Web Services generated as part of the sink ARN.
  210. */
  211. Id?: String;
  212. /**
  213. * The name of the sink.
  214. */
  215. Name?: String;
  216. /**
  217. * The tags assigned to the sink.
  218. */
  219. Tags?: TagMapOutput;
  220. }
  221. export interface DeleteLinkInput {
  222. /**
  223. * The ARN of the link to delete.
  224. */
  225. Identifier: ResourceIdentifier;
  226. }
  227. export interface DeleteLinkOutput {
  228. }
  229. export interface DeleteSinkInput {
  230. /**
  231. * The ARN of the sink to delete.
  232. */
  233. Identifier: ResourceIdentifier;
  234. }
  235. export interface DeleteSinkOutput {
  236. }
  237. export interface GetLinkInput {
  238. /**
  239. * The ARN of the link to retrieve information for.
  240. */
  241. Identifier: ResourceIdentifier;
  242. }
  243. export interface GetLinkOutput {
  244. /**
  245. * The ARN of the link.
  246. */
  247. Arn?: String;
  248. /**
  249. * The random ID string that Amazon Web Services generated as part of the link ARN.
  250. */
  251. Id?: String;
  252. /**
  253. * The label that you assigned to this link, with the variables resolved to their actual values.
  254. */
  255. Label?: String;
  256. /**
  257. * The exact label template that was specified when the link was created, with the template variables not resolved.
  258. */
  259. LabelTemplate?: String;
  260. /**
  261. * This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
  262. */
  263. LinkConfiguration?: LinkConfiguration;
  264. /**
  265. * The resource types supported by this link.
  266. */
  267. ResourceTypes?: ResourceTypesOutput;
  268. /**
  269. * The ARN of the sink that is used for this link.
  270. */
  271. SinkArn?: String;
  272. /**
  273. * The tags assigned to the link.
  274. */
  275. Tags?: TagMapOutput;
  276. }
  277. export interface GetSinkInput {
  278. /**
  279. * The ARN of the sink to retrieve information for.
  280. */
  281. Identifier: ResourceIdentifier;
  282. }
  283. export interface GetSinkOutput {
  284. /**
  285. * The ARN of the sink.
  286. */
  287. Arn?: String;
  288. /**
  289. * The random ID string that Amazon Web Services generated as part of the sink ARN.
  290. */
  291. Id?: String;
  292. /**
  293. * The name of the sink.
  294. */
  295. Name?: String;
  296. /**
  297. * The tags assigned to the sink.
  298. */
  299. Tags?: TagMapOutput;
  300. }
  301. export interface GetSinkPolicyInput {
  302. /**
  303. * The ARN of the sink to retrieve the policy of.
  304. */
  305. SinkIdentifier: ResourceIdentifier;
  306. }
  307. export interface GetSinkPolicyOutput {
  308. /**
  309. * The policy that you specified, in JSON format.
  310. */
  311. Policy?: String;
  312. /**
  313. * The ARN of the sink.
  314. */
  315. SinkArn?: String;
  316. /**
  317. * The random ID string that Amazon Web Services generated as part of the sink ARN.
  318. */
  319. SinkId?: String;
  320. }
  321. export type LabelTemplate = string;
  322. export interface LinkConfiguration {
  323. /**
  324. * Use this structure to filter which log groups are to send log events from the source account to the monitoring account.
  325. */
  326. LogGroupConfiguration?: LogGroupConfiguration;
  327. /**
  328. * Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
  329. */
  330. MetricConfiguration?: MetricConfiguration;
  331. }
  332. export interface ListAttachedLinksInput {
  333. /**
  334. * Limits the number of returned links to the specified number.
  335. */
  336. MaxResults?: ListAttachedLinksMaxResults;
  337. /**
  338. * The token for the next set of items to return. You received this token from a previous call.
  339. */
  340. NextToken?: NextToken;
  341. /**
  342. * The ARN of the sink that you want to retrieve links for.
  343. */
  344. SinkIdentifier: ResourceIdentifier;
  345. }
  346. export interface ListAttachedLinksItem {
  347. /**
  348. * The label that was assigned to this link at creation, with the variables resolved to their actual values.
  349. */
  350. Label?: String;
  351. /**
  352. * The ARN of the link.
  353. */
  354. LinkArn?: String;
  355. /**
  356. * The resource types supported by this link.
  357. */
  358. ResourceTypes?: ResourceTypesOutput;
  359. }
  360. export type ListAttachedLinksItems = ListAttachedLinksItem[];
  361. export type ListAttachedLinksMaxResults = number;
  362. export interface ListAttachedLinksOutput {
  363. /**
  364. * An array of structures that contain the information about the attached links.
  365. */
  366. Items: ListAttachedLinksItems;
  367. /**
  368. * The token to use when requesting the next set of links.
  369. */
  370. NextToken?: String;
  371. }
  372. export interface ListLinksInput {
  373. /**
  374. * Limits the number of returned links to the specified number.
  375. */
  376. MaxResults?: ListLinksMaxResults;
  377. /**
  378. * The token for the next set of items to return. You received this token from a previous call.
  379. */
  380. NextToken?: NextToken;
  381. }
  382. export interface ListLinksItem {
  383. /**
  384. * The ARN of the link.
  385. */
  386. Arn?: String;
  387. /**
  388. * The random ID string that Amazon Web Services generated as part of the link ARN.
  389. */
  390. Id?: String;
  391. /**
  392. * The label that was assigned to this link at creation, with the variables resolved to their actual values.
  393. */
  394. Label?: String;
  395. /**
  396. * The resource types supported by this link.
  397. */
  398. ResourceTypes?: ResourceTypesOutput;
  399. /**
  400. * The ARN of the sink that this link is attached to.
  401. */
  402. SinkArn?: String;
  403. }
  404. export type ListLinksItems = ListLinksItem[];
  405. export type ListLinksMaxResults = number;
  406. export interface ListLinksOutput {
  407. /**
  408. * An array of structures that contain the information about the returned links.
  409. */
  410. Items: ListLinksItems;
  411. /**
  412. * The token to use when requesting the next set of links.
  413. */
  414. NextToken?: String;
  415. }
  416. export interface ListSinksInput {
  417. /**
  418. * Limits the number of returned links to the specified number.
  419. */
  420. MaxResults?: ListSinksMaxResults;
  421. /**
  422. * The token for the next set of items to return. You received this token from a previous call.
  423. */
  424. NextToken?: NextToken;
  425. }
  426. export interface ListSinksItem {
  427. /**
  428. * The ARN of the sink.
  429. */
  430. Arn?: String;
  431. /**
  432. * The random ID string that Amazon Web Services generated as part of the sink ARN.
  433. */
  434. Id?: String;
  435. /**
  436. * The name of the sink.
  437. */
  438. Name?: String;
  439. }
  440. export type ListSinksItems = ListSinksItem[];
  441. export type ListSinksMaxResults = number;
  442. export interface ListSinksOutput {
  443. /**
  444. * An array of structures that contain the information about the returned sinks.
  445. */
  446. Items: ListSinksItems;
  447. /**
  448. * The token to use when requesting the next set of sinks.
  449. */
  450. NextToken?: String;
  451. }
  452. export interface ListTagsForResourceInput {
  453. /**
  454. * The ARN of the resource that you want to view tags for. The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id For more information about ARN format, see CloudWatch Logs resources and operations. Unlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags for links or sinks you must have the oam:RequestTag permission. The aws:ReguestTag permission does not allow you to tag and untag links and sinks.
  455. */
  456. ResourceArn: Arn;
  457. }
  458. export interface ListTagsForResourceOutput {
  459. /**
  460. * The list of tags associated with the requested resource.&gt;
  461. */
  462. Tags?: TagMapOutput;
  463. }
  464. export interface LogGroupConfiguration {
  465. /**
  466. * Use this field to specify which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands. Use single quotation marks (') around log group names. The matching of log group names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR. = and != AND OR LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include. IN and NOT IN, using parentheses ( ) Examples: LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group. LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2. LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs. If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.
  467. */
  468. Filter: LogsFilter;
  469. }
  470. export type LogsFilter = string;
  471. export interface MetricConfiguration {
  472. /**
  473. * Use this field to specify which metrics are to be shared with the monitoring account. Use the term Namespace and one or more of the following operands. Use single quotation marks (') around namespace names. The matching of namespace names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR. = and != AND OR LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include. IN and NOT IN, using parentheses ( ) Examples: Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/, such as custom namespaces. Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing, and Amazon S3 namespaces. Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces. If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all metric namespaces with the monitoring account.
  474. */
  475. Filter: MetricsFilter;
  476. }
  477. export type MetricsFilter = string;
  478. export type NextToken = string;
  479. export interface PutSinkPolicyInput {
  480. /**
  481. * The JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here. The policy must be in JSON string format with quotation marks escaped and no newlines. For examples of different types of policies, see the Examples section on this page.
  482. */
  483. Policy: SinkPolicy;
  484. /**
  485. * The ARN of the sink to attach this policy to.
  486. */
  487. SinkIdentifier: ResourceIdentifier;
  488. }
  489. export interface PutSinkPolicyOutput {
  490. /**
  491. * The policy that you specified.
  492. */
  493. Policy?: String;
  494. /**
  495. * The ARN of the sink.
  496. */
  497. SinkArn?: String;
  498. /**
  499. * The random ID string that Amazon Web Services generated as part of the sink ARN.
  500. */
  501. SinkId?: String;
  502. }
  503. export type ResourceIdentifier = string;
  504. export type ResourceType = "AWS::CloudWatch::Metric"|"AWS::Logs::LogGroup"|"AWS::XRay::Trace"|"AWS::ApplicationInsights::Application"|"AWS::InternetMonitor::Monitor"|string;
  505. export type ResourceTypesInput = ResourceType[];
  506. export type ResourceTypesOutput = String[];
  507. export type SinkName = string;
  508. export type SinkPolicy = string;
  509. export type String = string;
  510. export type TagKey = string;
  511. export type TagKeys = TagKey[];
  512. export type TagMapInput = {[key: string]: TagValue};
  513. export type TagMapOutput = {[key: string]: String};
  514. export interface TagResourceInput {
  515. /**
  516. * The ARN of the resource that you're adding tags to. The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id For more information about ARN format, see CloudWatch Logs resources and operations.
  517. */
  518. ResourceArn: Arn;
  519. /**
  520. * The list of key-value pairs to associate with the resource.
  521. */
  522. Tags: TagMapInput;
  523. }
  524. export interface TagResourceOutput {
  525. }
  526. export type TagValue = string;
  527. export interface UntagResourceInput {
  528. /**
  529. * The ARN of the resource that you're removing tags from. The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id For more information about ARN format, see CloudWatch Logs resources and operations.
  530. */
  531. ResourceArn: Arn;
  532. /**
  533. * The list of tag keys to remove from the resource.
  534. */
  535. TagKeys: TagKeys;
  536. }
  537. export interface UntagResourceOutput {
  538. }
  539. export interface UpdateLinkInput {
  540. /**
  541. * The ARN of the link that you want to update.
  542. */
  543. Identifier: ResourceIdentifier;
  544. /**
  545. * Use this structure to filter which metric namespaces and which log groups are to be shared from the source account to the monitoring account.
  546. */
  547. LinkConfiguration?: LinkConfiguration;
  548. /**
  549. * An array of strings that define which types of data that the source account will send to the monitoring account. Your input here replaces the current set of data types that are shared.
  550. */
  551. ResourceTypes: ResourceTypesInput;
  552. }
  553. export interface UpdateLinkOutput {
  554. /**
  555. * The ARN of the link that you have updated.
  556. */
  557. Arn?: String;
  558. /**
  559. * The random ID string that Amazon Web Services generated as part of the sink ARN.
  560. */
  561. Id?: String;
  562. /**
  563. * The label assigned to this link, with the variables resolved to their actual values.
  564. */
  565. Label?: String;
  566. /**
  567. * The exact label template that was specified when the link was created, with the template variables not resolved.
  568. */
  569. LabelTemplate?: LabelTemplate;
  570. /**
  571. * This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
  572. */
  573. LinkConfiguration?: LinkConfiguration;
  574. /**
  575. * The resource types now supported by this link.
  576. */
  577. ResourceTypes?: ResourceTypesOutput;
  578. /**
  579. * The ARN of the sink that is used for this link.
  580. */
  581. SinkArn?: String;
  582. /**
  583. * The tags assigned to the link.
  584. */
  585. Tags?: TagMapOutput;
  586. }
  587. /**
  588. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  589. */
  590. export type apiVersion = "2022-06-10"|"latest"|string;
  591. export interface ClientApiVersions {
  592. /**
  593. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  594. */
  595. apiVersion?: apiVersion;
  596. }
  597. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  598. /**
  599. * Contains interfaces for use with the OAM client.
  600. */
  601. export import Types = OAM;
  602. }
  603. export = OAM;