@aws-sdk/client-networkflowmonitor 3.883.0 → 3.887.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -30,11 +30,13 @@ class ConflictException extends NetworkFlowMonitorServiceException_1.NetworkFlow
30
30
  exports.ConflictException = ConflictException;
31
31
  exports.MonitorLocalResourceType = {
32
32
  AWS_AZ: "AWS::AvailabilityZone",
33
+ AWS_REGION: "AWS::Region",
33
34
  AWS_SUBNET: "AWS::EC2::Subnet",
34
35
  AWS_VPC: "AWS::EC2::VPC",
35
36
  };
36
37
  exports.MonitorRemoteResourceType = {
37
38
  AWS_AZ: "AWS::AvailabilityZone",
39
+ AWS_REGION: "AWS::Region",
38
40
  AWS_SERVICE: "AWS::AWSService",
39
41
  AWS_SUBNET: "AWS::EC2::Subnet",
40
42
  AWS_VPC: "AWS::EC2::VPC",
@@ -137,6 +139,7 @@ exports.DestinationCategory = {
137
139
  AMAZON_DYNAMODB: "AMAZON_DYNAMODB",
138
140
  AMAZON_S3: "AMAZON_S3",
139
141
  INTER_AZ: "INTER_AZ",
142
+ INTER_REGION: "INTER_REGION",
140
143
  INTER_VPC: "INTER_VPC",
141
144
  INTRA_AZ: "INTRA_AZ",
142
145
  UNCLASSIFIED: "UNCLASSIFIED",
@@ -25,11 +25,13 @@ export class ConflictException extends __BaseException {
25
25
  }
26
26
  export const MonitorLocalResourceType = {
27
27
  AWS_AZ: "AWS::AvailabilityZone",
28
+ AWS_REGION: "AWS::Region",
28
29
  AWS_SUBNET: "AWS::EC2::Subnet",
29
30
  AWS_VPC: "AWS::EC2::VPC",
30
31
  };
31
32
  export const MonitorRemoteResourceType = {
32
33
  AWS_AZ: "AWS::AvailabilityZone",
34
+ AWS_REGION: "AWS::Region",
33
35
  AWS_SERVICE: "AWS::AWSService",
34
36
  AWS_SUBNET: "AWS::EC2::Subnet",
35
37
  AWS_VPC: "AWS::EC2::VPC",
@@ -127,6 +129,7 @@ export const DestinationCategory = {
127
129
  AMAZON_DYNAMODB: "AMAZON_DYNAMODB",
128
130
  AMAZON_S3: "AMAZON_S3",
129
131
  INTER_AZ: "INTER_AZ",
132
+ INTER_REGION: "INTER_REGION",
130
133
  INTER_VPC: "INTER_VPC",
131
134
  INTRA_AZ: "INTRA_AZ",
132
135
  UNCLASSIFIED: "UNCLASSIFIED",
@@ -27,7 +27,7 @@ declare const CreateMonitorCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicators (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. </p>
30
+ * <p>Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. </p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -38,13 +38,13 @@ declare const CreateMonitorCommand_base: {
38
38
  * monitorName: "STRING_VALUE", // required
39
39
  * localResources: [ // MonitorLocalResources // required
40
40
  * { // MonitorLocalResource
41
- * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
41
+ * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
42
42
  * identifier: "STRING_VALUE", // required
43
43
  * },
44
44
  * ],
45
45
  * remoteResources: [ // MonitorRemoteResources
46
46
  * { // MonitorRemoteResource
47
- * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
47
+ * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
48
48
  * identifier: "STRING_VALUE", // required
49
49
  * },
50
50
  * ],
@@ -62,13 +62,13 @@ declare const CreateMonitorCommand_base: {
62
62
  * // monitorStatus: "PENDING" || "ACTIVE" || "INACTIVE" || "ERROR" || "DELETING", // required
63
63
  * // localResources: [ // MonitorLocalResources // required
64
64
  * // { // MonitorLocalResource
65
- * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
65
+ * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
66
66
  * // identifier: "STRING_VALUE", // required
67
67
  * // },
68
68
  * // ],
69
69
  * // remoteResources: [ // MonitorRemoteResources // required
70
70
  * // { // MonitorRemoteResource
71
- * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
71
+ * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
72
72
  * // identifier: "STRING_VALUE", // required
73
73
  * // },
74
74
  * // ],
@@ -27,7 +27,7 @@ declare const CreateScopeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend. This call returns a scope ID to identify the scope.</p> <p>When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the resources for the Amazon Web Services that enables the feature.</p>
30
+ * <p>In Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor.</p> <p>A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources (the topology) where Network Flow Monitor will gather network flow performance metrics for you. To provide performance metrics, Network Flow Monitor uses the data that is sent by the Network Flow Monitor agents you install on the resources.</p> <p>To define the Region-account pairs for your scope, the Network Flow Monitor API uses the following constucts, which allow for future flexibility in defining scopes:</p> <ul> <li> <p> <i>Targets</i>, which are arrays of targetResources.</p> </li> <li> <p> <i>Target resources</i>, which are Region-targetIdentifier pairs.</p> </li> <li> <p> <i>Target identifiers</i>, made up of a targetID (currently always an account ID) and a targetType (currently always an account). </p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -52,6 +52,9 @@ declare const DeleteMonitorCommand_base: {
52
52
  * @throws {@link AccessDeniedException} (client fault)
53
53
  * <p>You don't have sufficient permission to perform this action.</p>
54
54
  *
55
+ * @throws {@link ConflictException} (client fault)
56
+ * <p>The requested resource is in use.</p>
57
+ *
55
58
  * @throws {@link InternalServerException} (server fault)
56
59
  * <p>An internal error occurred.</p>
57
60
  *
@@ -45,13 +45,13 @@ declare const GetMonitorCommand_base: {
45
45
  * // monitorStatus: "PENDING" || "ACTIVE" || "INACTIVE" || "ERROR" || "DELETING", // required
46
46
  * // localResources: [ // MonitorLocalResources // required
47
47
  * // { // MonitorLocalResource
48
- * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
48
+ * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
49
49
  * // identifier: "STRING_VALUE", // required
50
50
  * // },
51
51
  * // ],
52
52
  * // remoteResources: [ // MonitorRemoteResources // required
53
53
  * // { // MonitorRemoteResource
54
- * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
54
+ * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
55
55
  * // identifier: "STRING_VALUE", // required
56
56
  * // },
57
57
  * // ],
@@ -54,7 +54,7 @@ declare const GetQueryResultsMonitorTopContributorsCommand_base: {
54
54
  * // localAz: "STRING_VALUE",
55
55
  * // localSubnetId: "STRING_VALUE",
56
56
  * // targetPort: Number("int"),
57
- * // destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB",
57
+ * // destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB" || "INTER_REGION",
58
58
  * // remoteVpcId: "STRING_VALUE",
59
59
  * // remoteRegion: "STRING_VALUE",
60
60
  * // remoteAz: "STRING_VALUE",
@@ -39,7 +39,7 @@ declare const StartQueryMonitorTopContributorsCommand_base: {
39
39
  * startTime: new Date("TIMESTAMP"), // required
40
40
  * endTime: new Date("TIMESTAMP"), // required
41
41
  * metricName: "ROUND_TRIP_TIME" || "TIMEOUTS" || "RETRANSMISSIONS" || "DATA_TRANSFERRED", // required
42
- * destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB", // required
42
+ * destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB" || "INTER_REGION", // required
43
43
  * limit: Number("int"),
44
44
  * };
45
45
  * const command = new StartQueryMonitorTopContributorsCommand(input);
@@ -39,7 +39,7 @@ declare const StartQueryWorkloadInsightsTopContributorsCommand_base: {
39
39
  * startTime: new Date("TIMESTAMP"), // required
40
40
  * endTime: new Date("TIMESTAMP"), // required
41
41
  * metricName: "TIMEOUTS" || "RETRANSMISSIONS" || "DATA_TRANSFERRED", // required
42
- * destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB", // required
42
+ * destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB" || "INTER_REGION", // required
43
43
  * limit: Number("int"),
44
44
  * };
45
45
  * const command = new StartQueryWorkloadInsightsTopContributorsCommand(input);
@@ -39,7 +39,7 @@ declare const StartQueryWorkloadInsightsTopContributorsDataCommand_base: {
39
39
  * startTime: new Date("TIMESTAMP"), // required
40
40
  * endTime: new Date("TIMESTAMP"), // required
41
41
  * metricName: "TIMEOUTS" || "RETRANSMISSIONS" || "DATA_TRANSFERRED", // required
42
- * destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB", // required
42
+ * destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB" || "INTER_REGION", // required
43
43
  * };
44
44
  * const command = new StartQueryWorkloadInsightsTopContributorsDataCommand(input);
45
45
  * const response = await client.send(command);
@@ -38,25 +38,25 @@ declare const UpdateMonitorCommand_base: {
38
38
  * monitorName: "STRING_VALUE", // required
39
39
  * localResourcesToAdd: [ // MonitorLocalResources
40
40
  * { // MonitorLocalResource
41
- * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
41
+ * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
42
42
  * identifier: "STRING_VALUE", // required
43
43
  * },
44
44
  * ],
45
45
  * localResourcesToRemove: [
46
46
  * {
47
- * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
47
+ * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
48
48
  * identifier: "STRING_VALUE", // required
49
49
  * },
50
50
  * ],
51
51
  * remoteResourcesToAdd: [ // MonitorRemoteResources
52
52
  * { // MonitorRemoteResource
53
- * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
53
+ * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
54
54
  * identifier: "STRING_VALUE", // required
55
55
  * },
56
56
  * ],
57
57
  * remoteResourcesToRemove: [
58
58
  * {
59
- * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
59
+ * type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
60
60
  * identifier: "STRING_VALUE", // required
61
61
  * },
62
62
  * ],
@@ -70,13 +70,13 @@ declare const UpdateMonitorCommand_base: {
70
70
  * // monitorStatus: "PENDING" || "ACTIVE" || "INACTIVE" || "ERROR" || "DELETING", // required
71
71
  * // localResources: [ // MonitorLocalResources // required
72
72
  * // { // MonitorLocalResource
73
- * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
73
+ * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
74
74
  * // identifier: "STRING_VALUE", // required
75
75
  * // },
76
76
  * // ],
77
77
  * // remoteResources: [ // MonitorRemoteResources // required
78
78
  * // { // MonitorRemoteResource
79
- * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
79
+ * // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
80
80
  * // identifier: "STRING_VALUE", // required
81
81
  * // },
82
82
  * // ],
@@ -30,6 +30,7 @@ export declare class ConflictException extends __BaseException {
30
30
  */
31
31
  export declare const MonitorLocalResourceType: {
32
32
  readonly AWS_AZ: "AWS::AvailabilityZone";
33
+ readonly AWS_REGION: "AWS::Region";
33
34
  readonly AWS_SUBNET: "AWS::EC2::Subnet";
34
35
  readonly AWS_VPC: "AWS::EC2::VPC";
35
36
  };
@@ -38,17 +39,17 @@ export declare const MonitorLocalResourceType: {
38
39
  */
39
40
  export type MonitorLocalResourceType = (typeof MonitorLocalResourceType)[keyof typeof MonitorLocalResourceType];
40
41
  /**
41
- * <p>A local resource is the host where the agent is installed. Local resources can be a a subnet, a VPC, or an Availability Zone.</p>
42
+ * <p>A local resource is the host where the agent is installed. Local resources can be a a subnet, a VPC, an Availability Zone, or an Amazon Web Services service.</p>
42
43
  * @public
43
44
  */
44
45
  export interface MonitorLocalResource {
45
46
  /**
46
- * <p>The type of the local resource. Valid values are <code>AWS::EC2::VPC</code> <code>AWS::AvailabilityZone</code> or <code>AWS::EC2::Subnet</code>.</p>
47
+ * <p>The type of the local resource. Valid values are <code>AWS::EC2::VPC</code> <code>AWS::AvailabilityZone</code>, <code>AWS::EC2::Subnet</code>, or <code>AWS::Region</code>.</p>
47
48
  * @public
48
49
  */
49
50
  type: MonitorLocalResourceType | undefined;
50
51
  /**
51
- * <p>The identifier of the local resource, such as an ARN.</p>
52
+ * <p>The identifier of the local resource. For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this identifier is the AZ name, for example, us-west-2b.</p>
52
53
  * @public
53
54
  */
54
55
  identifier: string | undefined;
@@ -59,6 +60,7 @@ export interface MonitorLocalResource {
59
60
  */
60
61
  export declare const MonitorRemoteResourceType: {
61
62
  readonly AWS_AZ: "AWS::AvailabilityZone";
63
+ readonly AWS_REGION: "AWS::Region";
62
64
  readonly AWS_SERVICE: "AWS::AWSService";
63
65
  readonly AWS_SUBNET: "AWS::EC2::Subnet";
64
66
  readonly AWS_VPC: "AWS::EC2::VPC";
@@ -68,17 +70,17 @@ export declare const MonitorRemoteResourceType: {
68
70
  */
69
71
  export type MonitorRemoteResourceType = (typeof MonitorRemoteResourceType)[keyof typeof MonitorRemoteResourceType];
70
72
  /**
71
- * <p>A remote resource is the other endpoint in a network flow. That is, one endpoint is the local resource and the other is the remote resource. Remote resources can be a a subnet, a VPC, an Availability Zone, or an Amazon Web Services service. </p>
73
+ * <p>A remote resource is the other endpoint in a network flow. That is, one endpoint is the local resource and the other is the remote resource. Remote resources can be a a subnet, a VPC, an Availability Zone, an Amazon Web Services service, or an Amazon Web Services Region.</p> <p>When a remote resource is an Amazon Web Services Region, Network Flow Monitor provides network performance measurements up to the edge of the Region that you specify.</p>
72
74
  * @public
73
75
  */
74
76
  export interface MonitorRemoteResource {
75
77
  /**
76
- * <p>The type of the remote resource. Valid values are <code>AWS::EC2::VPC</code> <code>AWS::AvailabilityZone</code>, <code>AWS::EC2::Subnet</code>, or <code>AWS::AWSService</code>.</p>
78
+ * <p>The type of the remote resource. Valid values are <code>AWS::EC2::VPC</code> <code>AWS::AvailabilityZone</code>, <code>AWS::EC2::Subnet</code>, <code>AWS::AWSService</code>, or <code>AWS::Region</code>.</p>
77
79
  * @public
78
80
  */
79
81
  type: MonitorRemoteResourceType | undefined;
80
82
  /**
81
- * <p>The identifier of the remote resource, such as an ARN.</p>
83
+ * <p>The identifier of the remote resource. For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this identifier is the AZ name, for example, us-west-2b. For an Amazon Web Services Region , this identifier is the Region name, for example, us-west-2. </p>
82
84
  * @public
83
85
  */
84
86
  identifier: string | undefined;
@@ -93,12 +95,12 @@ export interface CreateMonitorInput {
93
95
  */
94
96
  monitorName: string | undefined;
95
97
  /**
96
- * <p>The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Relational Database Service (RDS)), the EC2 instance hosting the web service, which also runs the agent, is the local resource.</p>
98
+ * <p>The local resources to monitor. A local resource in a workload is the location of the host, or hosts, where the Network Flow Monitor agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Dynamo DB), the subnet with the EC2 instance that hosts the web service, which also runs the agent, is the local resource.</p> <p>Be aware that all local resources must belong to the current Region.</p>
97
99
  * @public
98
100
  */
99
101
  localResources: MonitorLocalResource[] | undefined;
100
102
  /**
101
- * <p>The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource.</p>
103
+ * <p>The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.</p> <p>When you specify remote resources, be aware that specific combinations of resources are allowed and others are not, including the following constraints:</p> <ul> <li> <p>All remote resources that you specify must all belong to a single Region.</p> </li> <li> <p>If you specify Amazon Web Services services as remote resources, any other remote resources that you specify must be in the current Region.</p> </li> <li> <p>When you specify a remote resource for another Region, you can only specify the <code>Region</code> resource type. You cannot specify a subnet, VPC, or Availability Zone in another Region.</p> </li> <li> <p>If you leave the <code>RemoteResources</code> parameter empty, the monitor will include all network flows that terminate in the current Region.</p> </li> </ul>
102
104
  * @public
103
105
  */
104
106
  remoteResources?: MonitorRemoteResource[] | undefined;
@@ -153,12 +155,12 @@ export interface CreateMonitorOutput {
153
155
  */
154
156
  monitorStatus: MonitorStatus | undefined;
155
157
  /**
156
- * <p>The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed. </p>
158
+ * <p>The local resources to monitor. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed. </p>
157
159
  * @public
158
160
  */
159
161
  localResources: MonitorLocalResource[] | undefined;
160
162
  /**
161
- * <p>The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource. The remote resource is identified by its ARN or an identifier.</p>
163
+ * <p>The remote resources to monitor. A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource. </p>
162
164
  * @public
163
165
  */
164
166
  remoteResources: MonitorRemoteResource[] | undefined;
@@ -272,33 +274,33 @@ export declare const TargetType: {
272
274
  */
273
275
  export type TargetType = (typeof TargetType)[keyof typeof TargetType];
274
276
  /**
275
- * <p>A target identifier is a pair of identifying information for a resource that is included in a target. A target identifier includes the target ID and the target type.</p>
277
+ * <p>A target identifier is a pair of identifying information for a scope that is included in a target. A target identifier is made up of a target ID and a target type. Currently the target ID is always an account ID and the target type is always ACCOUNT.</p>
276
278
  * @public
277
279
  */
278
280
  export interface TargetIdentifier {
279
281
  /**
280
- * <p>The identifier for a target.</p>
282
+ * <p>The identifier for a target, which is currently always an account ID .</p>
281
283
  * @public
282
284
  */
283
285
  targetId: TargetId | undefined;
284
286
  /**
285
- * <p>The type of a target. A target type is currently always <code>ACCOUNT</code> because a target is currently a single Amazon Web Services account.</p>
287
+ * <p>The type of a target. A target type is currently always <code>ACCOUNT</code>.</p>
286
288
  * @public
287
289
  */
288
290
  targetType: TargetType | undefined;
289
291
  }
290
292
  /**
291
- * <p>A target resource in a scope. The resource is identified by a Region and a target identifier, which includes a target ID and a target type.</p>
293
+ * <p>A target resource in a scope. The resource is identified by a Region and an account, defined by a target identifier. A target identifier is made up of a target ID (currently always an account ID) and a target type (currently always <code>ACCOUNT</code>).</p>
292
294
  * @public
293
295
  */
294
296
  export interface TargetResource {
295
297
  /**
296
- * <p>A target identifier is a pair of identifying information for a resource that is included in a target. A target identifier includes the target ID and the target type.</p>
298
+ * <p>A target identifier is a pair of identifying information for a scope. A target identifier is made up of a targetID (currently always an account ID) and a targetType (currently always an account).</p>
297
299
  * @public
298
300
  */
299
301
  targetIdentifier: TargetIdentifier | undefined;
300
302
  /**
301
- * <p>The Amazon Web Services Region where the target resource is located.</p>
303
+ * <p>The Amazon Web Services Region for the scope.</p>
302
304
  * @public
303
305
  */
304
306
  region: string | undefined;
@@ -308,7 +310,7 @@ export interface TargetResource {
308
310
  */
309
311
  export interface CreateScopeInput {
310
312
  /**
311
- * <p>The targets to define the scope to be monitored. Currently, a target is an Amazon Web Services account.</p>
313
+ * <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
312
314
  * @public
313
315
  */
314
316
  targets: TargetResource[] | undefined;
@@ -413,6 +415,7 @@ export declare const DestinationCategory: {
413
415
  readonly AMAZON_DYNAMODB: "AMAZON_DYNAMODB";
414
416
  readonly AMAZON_S3: "AMAZON_S3";
415
417
  readonly INTER_AZ: "INTER_AZ";
418
+ readonly INTER_REGION: "INTER_REGION";
416
419
  readonly INTER_VPC: "INTER_VPC";
417
420
  readonly INTRA_AZ: "INTRA_AZ";
418
421
  readonly UNCLASSIFIED: "UNCLASSIFIED";
@@ -451,12 +454,12 @@ export interface GetMonitorOutput {
451
454
  */
452
455
  monitorStatus: MonitorStatus | undefined;
453
456
  /**
454
- * <p>The local resources for this monitor.</p>
457
+ * <p>The local resources to monitor. A local resource in a workload is the location of the hosts where the Network Flow Monitor agent is installed. </p>
455
458
  * @public
456
459
  */
457
460
  localResources: MonitorLocalResource[] | undefined;
458
461
  /**
459
- * <p>The remote resources for this monitor.</p>
462
+ * <p>The remote resources to monitor. A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource. </p>
460
463
  * @public
461
464
  */
462
465
  remoteResources: MonitorRemoteResource[] | undefined;
@@ -553,7 +556,7 @@ export interface TraversedComponent {
553
556
  */
554
557
  componentType?: string | undefined;
555
558
  /**
556
- * <p>The Amazon Resource Name (ARN) of a tranversed component.</p>
559
+ * <p>The Amazon Resource Name (ARN) of a traversed component.</p>
557
560
  * @public
558
561
  */
559
562
  componentArn?: string | undefined;
@@ -609,7 +612,7 @@ export interface MonitorTopContributorsRow {
609
612
  */
610
613
  targetPort?: number | undefined;
611
614
  /**
612
- * <p>The destination category for a top contributors row. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
615
+ * <p>The destination category for a top contributors row. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_REGION</code>: Top contributor network flows between Regions (to the edge of another Region)</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
613
616
  * @public
614
617
  */
615
618
  destinationCategory?: DestinationCategory | undefined;
@@ -807,7 +810,7 @@ export interface WorkloadInsightsTopContributorsRow {
807
810
  */
808
811
  localRegion?: string | undefined;
809
812
  /**
810
- * <p>The identifier of a remote resource.</p>
813
+ * <p>The identifier of a remote resource. For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this identifier is the AZ name, for example, us-west-2b. For an Amazon Web Services Region , this identifier is the Region name, for example, us-west-2.</p>
811
814
  * @public
812
815
  */
813
816
  remoteIdentifier?: string | undefined;
@@ -1028,7 +1031,7 @@ export interface GetScopeOutput {
1028
1031
  */
1029
1032
  scopeArn: string | undefined;
1030
1033
  /**
1031
- * <p>The targets for a scope</p>
1034
+ * <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
1032
1035
  * @public
1033
1036
  */
1034
1037
  targets: TargetResource[] | undefined;
@@ -1059,7 +1062,7 @@ export interface ListMonitorsInput {
1059
1062
  monitorStatus?: MonitorStatus | undefined;
1060
1063
  }
1061
1064
  /**
1062
- * <p>A summary of information about a monitor, includ the ARN, the name, and the status.</p>
1065
+ * <p>A summary of information about a monitor, including the ARN, the name, and the status.</p>
1063
1066
  * @public
1064
1067
  */
1065
1068
  export interface MonitorSummary {
@@ -1115,7 +1118,7 @@ export interface ListScopesInput {
1115
1118
  */
1116
1119
  export interface ScopeSummary {
1117
1120
  /**
1118
- * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
1121
+ * <p>The identifier for the scope that includes the resources that you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for the accounts in a scope.</p>
1119
1122
  * @public
1120
1123
  */
1121
1124
  scopeId: string | undefined;
@@ -1189,7 +1192,7 @@ export interface StartQueryMonitorTopContributorsInput {
1189
1192
  */
1190
1193
  monitorName: string | undefined;
1191
1194
  /**
1192
- * <p>The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.</p>
1195
+ * <p>The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.</p>
1193
1196
  * @public
1194
1197
  */
1195
1198
  startTime: Date | undefined;
@@ -1204,7 +1207,7 @@ export interface StartQueryMonitorTopContributorsInput {
1204
1207
  */
1205
1208
  metricName: MonitorMetric | undefined;
1206
1209
  /**
1207
- * <p>The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AMAZON_S3</code>: Top contributor network flows to or from Amazon S3</p> </li> <li> <p> <code>AMAZON_DYNAMODB</code>: Top contributor network flows to or from Amazon Dynamo DB</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
1210
+ * <p>The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_REGION</code>: Top contributor network flows between Regions (to the edge of another Region)</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AMAZON_S3</code>: Top contributor network flows to or from Amazon S3</p> </li> <li> <p> <code>AMAZON_DYNAMODB</code>: Top contributor network flows to or from Amazon Dynamo DB</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
1208
1211
  * @public
1209
1212
  */
1210
1213
  destinationCategory: DestinationCategory | undefined;
@@ -1254,7 +1257,7 @@ export interface UpdateMonitorInput {
1254
1257
  */
1255
1258
  monitorName: string | undefined;
1256
1259
  /**
1257
- * <p>The local resources to add, as an array of resources with identifiers and types.</p>
1260
+ * <p>Additional local resources to specify network flows for a monitor, as an array of resources with identifiers and types. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed. </p>
1258
1261
  * @public
1259
1262
  */
1260
1263
  localResourcesToAdd?: MonitorLocalResource[] | undefined;
@@ -1264,12 +1267,12 @@ export interface UpdateMonitorInput {
1264
1267
  */
1265
1268
  localResourcesToRemove?: MonitorLocalResource[] | undefined;
1266
1269
  /**
1267
- * <p>The remove resources to add, as an array of resources with identifiers and types.</p>
1270
+ * <p>The remote resources to add, as an array of resources with identifiers and types.</p> <p>A remote resource is the other endpoint in the flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource. </p>
1268
1271
  * @public
1269
1272
  */
1270
1273
  remoteResourcesToAdd?: MonitorRemoteResource[] | undefined;
1271
1274
  /**
1272
- * <p>The remove resources to remove, as an array of resources with identifiers and types.</p>
1275
+ * <p>The remote resources to remove, as an array of resources with identifiers and types.</p> <p>A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource. </p>
1273
1276
  * @public
1274
1277
  */
1275
1278
  remoteResourcesToRemove?: MonitorRemoteResource[] | undefined;
@@ -1299,12 +1302,12 @@ export interface UpdateMonitorOutput {
1299
1302
  */
1300
1303
  monitorStatus: MonitorStatus | undefined;
1301
1304
  /**
1302
- * <p>The local resources updated for a monitor, as an array of resources with identifiers and types.</p>
1305
+ * <p>The local resources to monitor. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed. </p>
1303
1306
  * @public
1304
1307
  */
1305
1308
  localResources: MonitorLocalResource[] | undefined;
1306
1309
  /**
1307
- * <p>The remote resources updated for a monitor, as an array of resources with identifiers and types.</p>
1310
+ * <p>The remote resources updated for a monitor, as an array of resources with identifiers and types.</p> <p>A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.</p>
1308
1311
  * @public
1309
1312
  */
1310
1313
  remoteResources: MonitorRemoteResource[] | undefined;
@@ -1347,7 +1350,7 @@ export interface StartQueryWorkloadInsightsTopContributorsInput {
1347
1350
  */
1348
1351
  scopeId: string | undefined;
1349
1352
  /**
1350
- * <p>The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.</p>
1353
+ * <p>The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.</p>
1351
1354
  * @public
1352
1355
  */
1353
1356
  startTime: Date | undefined;
@@ -1362,7 +1365,7 @@ export interface StartQueryWorkloadInsightsTopContributorsInput {
1362
1365
  */
1363
1366
  metricName: WorkloadInsightsMetric | undefined;
1364
1367
  /**
1365
- * <p>The destination category for a top contributors row. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
1368
+ * <p>The destination category for a top contributors row. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_REGION</code>: Top contributor network flows between Regions (to the edge of another Region)</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
1366
1369
  * @public
1367
1370
  */
1368
1371
  destinationCategory: DestinationCategory | undefined;
@@ -1392,7 +1395,7 @@ export interface StartQueryWorkloadInsightsTopContributorsDataInput {
1392
1395
  */
1393
1396
  scopeId: string | undefined;
1394
1397
  /**
1395
- * <p>The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.</p>
1398
+ * <p>The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.</p>
1396
1399
  * @public
1397
1400
  */
1398
1401
  startTime: Date | undefined;
@@ -1407,7 +1410,7 @@ export interface StartQueryWorkloadInsightsTopContributorsDataInput {
1407
1410
  */
1408
1411
  metricName: WorkloadInsightsMetric | undefined;
1409
1412
  /**
1410
- * <p>The destination category for a top contributors. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
1413
+ * <p>The destination category for a top contributors. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_REGION</code>: Top contributor network flows between Regions (to the edge of another Region)</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
1411
1414
  * @public
1412
1415
  */
1413
1416
  destinationCategory: DestinationCategory | undefined;
@@ -14,6 +14,7 @@ export declare class ConflictException extends __BaseException {
14
14
  }
15
15
  export declare const MonitorLocalResourceType: {
16
16
  readonly AWS_AZ: "AWS::AvailabilityZone";
17
+ readonly AWS_REGION: "AWS::Region";
17
18
  readonly AWS_SUBNET: "AWS::EC2::Subnet";
18
19
  readonly AWS_VPC: "AWS::EC2::VPC";
19
20
  };
@@ -25,6 +26,7 @@ export interface MonitorLocalResource {
25
26
  }
26
27
  export declare const MonitorRemoteResourceType: {
27
28
  readonly AWS_AZ: "AWS::AvailabilityZone";
29
+ readonly AWS_REGION: "AWS::Region";
28
30
  readonly AWS_SERVICE: "AWS::AWSService";
29
31
  readonly AWS_SUBNET: "AWS::EC2::Subnet";
30
32
  readonly AWS_VPC: "AWS::EC2::VPC";
@@ -159,6 +161,7 @@ export declare const DestinationCategory: {
159
161
  readonly AMAZON_DYNAMODB: "AMAZON_DYNAMODB";
160
162
  readonly AMAZON_S3: "AMAZON_S3";
161
163
  readonly INTER_AZ: "INTER_AZ";
164
+ readonly INTER_REGION: "INTER_REGION";
162
165
  readonly INTER_VPC: "INTER_VPC";
163
166
  readonly INTRA_AZ: "INTRA_AZ";
164
167
  readonly UNCLASSIFIED: "UNCLASSIFIED";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-networkflowmonitor",
3
3
  "description": "AWS SDK for JavaScript Networkflowmonitor Client for Node.js, Browser and React Native",
4
- "version": "3.883.0",
4
+ "version": "3.887.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,42 +20,42 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.883.0",
24
- "@aws-sdk/credential-provider-node": "3.883.0",
25
- "@aws-sdk/middleware-host-header": "3.873.0",
26
- "@aws-sdk/middleware-logger": "3.876.0",
27
- "@aws-sdk/middleware-recursion-detection": "3.873.0",
28
- "@aws-sdk/middleware-user-agent": "3.883.0",
29
- "@aws-sdk/region-config-resolver": "3.873.0",
30
- "@aws-sdk/types": "3.862.0",
31
- "@aws-sdk/util-endpoints": "3.879.0",
32
- "@aws-sdk/util-user-agent-browser": "3.873.0",
33
- "@aws-sdk/util-user-agent-node": "3.883.0",
34
- "@smithy/config-resolver": "^4.1.5",
35
- "@smithy/core": "^3.9.2",
36
- "@smithy/fetch-http-handler": "^5.1.1",
37
- "@smithy/hash-node": "^4.0.5",
38
- "@smithy/invalid-dependency": "^4.0.5",
39
- "@smithy/middleware-content-length": "^4.0.5",
40
- "@smithy/middleware-endpoint": "^4.1.21",
41
- "@smithy/middleware-retry": "^4.1.22",
42
- "@smithy/middleware-serde": "^4.0.9",
43
- "@smithy/middleware-stack": "^4.0.5",
44
- "@smithy/node-config-provider": "^4.1.4",
45
- "@smithy/node-http-handler": "^4.1.1",
46
- "@smithy/protocol-http": "^5.1.3",
47
- "@smithy/smithy-client": "^4.5.2",
48
- "@smithy/types": "^4.3.2",
49
- "@smithy/url-parser": "^4.0.5",
50
- "@smithy/util-base64": "^4.0.0",
51
- "@smithy/util-body-length-browser": "^4.0.0",
52
- "@smithy/util-body-length-node": "^4.0.0",
53
- "@smithy/util-defaults-mode-browser": "^4.0.29",
54
- "@smithy/util-defaults-mode-node": "^4.0.29",
55
- "@smithy/util-endpoints": "^3.0.7",
56
- "@smithy/util-middleware": "^4.0.5",
57
- "@smithy/util-retry": "^4.0.7",
58
- "@smithy/util-utf8": "^4.0.0",
23
+ "@aws-sdk/core": "3.887.0",
24
+ "@aws-sdk/credential-provider-node": "3.887.0",
25
+ "@aws-sdk/middleware-host-header": "3.887.0",
26
+ "@aws-sdk/middleware-logger": "3.887.0",
27
+ "@aws-sdk/middleware-recursion-detection": "3.887.0",
28
+ "@aws-sdk/middleware-user-agent": "3.887.0",
29
+ "@aws-sdk/region-config-resolver": "3.887.0",
30
+ "@aws-sdk/types": "3.887.0",
31
+ "@aws-sdk/util-endpoints": "3.887.0",
32
+ "@aws-sdk/util-user-agent-browser": "3.887.0",
33
+ "@aws-sdk/util-user-agent-node": "3.887.0",
34
+ "@smithy/config-resolver": "^4.2.1",
35
+ "@smithy/core": "^3.11.0",
36
+ "@smithy/fetch-http-handler": "^5.2.1",
37
+ "@smithy/hash-node": "^4.1.1",
38
+ "@smithy/invalid-dependency": "^4.1.1",
39
+ "@smithy/middleware-content-length": "^4.1.1",
40
+ "@smithy/middleware-endpoint": "^4.2.1",
41
+ "@smithy/middleware-retry": "^4.2.1",
42
+ "@smithy/middleware-serde": "^4.1.1",
43
+ "@smithy/middleware-stack": "^4.1.1",
44
+ "@smithy/node-config-provider": "^4.2.1",
45
+ "@smithy/node-http-handler": "^4.2.1",
46
+ "@smithy/protocol-http": "^5.2.1",
47
+ "@smithy/smithy-client": "^4.6.1",
48
+ "@smithy/types": "^4.5.0",
49
+ "@smithy/url-parser": "^4.1.1",
50
+ "@smithy/util-base64": "^4.1.0",
51
+ "@smithy/util-body-length-browser": "^4.1.0",
52
+ "@smithy/util-body-length-node": "^4.1.0",
53
+ "@smithy/util-defaults-mode-browser": "^4.1.1",
54
+ "@smithy/util-defaults-mode-node": "^4.1.1",
55
+ "@smithy/util-endpoints": "^3.1.1",
56
+ "@smithy/util-middleware": "^4.1.1",
57
+ "@smithy/util-retry": "^4.1.1",
58
+ "@smithy/util-utf8": "^4.1.0",
59
59
  "@types/uuid": "^9.0.1",
60
60
  "tslib": "^2.6.2",
61
61
  "uuid": "^9.0.1"