Skip to content

Commit b522468

Browse files
author
awstools
committed
feat(client-oam): Add IncludeTags field to GetLink, GetSink and UpdateLink API
1 parent b6f5084 commit b522468

19 files changed

+122
-394
lines changed

clients/client-oam/README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,7 @@
66

77
AWS SDK for JavaScript OAM Client for Node.js, Browser and React Native.
88

9-
<p>Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and
10-
monitoring accounts by using <i>CloudWatch cross-account observability</i>. With
11-
CloudWatch cross-account observability, you can monitor and troubleshoot applications that span
12-
multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,
13-
logs, traces, Application Signals services, service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.</p>
14-
<p>Set up one or more Amazon Web Services accounts as <i>monitoring
15-
accounts</i> and link them with multiple <i>source accounts</i>. A
16-
monitoring account is a central Amazon Web Services account that can view and interact with
17-
observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.
18-
Source accounts share their observability data with the monitoring account. The shared
19-
observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services, service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors
20-
in CloudWatch Internet Monitor.</p>
21-
<p>When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces.
22-
And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.
23-
</p>
9+
<p>Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using <i>CloudWatch cross-account observability</i>. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, Application Signals services and service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.</p> <p>Set up one or more Amazon Web Services accounts as <i>monitoring accounts</i> and link them with multiple <i>source accounts</i>. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services and service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.</p> <p>When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups. </p>
2410

2511
## Installing
2612

clients/client-oam/src/OAM.ts

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -239,21 +239,7 @@ export interface OAM {
239239
}
240240

241241
/**
242-
* <p>Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and
243-
* monitoring accounts by using <i>CloudWatch cross-account observability</i>. With
244-
* CloudWatch cross-account observability, you can monitor and troubleshoot applications that span
245-
* multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,
246-
* logs, traces, Application Signals services, service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.</p>
247-
* <p>Set up one or more Amazon Web Services accounts as <i>monitoring
248-
* accounts</i> and link them with multiple <i>source accounts</i>. A
249-
* monitoring account is a central Amazon Web Services account that can view and interact with
250-
* observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.
251-
* Source accounts share their observability data with the monitoring account. The shared
252-
* observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services, service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors
253-
* in CloudWatch Internet Monitor.</p>
254-
* <p>When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces.
255-
* And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.
256-
* </p>
242+
* <p>Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using <i>CloudWatch cross-account observability</i>. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, Application Signals services and service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.</p> <p>Set up one or more Amazon Web Services accounts as <i>monitoring accounts</i> and link them with multiple <i>source accounts</i>. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services and service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.</p> <p>When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups. </p>
257243
* @public
258244
*/
259245
export class OAM extends OAMClient implements OAM {}

clients/client-oam/src/OAMClient.ts

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -313,21 +313,7 @@ export type OAMClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
313313
export interface OAMClientResolvedConfig extends OAMClientResolvedConfigType {}
314314

315315
/**
316-
* <p>Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and
317-
* monitoring accounts by using <i>CloudWatch cross-account observability</i>. With
318-
* CloudWatch cross-account observability, you can monitor and troubleshoot applications that span
319-
* multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,
320-
* logs, traces, Application Signals services, service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.</p>
321-
* <p>Set up one or more Amazon Web Services accounts as <i>monitoring
322-
* accounts</i> and link them with multiple <i>source accounts</i>. A
323-
* monitoring account is a central Amazon Web Services account that can view and interact with
324-
* observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.
325-
* Source accounts share their observability data with the monitoring account. The shared
326-
* observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services, service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors
327-
* in CloudWatch Internet Monitor.</p>
328-
* <p>When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces.
329-
* And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.
330-
* </p>
316+
* <p>Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using <i>CloudWatch cross-account observability</i>. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, Application Signals services and service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.</p> <p>Set up one or more Amazon Web Services accounts as <i>monitoring accounts</i> and link them with multiple <i>source accounts</i>. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services and service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.</p> <p>When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups. </p>
331317
* @public
332318
*/
333319
export class OAMClient extends __Client<

clients/client-oam/src/commands/CreateLinkCommand.ts

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,7 @@ export interface CreateLinkCommandInput extends CreateLinkInput {}
2828
export interface CreateLinkCommandOutput extends CreateLinkOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created,
32-
* data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters
33-
* that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.</p>
34-
* <p>Before you create a link, you must create a sink in the monitoring account and create a
35-
* sink policy in that account. The sink policy must permit the source account to link to it. You
36-
* can grant permission to source accounts by granting permission to an entire organization or to
37-
* individual accounts.</p>
38-
* <p>For more information, see
39-
* <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html">CreateSink</a> and
40-
* <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html">PutSinkPolicy</a>.</p>
41-
* <p>Each monitoring account can be linked to as many as 100,000 source accounts.</p>
42-
* <p>Each source account can be linked to as many as five monitoring accounts.</p>
31+
* <p>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.</p> <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html">CreateSink</a> and <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html">PutSinkPolicy</a>.</p> <p>Each monitoring account can be linked to as many as 100,000 source accounts.</p> <p>Each source account can be linked to as many as five monitoring accounts.</p>
4332
* @example
4433
* Use a bare-bones client and the command you need to make an API call.
4534
* ```javascript

clients/client-oam/src/commands/CreateSinkCommand.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface CreateSinkCommandInput extends CreateSinkInput {}
2828
export interface CreateSinkCommandOutput extends CreateSinkOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Use this to create a <i>sink</i> in the current account, so that it can be
32-
* used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that
33-
* represents an attachment point in a monitoring account. Source accounts can link to the sink
34-
* to send observability data.</p>
35-
* <p>After you create a sink, you must create a sink policy that allows source accounts to attach to it.
36-
* For more information, see <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html">PutSinkPolicy</a>.</p>
37-
* <p>Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.</p>
31+
* <p>Use this to create a <i>sink</i> 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.</p> <p>After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html">PutSinkPolicy</a>.</p> <p>Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.</p>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript

clients/client-oam/src/commands/DeleteLinkCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface DeleteLinkCommandInput extends DeleteLinkInput {}
2828
export interface DeleteLinkCommandOutput extends DeleteLinkOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a link between a monitoring account sink and a source account. You must run this operation
32-
* in the source account.</p>
31+
* <p>Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

clients/client-oam/src/commands/GetLinkCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface GetLinkCommandInput extends GetLinkInput {}
2828
export interface GetLinkCommandOutput extends GetLinkOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns complete information about one link.</p>
32-
* <p>To use this operation, provide the link ARN. To retrieve a list of link ARNs, use <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html">ListLinks</a>.</p>
31+
* <p>Returns complete information about one link.</p> <p>To use this operation, provide the link ARN. To retrieve a list of link ARNs, use <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html">ListLinks</a>.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript
@@ -38,6 +37,7 @@ export interface GetLinkCommandOutput extends GetLinkOutput, __MetadataBearer {}
3837
* const client = new OAMClient(config);
3938
* const input = { // GetLinkInput
4039
* Identifier: "STRING_VALUE", // required
40+
* IncludeTags: true || false,
4141
* };
4242
* const command = new GetLinkCommand(input);
4343
* const response = await client.send(command);

clients/client-oam/src/commands/GetSinkCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface GetSinkCommandInput extends GetSinkInput {}
2828
export interface GetSinkCommandOutput extends GetSinkOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns complete information about one monitoring account sink.</p>
32-
* <p>To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html">ListSinks</a>.</p>
31+
* <p>Returns complete information about one monitoring account sink.</p> <p>To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html">ListSinks</a>.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript
@@ -38,6 +37,7 @@ export interface GetSinkCommandOutput extends GetSinkOutput, __MetadataBearer {}
3837
* const client = new OAMClient(config);
3938
* const input = { // GetSinkInput
4039
* Identifier: "STRING_VALUE", // required
40+
* IncludeTags: true || false,
4141
* };
4242
* const command = new GetSinkCommand(input);
4343
* const response = await client.send(command);

clients/client-oam/src/commands/GetSinkPolicyCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface GetSinkPolicyCommandInput extends GetSinkPolicyInput {}
2828
export interface GetSinkPolicyCommandOutput extends GetSinkPolicyOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns the current sink policy attached to this sink. The sink policy specifies what
32-
* accounts can attach to this sink as source accounts, and what types of data they can share.</p>
31+
* <p>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.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

clients/client-oam/src/commands/ListAttachedLinksCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface ListAttachedLinksCommandInput extends ListAttachedLinksInput {}
2828
export interface ListAttachedLinksCommandOutput extends ListAttachedLinksOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a list of source account links that are linked to this monitoring account sink.</p>
32-
* <p>To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html">ListSinks</a>.</p>
33-
* <p>To find a list of links for one source account, use <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html">ListLinks</a>.</p>
31+
* <p>Returns a list of source account links that are linked to this monitoring account sink.</p> <p>To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html">ListSinks</a>.</p> <p>To find a list of links for one source account, use <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html">ListLinks</a>.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

0 commit comments

Comments
 (0)