{ "smithy": "2.0", "shapes": { "com.amazonaws.networkflowmonitor#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "
You don't have sufficient permission to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.networkflowmonitor#AccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.networkflowmonitor#AccountToAdd": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.networkflowmonitor#AccountId", "traits": { "smithy.api#documentation": "The ID of the account that you can add to the monitoring scope.
", "smithy.api#required": {} } }, "region": { "target": "com.amazonaws.networkflowmonitor#AwsRegion", "traits": { "smithy.api#documentation": "The Amazon Web Services Region of the traffic that Network Flow Monitor identified for the account.
", "smithy.api#required": {} } }, "membership": { "target": "com.amazonaws.networkflowmonitor#OrgMembershipStatus", "traits": { "smithy.api#documentation": "Whether the account is a member of the same organization as the account that owns the monitor. The membership status can be one of the following
IN_ORG: The account is a member of the same organization.
NOT_IN_ORG: The account isn't a member of the same organization.
UNKNOWN: Network Flow Monitor can't determine the organization membership of the account.
An account that you can add to the monitoring scope for a monitor, so that Network Flow Monitor can resolve the network paths for traffic to and from resources in the account.
" } }, "com.amazonaws.networkflowmonitor#AccountToAddList": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#AccountToAdd" } }, "com.amazonaws.networkflowmonitor#AdditionalFlowInfo": { "type": "structure", "members": { "network": { "target": "com.amazonaws.networkflowmonitor#Network", "traits": { "smithy.api#documentation": "The network that the remote address of the network flow belongs to.
" } }, "clientLocation": { "target": "com.amazonaws.networkflowmonitor#ClientLocation", "traits": { "smithy.api#documentation": "The location of the client for the network flow.
" } } }, "traits": { "smithy.api#documentation": "Additional information about a network flow, such as the network that the remote address belongs to and the location of the client.
" } }, "com.amazonaws.networkflowmonitor#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:.*$" } }, "com.amazonaws.networkflowmonitor#AvailabilityZone": { "type": "string" }, "com.amazonaws.networkflowmonitor#AwsRegion": { "type": "string" }, "com.amazonaws.networkflowmonitor#ClientLocation": { "type": "structure", "members": { "city": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The city where the client is located.
" } }, "subdivision": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The subdivision, such as a state or province, where the client is located.
" } }, "country": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The country where the client is located.
" } } }, "traits": { "smithy.api#documentation": "The geographic location of the client for a network flow.
" } }, "com.amazonaws.networkflowmonitor#Component": { "type": "string" }, "com.amazonaws.networkflowmonitor#ComponentType": { "type": "string" }, "com.amazonaws.networkflowmonitor#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The requested resource is in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.networkflowmonitor#CreateMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#CreateMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#CreateMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a monitor" }, "smithy.api#documentation": "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.
", "smithy.api#http": { "uri": "/monitors", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#CreateMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#required": {} } }, "localResources": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResources", "traits": { "smithy.api#documentation": "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.
Be aware that all local resources must belong to the current Region.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "remoteResources": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { "smithy.api#documentation": "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.
When you specify remote resources, be aware that specific combinations of resources are allowed and others are not, including the following constraints:
All remote resources that you specify must all belong to a single Region.
If you specify Amazon Web Services services as remote resources, any other remote resources that you specify must be in the current Region.
When you specify a remote resource for another Region, you can only specify the Region resource type. You cannot specify a subnet, VPC, or Availability Zone in another Region.
If you leave the RemoteResources parameter empty, the monitor will include all network flows that terminate in the current Region.
The Amazon Resource Name (ARN) of the scope for the monitor.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.networkflowmonitor#UuidString", "traits": { "smithy.api#documentation": "A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a monitor. You can add a maximum of 200 tags.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#CreateMonitorOutput": { "type": "structure", "members": { "monitorArn": { "target": "com.amazonaws.networkflowmonitor#MonitorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor.
", "smithy.api#required": {} } }, "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#required": {} } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of a monitor. The status can be one of the following
PENDING: The monitor is in the process of being created.
ACTIVE: The monitor is active.
INACTIVE: The monitor is inactive.
ERROR: Monitor creation failed due to an error.
DELETING: The monitor is in the process of being deleted.
The local resources to monitor. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed.
", "smithy.api#required": {} } }, "remoteResources": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the monitor was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The last date and time that the monitor was modified.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a monitor.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#CreatePerformanceMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#CreatePerformanceMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#CreatePerformanceMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a performance monitor" }, "smithy.api#documentation": "Create a performance monitor to monitor the traffic of the Amazon Virtual Private Clouds (VPCs) that you specify as targets, to determine whether the Amazon Web Services network is causing issues for your workloads. With a performance monitor, you can identify network degradation across paths between Availability Zones and across Amazon Web Services Regions.
", "smithy.api#http": { "uri": "/performance-monitors", "method": "POST", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#CreatePerformanceMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#required": {} } }, "scopeArn": { "target": "com.amazonaws.networkflowmonitor#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scope for the performance monitor.
" } }, "targets": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorTargets", "traits": { "smithy.api#documentation": "The resources to monitor. Each target identifies a resource, currently a VPC, for which you can track network performance. For a VPC, specify the VPC ARN.
", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.networkflowmonitor#UuidString", "traits": { "smithy.api#documentation": "A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. If the token matches a previous request, the service ignores the request without returning an error. Don't reuse the same client token for other API requests.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a performance monitor. You can add a maximum of 200 tags.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#CreatePerformanceMonitorOutput": { "type": "structure", "members": { "monitorArn": { "target": "com.amazonaws.networkflowmonitor#MonitorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the performance monitor.
", "smithy.api#required": {} } }, "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#required": {} } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of a performance monitor. The status can be one of the following
PENDING: The performance monitor is in the process of being created.
ACTIVE: The performance monitor is active.
INACTIVE: The performance monitor is inactive.
ERROR: The performance monitor can't be created or updated.
DELETING: The performance monitor is in the process of being deleted.
The type of resource that you monitor determines the type of the performance monitor.
", "smithy.api#required": {} } }, "targets": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorTargets", "traits": { "smithy.api#documentation": "The resources that the performance monitor tracks network performance for.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the performance monitor was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the performance monitor was last modified.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a performance monitor.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#CreateScope": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#CreateScopeInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#CreateScopeOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a scope" }, "smithy.api#documentation": "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.
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.
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:
Targets, which are arrays of targetResources.
Target resources, which are Region-targetIdentifier pairs.
Target identifiers, made up of a targetID (currently always an account ID) and a targetType (currently always an account).
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.
", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.networkflowmonitor#UuidString", "traits": { "smithy.api#documentation": "A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a scope. You can add a maximum of 200 tags.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#CreateScopeOutput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "The identifier for the scope that includes the resources you want to get metrics for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.networkflowmonitor#ScopeStatus", "traits": { "smithy.api#documentation": "The status for a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, FAILED, DEACTIVATING, or DEACTIVATED.
A status of DEACTIVATING means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of DEACTIVATED means that the deactivating process is complete.
The Amazon Resource Name (ARN) of the scope.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a scope.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#DeleteMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#DeleteMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#DeleteMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a monitor" }, "smithy.api#documentation": "Deletes a monitor in Network Flow Monitor.
", "smithy.api#http": { "uri": "/monitors/{monitorName}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#DeleteMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#DeleteMonitorOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#DeletePerformanceMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#DeletePerformanceMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#DeletePerformanceMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a performance monitor" }, "smithy.api#documentation": "Delete a performance monitor. Network Flow Monitor stops tracking network performance for the resources that the monitor included.
", "smithy.api#http": { "uri": "/performance-monitors/{monitorName}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#DeletePerformanceMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#DeletePerformanceMonitorOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#DeleteScope": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#DeleteScopeInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#DeleteScopeOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a scope" }, "smithy.api#documentation": "Deletes a scope that has been defined.
", "smithy.api#http": { "uri": "/scopes/{scopeId}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#DeleteScopeInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#DeleteScopeOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#DestinationCategory": { "type": "enum", "members": { "INTRA_AZ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTRA_AZ" } }, "INTER_AZ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTER_AZ" } }, "INTER_VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTER_VPC" } }, "UNCLASSIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNCLASSIFIED" } }, "AMAZON_S3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMAZON_S3" } }, "AMAZON_DYNAMODB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMAZON_DYNAMODB" } }, "INTER_REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTER_REGION" } }, "INTERNET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNET" } }, "AWS_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_SERVICE" } }, "LOCAL_ZONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOCAL_ZONE" } }, "TRANSIT_GATEWAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSIT_GATEWAY" } } } }, "com.amazonaws.networkflowmonitor#FilterOperator": { "type": "enum", "members": { "EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EQUALS" } }, "NOT_EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_EQUALS" } }, "IN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN" } }, "CONTAINS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTAINS" } } } }, "com.amazonaws.networkflowmonitor#FilterParameter": { "type": "structure", "members": { "field": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the field that you want to filter on. The fields that you can specify depend on the type of query.
", "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.networkflowmonitor#FilterOperator", "traits": { "smithy.api#documentation": "The operator to use to compare the field with the values that you specify. The operator can be one of the following
EQUALS: The field matches a single value.
NOT_EQUALS: The field doesn't match a single value.
IN: The field matches any one of several values.
CONTAINS: The field contains a value.
The values to compare the field with.
", "smithy.api#length": { "min": 1, "max": 10 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A filter for a query, to return a subset of the results.
" } }, "com.amazonaws.networkflowmonitor#FilterParameters": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#FilterParameter" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.networkflowmonitor#FilterValues": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.networkflowmonitor#GetMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#GetMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#GetMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get information about a monitor" }, "smithy.api#documentation": "Gets information about a monitor in Network Flow Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.
", "smithy.api#http": { "uri": "/monitors/{monitorName}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetMonitorOutput": { "type": "structure", "members": { "monitorArn": { "target": "com.amazonaws.networkflowmonitor#MonitorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor.
", "smithy.api#required": {} } }, "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#required": {} } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of a monitor. The status can be one of the following
PENDING: The monitor is in the process of being created.
ACTIVE: The monitor is active.
INACTIVE: The monitor is inactive.
ERROR: Monitor creation failed due to an error.
DELETING: The monitor is in the process of being deleted.
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.
", "smithy.api#required": {} } }, "remoteResources": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the monitor was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the monitor was last modified.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a monitor.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#GetMonitorScopeSuggestions": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#GetMonitorScopeSuggestionsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#GetMonitorScopeSuggestionsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get suggested accounts to add to a monitor's scope" }, "smithy.api#documentation": "Returns the accounts that are sending traffic to, or receiving traffic from, resources in a monitor, but that aren't included in the monitoring scope for the monitor. By adding the suggested accounts to your scope, you enable Network Flow Monitor to resolve the network paths for that traffic.
", "smithy.api#http": { "uri": "/monitor-scope-suggestions", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "accountsToAdd" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetMonitorScopeSuggestionsInput": { "type": "structure", "members": { "monitorArn": { "target": "com.amazonaws.networkflowmonitor#MonitorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor that you want to return scope suggestions for.
", "smithy.api#httpQuery": "monitorArn", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.networkflowmonitor#MaxResults", "traits": { "smithy.api#documentation": "The number of query results that you want to return with this call.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetMonitorScopeSuggestionsOutput": { "type": "structure", "members": { "status": { "target": "com.amazonaws.networkflowmonitor#ScopeCoverageStatus", "traits": { "smithy.api#documentation": "The coverage status of the monitoring scope for the monitor. The status can be one of the following
COMPLETE: The scope includes every account that sends traffic to, or receives traffic from, resources in the monitor.
INCOMPLETE: There are accounts that you can add to the scope.
PENDING: Network Flow Monitor is determining the coverage of the scope.
STALE: The coverage of the scope was last determined too long ago to be current.
The accounts that you can add to the monitoring scope, so that Network Flow Monitor can resolve the network paths for traffic to and from resources in those accounts.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } }, "updatedAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when Network Flow Monitor last determined the coverage of the monitoring scope.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#GetPerformanceMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#GetPerformanceMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#GetPerformanceMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get information about a performance monitor" }, "smithy.api#documentation": "Returns information about a performance monitor, including the resources that it monitors, its status, and the tags for the monitor.
", "smithy.api#http": { "uri": "/performance-monitors/{monitorName}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetPerformanceMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetPerformanceMonitorOutput": { "type": "structure", "members": { "monitorArn": { "target": "com.amazonaws.networkflowmonitor#MonitorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the performance monitor.
", "smithy.api#required": {} } }, "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#required": {} } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of a performance monitor. The status can be one of the following
PENDING: The performance monitor is in the process of being created.
ACTIVE: The performance monitor is active.
INACTIVE: The performance monitor is inactive.
ERROR: The performance monitor can't be created or updated.
DELETING: The performance monitor is in the process of being deleted.
The type of resource that you monitor determines the type of the performance monitor.
", "smithy.api#required": {} } }, "targets": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorTargets", "traits": { "smithy.api#documentation": "The resources that the performance monitor tracks network performance for.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the performance monitor was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the performance monitor was last modified.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a performance monitor.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsMonitorTopContributors": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsMonitorTopContributorsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsMonitorTopContributorsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get the results of a query that retrieves top contributors data for a monitor" }, "smithy.api#documentation": "Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.
Create a query ID for this call by calling the corresponding API call to start the query, StartQueryMonitorTopContributors. Use the scope ID that was returned for your account by CreateScope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
", "smithy.api#http": { "uri": "/monitors/{monitorName}/topContributorsQueries/{queryId}/results", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "topContributors" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsMonitorTopContributorsInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of query results that you want to return with this call.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsMonitorTopContributorsOutput": { "type": "structure", "members": { "unit": { "target": "com.amazonaws.networkflowmonitor#MetricUnit", "traits": { "smithy.api#documentation": "The units for a metric returned by the query.
" } }, "topContributors": { "target": "com.amazonaws.networkflowmonitor#MonitorTopContributorsRowList", "traits": { "smithy.api#documentation": "The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsPerformanceMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsPerformanceMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsPerformanceMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get the results of a query for a performance monitor" }, "smithy.api#documentation": "Returns the results of a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor. This call returns the top paths for a performance monitor.
Create a query with StartQueryPerformanceMonitor, and then use the query ID with this call to return the results.
", "smithy.api#http": { "uri": "/performance-monitors/{monitorName}/queries/{queryId}/results", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "data" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsPerformanceMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.networkflowmonitor#QueryMaxResults", "traits": { "smithy.api#documentation": "The number of query results that you want to return with this call.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsPerformanceMonitorOutput": { "type": "structure", "members": { "fields": { "target": "com.amazonaws.networkflowmonitor#QueryFields", "traits": { "smithy.api#documentation": "The columns that the query returns, in the order that the values for each row appear in data.
The results of the query. Each row contains the values for the columns that fields describes, in the same order.
The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributors": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get the results of a query that retrieves top contributors for workload insights" }, "smithy.api#documentation": "Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name.
This query returns the top contributors for a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see GetQueryResultsWorkloadInsightsTopContributorsData.
Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors. Use the scope ID that was returned for your account by CreateScope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
", "smithy.api#http": { "uri": "/workloadInsights/{scopeId}/topContributorsQueries/{queryId}/results", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "topContributors" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsData": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsDataInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsDataOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get the results of a query that retrieves top contributors data points for workload insights" }, "smithy.api#documentation": "Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a scope ID.
This query returns the data for top contributors for workload insights for a specific scope. Workload insights provide a high level view of network flow performance data collected by agents for a scope. To return just the top contributors, see GetQueryResultsWorkloadInsightsTopContributors.
Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData. Use the scope ID that was returned for your account by CreateScope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.
", "smithy.api#http": { "uri": "/workloadInsights/{scopeId}/topContributorsDataQueries/{queryId}/results", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "datapoints" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsDataInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of query results that you want to return with this call.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsDataOutput": { "type": "structure", "members": { "unit": { "target": "com.amazonaws.networkflowmonitor#MetricUnit", "traits": { "smithy.api#documentation": "The units for a metric returned by the query.
", "smithy.api#required": {} } }, "datapoints": { "target": "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsDataPoints", "traits": { "smithy.api#documentation": "The datapoints returned by the query.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of query results that you want to return with this call.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsOutput": { "type": "structure", "members": { "topContributors": { "target": "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsRowList", "traits": { "smithy.api#documentation": "The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#GetQueryStatusMonitorTopContributors": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#GetQueryStatusMonitorTopContributorsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#GetQueryStatusMonitorTopContributorsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get the status of a query that retrieves top contributors data for a monitor" }, "smithy.api#documentation": "Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors for a monitor.
When you create a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start (create) the query, StartQueryMonitorTopContributors.
When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.
The name of the monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetQueryStatusMonitorTopContributorsOutput": { "type": "structure", "members": { "status": { "target": "com.amazonaws.networkflowmonitor#QueryStatus", "traits": { "smithy.api#documentation": "When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.
QUEUED: The query is scheduled to run.
RUNNING: The query is in progress but not complete.
SUCCEEDED: The query completed sucessfully.
FAILED: The query failed due to an error.
CANCELED: The query was canceled.
Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor. This call returns the query status for the top paths for a performance monitor.
When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start (create) the query, StartQueryPerformanceMonitor.
The name of the performance monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetQueryStatusPerformanceMonitorOutput": { "type": "structure", "members": { "status": { "target": "com.amazonaws.networkflowmonitor#QueryStatus", "traits": { "smithy.api#documentation": "When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.
QUEUED: The query is scheduled to run.
RUNNING: The query is in progress but not complete.
SUCCEEDED: The query completed successfully.
FAILED: The query failed due to an error.
CANCELED: The query was canceled.
Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for workload insights.
When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
", "smithy.api#http": { "uri": "/workloadInsights/{scopeId}/topContributorsQueries/{queryId}/status", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetQueryStatusWorkloadInsightsTopContributorsData": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#GetQueryStatusWorkloadInsightsTopContributorsDataInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#GetQueryStatusWorkloadInsightsTopContributorsDataOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get the status of a query that retrieves top contributors data points for workload insights" }, "smithy.api#documentation": "Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors data for workload insights.
When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.
", "smithy.api#http": { "uri": "/workloadInsights/{scopeId}/topContributorsDataQueries/{queryId}/status", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetQueryStatusWorkloadInsightsTopContributorsDataInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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. A scope ID is returned from a CreateScope API call.
The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetQueryStatusWorkloadInsightsTopContributorsDataOutput": { "type": "structure", "members": { "status": { "target": "com.amazonaws.networkflowmonitor#QueryStatus", "traits": { "smithy.api#documentation": "The status of a query for top contributors data.
QUEUED: The query is scheduled to run.
RUNNING: The query is in progress but not complete.
SUCCEEDED: The query completed sucessfully.
FAILED: The query failed due to an error.
CANCELED: The query was canceled.
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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#GetQueryStatusWorkloadInsightsTopContributorsOutput": { "type": "structure", "members": { "status": { "target": "com.amazonaws.networkflowmonitor#QueryStatus", "traits": { "smithy.api#documentation": "When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.
QUEUED: The query is scheduled to run.
RUNNING: The query is in progress but not complete.
SUCCEEDED: The query completed sucessfully.
FAILED: The query failed due to an error.
CANCELED: The query was canceled.
Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.
", "smithy.api#http": { "uri": "/scopes/{scopeId}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#GetScopeInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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. A scope ID is returned from a CreateScope API call.
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. A scope ID is returned from a CreateScope API call.
The status for a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, FAILED, DEACTIVATING, or DEACTIVATED.
A status of DEACTIVATING means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of DEACTIVATED means that the deactivating process is complete.
The Amazon Resource Name (ARN) of the scope.
", "smithy.api#required": {} } }, "targets": { "target": "com.amazonaws.networkflowmonitor#TargetResourceList", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a scope.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#InstanceArn": { "type": "string" }, "com.amazonaws.networkflowmonitor#InstanceId": { "type": "string", "traits": { "smithy.api#pattern": "^i-[a-zA-Z0-9]{8,32}$" } }, "com.amazonaws.networkflowmonitor#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "An internal error occurred.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.networkflowmonitor#Iso8601Timestamp": { "type": "timestamp" }, "com.amazonaws.networkflowmonitor#KubernetesMetadata": { "type": "structure", "members": { "localServiceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The service name for a local resource.
" } }, "localPodName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the pod for a local resource.
" } }, "localPodNamespace": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The namespace of the pod for a local resource.
" } }, "remoteServiceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The service name for a remote resource.
" } }, "remotePodName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the pod for a remote resource.
" } }, "remotePodNamespace": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The namespace of the pod for a remote resource.
" } } }, "traits": { "smithy.api#documentation": "Meta data about Kubernetes resources.
" } }, "com.amazonaws.networkflowmonitor#Limit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.networkflowmonitor#ListMonitors": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#ListMonitorsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#ListMonitorsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list all monitors in an account and their statuses" }, "smithy.api#documentation": "List all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the STATUS parameter.
The token for the next set of results. You receive this token from a previous call.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.networkflowmonitor#MaxResults", "traits": { "smithy.api#documentation": "The number of query results that you want to return with this call.
", "smithy.api#httpQuery": "maxResults" } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of a monitor. The status can be one of the following
PENDING: The monitor is in the process of being created.
ACTIVE: The monitor is active.
INACTIVE: The monitor is inactive.
ERROR: Monitor creation failed due to an error.
DELETING: The monitor is in the process of being deleted.
The monitors that are in an account.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#ListPerformanceMonitors": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#ListPerformanceMonitorsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#ListPerformanceMonitorsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list performance monitors in an account" }, "smithy.api#documentation": "Returns a list of the performance monitors in an account. You can optionally return only the monitors that have a specific status or type.
Results are paginated. Use the nextToken parameter to return additional results.
The token for the next set of results. You receive this token from a previous call.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.networkflowmonitor#MaxResults", "traits": { "smithy.api#documentation": "The number of performance monitors that you want to return with this call. If you don't specify a value, the default is 25.
", "smithy.api#httpQuery": "maxResults" } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of the performance monitors that you want to return. If you don't specify a status, Network Flow Monitor returns performance monitors with any status.
", "smithy.api#httpQuery": "monitorStatus" } }, "monitorType": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorType", "traits": { "smithy.api#documentation": "The type of the performance monitors that you want to return. If you don't specify a type, Network Flow Monitor returns performance monitors of any type.
", "smithy.api#httpQuery": "monitorType" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#ListPerformanceMonitorsOutput": { "type": "structure", "members": { "monitors": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorSummaryList", "traits": { "smithy.api#documentation": "The performance monitors in the account.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#ListScopes": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#ListScopesInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#ListScopesOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get all scopes for an account" }, "smithy.api#documentation": "List all the scopes for an account.
", "smithy.api#http": { "uri": "/scopes", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "scopes" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#ListScopesInput": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.networkflowmonitor#MaxResults", "traits": { "smithy.api#documentation": "The number of query results that you want to return with this call.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#ListScopesOutput": { "type": "structure", "members": { "scopes": { "target": "com.amazonaws.networkflowmonitor#ScopeSummaryList", "traits": { "smithy.api#documentation": "The scopes returned by the call.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the tags for a resource" }, "smithy.api#documentation": "Returns all the tags for a resource.
", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#ListTagsForResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.networkflowmonitor#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "aws.api#data": "tagging", "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networkflowmonitor#ScopeResource", "ids": { "scopeId": "resourceArn" } }, { "resource": "com.amazonaws.networkflowmonitor#MonitorResource", "ids": { "monitorName": "resourceArn" } }, { "resource": "com.amazonaws.networkflowmonitor#PerformanceMonitorResource", "ids": { "monitorName": "resourceArn" } } ] } }, "com.amazonaws.networkflowmonitor#ListTagsForResourceOutput": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 25 } } }, "com.amazonaws.networkflowmonitor#MetricUnit": { "type": "enum", "members": { "SECONDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Seconds" } }, "MICROSECONDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Microseconds" } }, "MILLISECONDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Milliseconds" } }, "BYTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bytes" } }, "KILOBYTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Kilobytes" } }, "MEGABYTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Megabytes" } }, "GIGABYTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Gigabytes" } }, "TERABYTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terabytes" } }, "BITS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bits" } }, "KILOBITS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Kilobits" } }, "MEGABITS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Megabits" } }, "GIGABITS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Gigabits" } }, "TERABITS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terabits" } }, "PERCENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Percent" } }, "COUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Count" } }, "BYTES_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bytes/Second" } }, "KILOBYTES_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Kilobytes/Second" } }, "MEGABYTES_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Megabytes/Second" } }, "GIGABYTES_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Gigabytes/Second" } }, "TERABYTES_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terabytes/Second" } }, "BITS_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bits/Second" } }, "KILOBITS_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Kilobits/Second" } }, "MEGABITS_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Megabits/Second" } }, "GIGABITS_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Gigabits/Second" } }, "TERABITS_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terabits/Second" } }, "COUNT_PER_SECOND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Count/Second" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "None" } } } }, "com.amazonaws.networkflowmonitor#MonitorArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 512 }, "smithy.api#pattern": "^arn:.*$" } }, "com.amazonaws.networkflowmonitor#MonitorList": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#MonitorSummary" } }, "com.amazonaws.networkflowmonitor#MonitorLocalResource": { "type": "structure", "members": { "type": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResourceType", "traits": { "smithy.api#documentation": "The type of the local resource. Valid values are AWS::EC2::VPC AWS::AvailabilityZone, AWS::EC2::Subnet, AWS::EKS::Cluster, or AWS::Region.
The identifier of the local resource. The values you can specify are the following:
For a VPC, subnet or EKS cluster, this identifier is the VPC Amazon Resource Name (ARN), subnet ARN or cluster ARN.
For an Availability Zone, this identifier is the AZ name, for example, us-west-2b.
For a Region, this identifier is the Region name, for example, us-west-2.
A local resource is the host where the agent is installed. Local resources can be a a subnet, a VPC, an Availability Zone, an EKS cluster or an Amazon Web Services Region.
" } }, "com.amazonaws.networkflowmonitor#MonitorLocalResourceType": { "type": "enum", "members": { "AWS_VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EC2::VPC" } }, "AWS_AZ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::AvailabilityZone" } }, "AWS_SUBNET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EC2::Subnet" } }, "AWS_REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::Region" } }, "EKS_CLUSTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EKS::Cluster" } } } }, "com.amazonaws.networkflowmonitor#MonitorLocalResources": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResource" } }, "com.amazonaws.networkflowmonitor#MonitorMetric": { "type": "enum", "members": { "ROUND_TRIP_TIME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROUND_TRIP_TIME" } }, "TIMEOUTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMEOUTS" } }, "RETRANSMISSIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETRANSMISSIONS" } }, "DATA_TRANSFERRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DATA_TRANSFERRED" } } } }, "com.amazonaws.networkflowmonitor#MonitorRemoteResource": { "type": "structure", "members": { "type": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResourceType", "traits": { "smithy.api#documentation": "The type of the remote resource. Valid values are AWS::EC2::VPC AWS::AvailabilityZone, AWS::EC2::Subnet, AWS::AWSService, or AWS::Region.
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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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. The values you can specify are the following:
For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN.
For a service, this identifier is one of the following strings: S3 or DynamoDB.
For an Availability Zone, this identifier is the AZ name, for example, us-west-2b.
For a Region, this identifier is the Region name, for example, us-west-2.
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.
" } }, "com.amazonaws.networkflowmonitor#MonitorRemoteResourceType": { "type": "enum", "members": { "AWS_VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EC2::VPC" } }, "AWS_AZ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::AvailabilityZone" } }, "AWS_SUBNET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EC2::Subnet" } }, "AWS_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::AWSService" } }, "AWS_REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::Region" } } } }, "com.amazonaws.networkflowmonitor#MonitorRemoteResources": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResource" } }, "com.amazonaws.networkflowmonitor#MonitorResource": { "type": "resource", "identifiers": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName" } }, "put": { "target": "com.amazonaws.networkflowmonitor#CreateMonitor" }, "read": { "target": "com.amazonaws.networkflowmonitor#GetMonitor" }, "update": { "target": "com.amazonaws.networkflowmonitor#UpdateMonitor" }, "delete": { "target": "com.amazonaws.networkflowmonitor#DeleteMonitor" }, "list": { "target": "com.amazonaws.networkflowmonitor#ListMonitors" }, "operations": [ { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsMonitorTopContributors" }, { "target": "com.amazonaws.networkflowmonitor#GetQueryStatusMonitorTopContributors" }, { "target": "com.amazonaws.networkflowmonitor#StartQueryMonitorTopContributors" }, { "target": "com.amazonaws.networkflowmonitor#StopQueryMonitorTopContributors" } ], "traits": { "aws.api#arn": { "template": "monitor/{monitorName}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "monitor" } } }, "com.amazonaws.networkflowmonitor#MonitorStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } } }, "com.amazonaws.networkflowmonitor#MonitorSummary": { "type": "structure", "members": { "monitorArn": { "target": "com.amazonaws.networkflowmonitor#MonitorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor.
", "smithy.api#required": {} } }, "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#required": {} } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of a monitor. The status can be one of the following
PENDING: The monitor is in the process of being created.
ACTIVE: The monitor is active.
INACTIVE: The monitor is inactive.
ERROR: Monitor creation failed due to an error.
DELETING: The monitor is in the process of being deleted.
A summary of information about a monitor, including the ARN, the name, and the status.
" } }, "com.amazonaws.networkflowmonitor#MonitorTopContributorsRow": { "type": "structure", "members": { "localIp": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The IP address of the local resource for a top contributor network flow.
" } }, "snatIp": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The secure network address translation (SNAT) IP address for a top contributor network flow.
" } }, "localInstanceId": { "target": "com.amazonaws.networkflowmonitor#InstanceId", "traits": { "smithy.api#documentation": "The instance identifier for the local resource for a top contributor network flow.
" } }, "localVpcId": { "target": "com.amazonaws.networkflowmonitor#VpcId", "traits": { "smithy.api#documentation": "The VPC ID for a top contributor network flow for the local resource.
" } }, "localRegion": { "target": "com.amazonaws.networkflowmonitor#AwsRegion", "traits": { "smithy.api#documentation": "The Amazon Web Services Region for the local resource for a top contributor network flow.
" } }, "localAz": { "target": "com.amazonaws.networkflowmonitor#AvailabilityZone", "traits": { "smithy.api#documentation": "The Availability Zone for the local resource for a top contributor network flow.
" } }, "localSubnetId": { "target": "com.amazonaws.networkflowmonitor#SubnetId", "traits": { "smithy.api#documentation": "The subnet ID for the local resource for a top contributor network flow.
" } }, "targetPort": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The target port.
" } }, "destinationCategory": { "target": "com.amazonaws.networkflowmonitor#DestinationCategory", "traits": { "smithy.api#documentation": "The destination category for a top contributors row. Destination categories can be one of the following:
INTRA_AZ: Top contributor network flows within a single Availability Zone
INTER_AZ: Top contributor network flows between Availability Zones
INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)
INTER_VPC: Top contributor network flows between VPCs
AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services
UNCLASSIFIED: Top contributor network flows that do not have a bucket classification
The VPC ID for a top contributor network flow for the remote resource.
" } }, "remoteRegion": { "target": "com.amazonaws.networkflowmonitor#AwsRegion", "traits": { "smithy.api#documentation": "The Amazon Web Services Region for the remote resource for a top contributor network flow.
" } }, "remoteAz": { "target": "com.amazonaws.networkflowmonitor#AvailabilityZone", "traits": { "smithy.api#documentation": "The Availability Zone for the remote resource for a top contributor network flow.
" } }, "remoteSubnetId": { "target": "com.amazonaws.networkflowmonitor#SubnetId", "traits": { "smithy.api#documentation": "The subnet ID for the remote resource for a top contributor network flow.
" } }, "remoteInstanceId": { "target": "com.amazonaws.networkflowmonitor#InstanceId", "traits": { "smithy.api#documentation": "The instance identifier for the remote resource for a top contributor network flow.
" } }, "remoteIp": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The IP address of the remote resource for a top contributor network flow.
" } }, "dnatIp": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The destination network address translation (DNAT) IP address for a top contributor network flow.
" } }, "value": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The value of the metric for a top contributor network flow.
" } }, "traversedConstructs": { "target": "com.amazonaws.networkflowmonitor#TraversedConstructsList", "traits": { "smithy.api#documentation": "The constructs traversed by a network flow.
" } }, "kubernetesMetadata": { "target": "com.amazonaws.networkflowmonitor#KubernetesMetadata", "traits": { "smithy.api#documentation": "Meta data about Kubernetes resources.
" } }, "localInstanceArn": { "target": "com.amazonaws.networkflowmonitor#InstanceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a local resource.
" } }, "localSubnetArn": { "target": "com.amazonaws.networkflowmonitor#SubnetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a local subnet.
" } }, "localVpcArn": { "target": "com.amazonaws.networkflowmonitor#VpcArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a local VPC.
" } }, "remoteInstanceArn": { "target": "com.amazonaws.networkflowmonitor#InstanceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a remote resource.
" } }, "remoteSubnetArn": { "target": "com.amazonaws.networkflowmonitor#SubnetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a remote subnet.
" } }, "remoteVpcArn": { "target": "com.amazonaws.networkflowmonitor#VpcArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a remote VPC.
" } }, "additionalFlowInfo": { "target": "com.amazonaws.networkflowmonitor#AdditionalFlowInfo", "traits": { "smithy.api#documentation": "Additional information about the network flow, such as the network that the remote address belongs to and the location of the client.
" } } }, "traits": { "smithy.api#documentation": "A set of information for a top contributor network flow in a monitor. In a monitor, Network Flow Monitor returns information about the network flows for top contributors for each metric. Top contributors are network flows with the top values for each metric type.
" } }, "com.amazonaws.networkflowmonitor#MonitorTopContributorsRowList": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#MonitorTopContributorsRow" } }, "com.amazonaws.networkflowmonitor#Network": { "type": "structure", "members": { "asName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the autonomous system that the network belongs to.
" } }, "asNumber": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The autonomous system number (ASN) of the autonomous system that the network belongs to.
" } } }, "traits": { "smithy.api#documentation": "The network that an address in a network flow belongs to.
" } }, "com.amazonaws.networkflowmonitor#NetworkFlowMonitor": { "type": "service", "version": "2023-04-19", "operations": [ { "target": "com.amazonaws.networkflowmonitor#GetMonitorScopeSuggestions" }, { "target": "com.amazonaws.networkflowmonitor#ListTagsForResource" }, { "target": "com.amazonaws.networkflowmonitor#TagResource" }, { "target": "com.amazonaws.networkflowmonitor#UntagResource" } ], "resources": [ { "target": "com.amazonaws.networkflowmonitor#MonitorResource" }, { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorResource" }, { "target": "com.amazonaws.networkflowmonitor#ScopeResource" } ], "traits": { "aws.api#service": { "sdkId": "NetworkFlowMonitor", "arnNamespace": "networkflowmonitor", "cloudTrailEventSource": "networkflowmonitor.amazonaws.com" }, "aws.auth#sigv4": { "name": "networkflowmonitor" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.iam#defineConditionKeys": { "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tag key-value pairs attached to the resource", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" }, "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tag key-value pairs in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" }, "aws:TagKeys": { "type": "ArrayOfString", "documentation": "Filters access by the tag keys in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "Content-Type", "X-Amz-Requested-Operation" ] }, "smithy.api#documentation": "Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.
In addition, when you create a monitor, Network Flow Monitor provides 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. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts.
To learn more about Network Flow Monitor, see the Network Flow Monitor User Guide in the Amazon CloudWatch User Guide.
", "smithy.api#title": "Network Flow Monitor", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://networkflowmonitor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://networkflowmonitor.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://networkflowmonitor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://networkflowmonitor.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://networkflowmonitor-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://networkflowmonitor.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://networkflowmonitor-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://networkflowmonitor.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://networkflowmonitor-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://networkflowmonitor.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.networkflowmonitor#OrgMembershipStatus": { "type": "enum", "members": { "IN_ORG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_ORG" } }, "NOT_IN_ORG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_IN_ORG" } }, "UNKNOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN" } } } }, "com.amazonaws.networkflowmonitor#PerformanceMonitorQueryType": { "type": "enum", "members": { "TOP_PATHS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TOP_PATHS" } } } }, "com.amazonaws.networkflowmonitor#PerformanceMonitorResource": { "type": "resource", "identifiers": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName" } }, "put": { "target": "com.amazonaws.networkflowmonitor#CreatePerformanceMonitor" }, "read": { "target": "com.amazonaws.networkflowmonitor#GetPerformanceMonitor" }, "update": { "target": "com.amazonaws.networkflowmonitor#UpdatePerformanceMonitor" }, "delete": { "target": "com.amazonaws.networkflowmonitor#DeletePerformanceMonitor" }, "list": { "target": "com.amazonaws.networkflowmonitor#ListPerformanceMonitors" }, "operations": [ { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsPerformanceMonitor" }, { "target": "com.amazonaws.networkflowmonitor#GetQueryStatusPerformanceMonitor" }, { "target": "com.amazonaws.networkflowmonitor#StartQueryPerformanceMonitor" }, { "target": "com.amazonaws.networkflowmonitor#StopQueryPerformanceMonitor" } ], "traits": { "aws.api#arn": { "template": "performancemonitor/{monitorName}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "performancemonitor" } } }, "com.amazonaws.networkflowmonitor#PerformanceMonitorSummary": { "type": "structure", "members": { "monitorArn": { "target": "com.amazonaws.networkflowmonitor#MonitorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the performance monitor.
", "smithy.api#required": {} } }, "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#required": {} } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of a performance monitor. The status can be one of the following
PENDING: The performance monitor is in the process of being created.
ACTIVE: The performance monitor is active.
INACTIVE: The performance monitor is inactive.
ERROR: The performance monitor can't be created or updated.
DELETING: The performance monitor is in the process of being deleted.
The type of resource that you monitor determines the type of the performance monitor.
", "smithy.api#required": {} } }, "targets": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorTargets", "traits": { "smithy.api#documentation": "The resources that the performance monitor tracks network performance for.
" } } }, "traits": { "smithy.api#documentation": "A summary of information about a performance monitor, including the ARN, the name, the status, and the resources that it tracks network performance for.
" } }, "com.amazonaws.networkflowmonitor#PerformanceMonitorSummaryList": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorSummary" } }, "com.amazonaws.networkflowmonitor#PerformanceMonitorTarget": { "type": "structure", "members": { "type": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorTargetType", "traits": { "smithy.api#documentation": "The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC.
The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.
", "smithy.api#length": { "min": 20, "max": 128 }, "smithy.api#pattern": "^arn:.*$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A resource that a performance monitor tracks network performance for.
" } }, "com.amazonaws.networkflowmonitor#PerformanceMonitorTargetType": { "type": "enum", "members": { "AWS_VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EC2::VPC" } } } }, "com.amazonaws.networkflowmonitor#PerformanceMonitorTargets": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorTarget" } }, "com.amazonaws.networkflowmonitor#PerformanceMonitorType": { "type": "enum", "members": { "VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VPC" } } } }, "com.amazonaws.networkflowmonitor#QueryData": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#QueryRow" } }, "com.amazonaws.networkflowmonitor#QueryField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the column.
", "smithy.api#required": {} } }, "type": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The data type of the values in the column.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A column that a query returns, with its name and data type.
" } }, "com.amazonaws.networkflowmonitor#QueryFields": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#QueryField" }, "traits": { "smithy.api#documentation": "Generic column-based result format. Column names are returned in 'fields',\nrow data in 'data'. This allows different QueryTypes to return different\nschemas without needing separate API operations." } }, "com.amazonaws.networkflowmonitor#QueryLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.networkflowmonitor#QueryMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.networkflowmonitor#QueryRow": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#documentation": "A single result row: one value per column in 'fields', by position.\nA cell may be null when no value is available for that column.", "smithy.api#sparse": {} } }, "com.amazonaws.networkflowmonitor#QueryStatus": { "type": "enum", "members": { "QUEUED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUEUED" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } } } }, "com.amazonaws.networkflowmonitor#ResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.networkflowmonitor#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The request specifies a resource that doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.networkflowmonitor#ScopeCoverageStatus": { "type": "enum", "members": { "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "INCOMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INCOMPLETE" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "STALE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STALE" } } } }, "com.amazonaws.networkflowmonitor#ScopeId": { "type": "string" }, "com.amazonaws.networkflowmonitor#ScopeResource": { "type": "resource", "identifiers": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId" } }, "create": { "target": "com.amazonaws.networkflowmonitor#CreateScope" }, "read": { "target": "com.amazonaws.networkflowmonitor#GetScope" }, "update": { "target": "com.amazonaws.networkflowmonitor#UpdateScope" }, "delete": { "target": "com.amazonaws.networkflowmonitor#DeleteScope" }, "list": { "target": "com.amazonaws.networkflowmonitor#ListScopes" }, "operations": [ { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributors" }, { "target": "com.amazonaws.networkflowmonitor#GetQueryResultsWorkloadInsightsTopContributorsData" }, { "target": "com.amazonaws.networkflowmonitor#GetQueryStatusWorkloadInsightsTopContributors" }, { "target": "com.amazonaws.networkflowmonitor#GetQueryStatusWorkloadInsightsTopContributorsData" }, { "target": "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributors" }, { "target": "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributorsData" }, { "target": "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributors" }, { "target": "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsData" } ], "traits": { "aws.api#arn": { "template": "scope/{scopeId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "scope" } } }, "com.amazonaws.networkflowmonitor#ScopeStatus": { "type": "enum", "members": { "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "DEACTIVATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEACTIVATING" } }, "DEACTIVATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEACTIVATED" } } } }, "com.amazonaws.networkflowmonitor#ScopeSummary": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.networkflowmonitor#ScopeStatus", "traits": { "smithy.api#documentation": "The status for a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, FAILED, DEACTIVATING, or DEACTIVATED.
A status of DEACTIVATING means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of DEACTIVATED means that the deactivating process is complete.
The Amazon Resource Name (ARN) of the scope.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A summary of information about a scope, including the ARN, target ID, and Amazon Web Services Region.
" } }, "com.amazonaws.networkflowmonitor#ScopeSummaryList": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#ScopeSummary" } }, "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The request exceeded a service quota.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.networkflowmonitor#StartQueryMonitorTopContributors": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#StartQueryMonitorTopContributorsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#StartQueryMonitorTopContributorsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to start a query for retrieving top contributors data for a monitor" }, "smithy.api#documentation": "Create a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor. Specify the monitor that you want to create the query for.
The call returns a query ID that you can use with GetQueryResultsMonitorTopContributors to run the query and return the top contributors for a specific monitor.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.
", "smithy.api#http": { "uri": "/monitors/{monitorName}/topContributorsQueries", "method": "POST" } } }, "com.amazonaws.networkflowmonitor#StartQueryMonitorTopContributorsInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp that is the date and time end of the period that you want to retrieve results for with your query.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "metricName": { "target": "com.amazonaws.networkflowmonitor#MonitorMetric", "traits": { "smithy.api#documentation": "The metric that you want to query top contributors for. That is, you can specify a metric with this call and return the top contributor network flows, for that type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.
", "smithy.api#required": {} } }, "destinationCategory": { "target": "com.amazonaws.networkflowmonitor#DestinationCategory", "traits": { "smithy.api#documentation": "The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following:
INTRA_AZ: Top contributor network flows within a single Availability Zone
INTER_AZ: Top contributor network flows between Availability Zones
INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)
INTER_VPC: Top contributor network flows between VPCs
AMAZON_S3: Top contributor network flows to or from Amazon S3
AMAZON_DYNAMODB: Top contributor network flows to or from Amazon Dynamo DB
UNCLASSIFIED: Top contributor network flows that do not have a bucket classification
The maximum number of top contributors to return.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#StartQueryMonitorTopContributorsOutput": { "type": "structure", "members": { "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#StartQueryPerformanceMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#StartQueryPerformanceMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#StartQueryPerformanceMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to start a query for a performance monitor" }, "smithy.api#documentation": "Create a query that you can use with the Network Flow Monitor query interface to return the top paths for a performance monitor. Specify the performance monitor that you want to create the query for.
The call returns a query ID that you can use with GetQueryResultsPerformanceMonitor to return the results of the query.
Top paths in Network Flow Monitor are the network paths used by the traffic for the resources that a performance monitor tracks, ranked by impact score and then by traffic volume. Each path includes the traffic and round-trip time for the path, together with a breakdown of the subnet pairs that the path includes.
", "smithy.api#http": { "uri": "/performance-monitors/{monitorName}/queries", "method": "POST" } } }, "com.amazonaws.networkflowmonitor#StartQueryPerformanceMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp that is the date and time end of the period that you want to retrieve results for with your query.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "queryType": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorQueryType", "traits": { "smithy.api#documentation": "The type of query that you want to create. Specify TOP_PATHS to return the top paths for the performance monitor.
The filters for the query, to return a subset of the top paths. For a TOP_PATHS query, you can filter on the following fields:
local_az_id: The Availability Zone ID of the local end of a path
remote_az_id: The Availability Zone ID of the remote end of a path
impact_level: The impact level of a path
When you filter on impact_level, Network Flow Monitor compares the filter with the most severe impact level for the path over the time period of the query, and the traffic and round-trip time that Network Flow Monitor returns for each path still cover the full time period. Paths that have no impact data don't match an impact_level filter, including a NOT_EQUALS filter. Network Flow Monitor doesn't filter the subnet pairs within a path by impact level.
The maximum number of top paths that you want the query to return.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#StartQueryPerformanceMonitorOutput": { "type": "structure", "members": { "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributors": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributorsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributorsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to start a query for retrieving top contributors data for workload insights" }, "smithy.api#documentation": "Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to create a query for.
The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributors to run the query and return the top contributors for the workload insights for a scope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.
", "smithy.api#http": { "uri": "/workloadInsights/{scopeId}/topContributorsQueries", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributorsData": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributorsDataInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributorsDataOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to start a query for retrieving top contributors data points for workload insights" }, "smithy.api#documentation": "Create a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors. Specify the scope that you want to create a query for.
The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributorsData to run the query and return the data for the top contributors for the workload insights for a scope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
", "smithy.api#http": { "uri": "/workloadInsights/{scopeId}/topContributorsDataQueries", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributorsDataInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp that is the date and time end of the period that you want to retrieve results for with your query.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "metricName": { "target": "com.amazonaws.networkflowmonitor#WorkloadInsightsMetric", "traits": { "smithy.api#documentation": "The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.
", "smithy.api#required": {} } }, "destinationCategory": { "target": "com.amazonaws.networkflowmonitor#DestinationCategory", "traits": { "smithy.api#documentation": "The destination category for a top contributors. Destination categories can be one of the following:
INTRA_AZ: Top contributor network flows within a single Availability Zone
INTER_AZ: Top contributor network flows between Availability Zones
INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)
INTER_VPC: Top contributor network flows between VPCs
AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services
UNCLASSIFIED: Top contributor network flows that do not have a bucket classification
The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributorsInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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. A scope ID is returned from a CreateScope API call.
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.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp that is the date and time end of the period that you want to retrieve results for with your query.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "metricName": { "target": "com.amazonaws.networkflowmonitor#WorkloadInsightsMetric", "traits": { "smithy.api#documentation": "The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.
", "smithy.api#required": {} } }, "destinationCategory": { "target": "com.amazonaws.networkflowmonitor#DestinationCategory", "traits": { "smithy.api#documentation": "The destination category for a top contributors row. Destination categories can be one of the following:
INTRA_AZ: Top contributor network flows within a single Availability Zone
INTER_AZ: Top contributor network flows between Availability Zones
INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)
INTER_VPC: Top contributor network flows between VPCs
AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services
UNCLASSIFIED: Top contributor network flows that do not have a bucket classification
The maximum number of top contributors to return.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#StartQueryWorkloadInsightsTopContributorsOutput": { "type": "structure", "members": { "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#StopQueryMonitorTopContributors": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#StopQueryMonitorTopContributorsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#StopQueryMonitorTopContributorsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to stop a query for retrieving top contributors data for a monitor" }, "smithy.api#documentation": "Stop a top contributors query for a monitor. Specify the query that you want to stop by providing a query ID and a monitor name.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
", "smithy.api#http": { "uri": "/monitors/{monitorName}/topContributorsQueries/{queryId}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#StopQueryMonitorTopContributorsInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#StopQueryMonitorTopContributorsOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#StopQueryPerformanceMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#StopQueryPerformanceMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#StopQueryPerformanceMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to stop a query for a performance monitor" }, "smithy.api#documentation": "Stop a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor. Use the same query ID that you used for the corresponding API call to start the query, StartQueryPerformanceMonitor.
The name of the performance monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#StopQueryPerformanceMonitorOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributors": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to stop a query for retrieving top contributors for workload insights" }, "smithy.api#documentation": "Stop a top contributors query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
", "smithy.api#http": { "uri": "/workloadInsights/{scopeId}/topContributorsQueries/{queryId}", "method": "DELETE" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsData": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsDataInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsDataOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to stop a query for retrieving top contributors data points for workload insights" }, "smithy.api#documentation": "Stop a top contributors data query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
", "smithy.api#http": { "uri": "/workloadInsights/{scopeId}/topContributorsDataQueries/{queryId}", "method": "DELETE" }, "smithy.api#readonly": {} } }, "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsDataInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsDataOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#StopQueryWorkloadInsightsTopContributorsOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#SubnetArn": { "type": "string" }, "com.amazonaws.networkflowmonitor#SubnetId": { "type": "string", "traits": { "smithy.api#pattern": "^subnet-[a-zA-Z0-9]{8,32}$" } }, "com.amazonaws.networkflowmonitor#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.networkflowmonitor#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.networkflowmonitor#TagMap": { "type": "map", "key": { "target": "com.amazonaws.networkflowmonitor#TagKey" }, "value": { "target": "com.amazonaws.networkflowmonitor#TagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.networkflowmonitor#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#TagResourceInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#TagResourceOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to add tags to a resource" }, "smithy.api#documentation": "Adds a tag to a resource.
", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#TagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.networkflowmonitor#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a resource.
", "smithy.api#required": {} } } }, "traits": { "aws.api#data": "tagging", "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networkflowmonitor#ScopeResource", "ids": { "scopeId": "resourceArn" } }, { "resource": "com.amazonaws.networkflowmonitor#MonitorResource", "ids": { "monitorName": "resourceArn" } }, { "resource": "com.amazonaws.networkflowmonitor#PerformanceMonitorResource", "ids": { "monitorName": "resourceArn" } } ] } }, "com.amazonaws.networkflowmonitor#TagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.networkflowmonitor#TargetId": { "type": "union", "members": { "accountId": { "target": "com.amazonaws.networkflowmonitor#AccountId", "traits": { "smithy.api#documentation": "The identifier for the account for a target.
" } } }, "traits": { "smithy.api#documentation": "A target ID is an internally-generated identifier for a target. A target allows you to identify all the resources in a Network Flow Monitor scope. Currently, a target is always an Amazon Web Services account.
" } }, "com.amazonaws.networkflowmonitor#TargetIdentifier": { "type": "structure", "members": { "targetId": { "target": "com.amazonaws.networkflowmonitor#TargetId", "traits": { "smithy.api#documentation": "The identifier for a target, which is currently always an account ID .
", "smithy.api#required": {} } }, "targetType": { "target": "com.amazonaws.networkflowmonitor#TargetType", "traits": { "smithy.api#documentation": "The type of a target. A target type is currently always ACCOUNT.
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.
" } }, "com.amazonaws.networkflowmonitor#TargetResource": { "type": "structure", "members": { "targetIdentifier": { "target": "com.amazonaws.networkflowmonitor#TargetIdentifier", "traits": { "smithy.api#documentation": "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).
", "smithy.api#required": {} } }, "region": { "target": "com.amazonaws.networkflowmonitor#AwsRegion", "traits": { "smithy.api#documentation": "The Amazon Web Services Region for the scope.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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 ACCOUNT).
The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.networkflowmonitor#TraversedComponent": { "type": "structure", "members": { "componentId": { "target": "com.amazonaws.networkflowmonitor#Component", "traits": { "smithy.api#documentation": "The identifier for the traversed component.
" } }, "componentType": { "target": "com.amazonaws.networkflowmonitor#ComponentType", "traits": { "smithy.api#documentation": "The type of component that was traversed.
" } }, "componentArn": { "target": "com.amazonaws.networkflowmonitor#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a traversed component.
" } }, "serviceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The service name for the traversed component.
" } } }, "traits": { "smithy.api#documentation": "A section of the network that a network flow has traveled through.
" } }, "com.amazonaws.networkflowmonitor#TraversedConstructsList": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#TraversedComponent" } }, "com.amazonaws.networkflowmonitor#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#UntagResourceInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#UntagResourceOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to remove tags from a resource" }, "smithy.api#documentation": "Removes a tag from a resource.
", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#UntagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.networkflowmonitor#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.networkflowmonitor#TagKeyList", "traits": { "smithy.api#documentation": "Keys that you specified when you tagged a resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "aws.api#data": "tagging", "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networkflowmonitor#ScopeResource", "ids": { "scopeId": "resourceArn" } }, { "resource": "com.amazonaws.networkflowmonitor#MonitorResource", "ids": { "monitorName": "resourceArn" } }, { "resource": "com.amazonaws.networkflowmonitor#PerformanceMonitorResource", "ids": { "monitorName": "resourceArn" } } ] } }, "com.amazonaws.networkflowmonitor#UntagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#UpdateMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#UpdateMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#UpdateMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a monitor" }, "smithy.api#documentation": "Update a monitor to add or remove local or remote resources.
", "smithy.api#http": { "uri": "/monitors/{monitorName}", "method": "PATCH" }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#UpdateMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "localResourcesToAdd": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResources", "traits": { "smithy.api#documentation": "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.
" } }, "localResourcesToRemove": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResources", "traits": { "smithy.api#documentation": "The local resources to remove, as an array of resources with identifiers and types.
" } }, "remoteResourcesToAdd": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { "smithy.api#documentation": "The remote resources to add, as an array of resources with identifiers and types.
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.
" } }, "remoteResourcesToRemove": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { "smithy.api#documentation": "The remote resources to remove, as an array of resources with identifiers and types.
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.
" } }, "clientToken": { "target": "com.amazonaws.networkflowmonitor#UuidString", "traits": { "smithy.api#documentation": "A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#UpdateMonitorOutput": { "type": "structure", "members": { "monitorArn": { "target": "com.amazonaws.networkflowmonitor#MonitorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor.
", "smithy.api#required": {} } }, "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the monitor.
", "smithy.api#required": {} } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of a monitor. The status can be one of the following
PENDING: The monitor is in the process of being created.
ACTIVE: The monitor is active.
INACTIVE: The monitor is inactive.
ERROR: Monitor creation failed due to an error.
DELETING: The monitor is in the process of being deleted.
The local resources to monitor. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed.
", "smithy.api#required": {} } }, "remoteResources": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { "smithy.api#documentation": "The remote resources updated for a monitor, as an array of resources with identifiers and types.
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.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the monitor was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The last date and time that the monitor was modified.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a monitor.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#UpdatePerformanceMonitor": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#UpdatePerformanceMonitorInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#UpdatePerformanceMonitorOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a performance monitor" }, "smithy.api#documentation": "Update a performance monitor, to add or remove the resources that the monitor tracks network performance for.
", "smithy.api#http": { "uri": "/performance-monitors/{monitorName}", "method": "PATCH" }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#UpdatePerformanceMonitorInput": { "type": "structure", "members": { "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "targetsToAdd": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorTargets", "traits": { "smithy.api#documentation": "The resources to add to the performance monitor.
", "smithy.api#length": { "max": 100 } } }, "targetsToRemove": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorTargets", "traits": { "smithy.api#documentation": "The resources to remove from the performance monitor.
", "smithy.api#length": { "max": 100 } } }, "clientToken": { "target": "com.amazonaws.networkflowmonitor#UuidString", "traits": { "smithy.api#documentation": "A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. If the token matches a previous request, the service ignores the request without returning an error. Don't reuse the same client token for other API requests.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#UpdatePerformanceMonitorOutput": { "type": "structure", "members": { "monitorArn": { "target": "com.amazonaws.networkflowmonitor#MonitorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the performance monitor.
", "smithy.api#required": {} } }, "monitorName": { "target": "com.amazonaws.networkflowmonitor#ResourceName", "traits": { "smithy.api#documentation": "The name of the performance monitor.
", "smithy.api#required": {} } }, "monitorStatus": { "target": "com.amazonaws.networkflowmonitor#MonitorStatus", "traits": { "smithy.api#documentation": "The status of a performance monitor. The status can be one of the following
PENDING: The performance monitor is in the process of being created.
ACTIVE: The performance monitor is active.
INACTIVE: The performance monitor is inactive.
ERROR: The performance monitor can't be created or updated.
DELETING: The performance monitor is in the process of being deleted.
The type of resource that you monitor determines the type of the performance monitor.
", "smithy.api#required": {} } }, "targets": { "target": "com.amazonaws.networkflowmonitor#PerformanceMonitorTargets", "traits": { "smithy.api#documentation": "The resources that the performance monitor tracks network performance for.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the performance monitor was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "com.amazonaws.networkflowmonitor#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The date and time when the performance monitor was last modified.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a performance monitor.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#UpdateScope": { "type": "operation", "input": { "target": "com.amazonaws.networkflowmonitor#UpdateScopeInput" }, "output": { "target": "com.amazonaws.networkflowmonitor#UpdateScopeOutput" }, "errors": [ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, { "target": "com.amazonaws.networkflowmonitor#ConflictException" }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, { "target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException" }, { "target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkflowmonitor#ThrottlingException" }, { "target": "com.amazonaws.networkflowmonitor#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a scope" }, "smithy.api#documentation": "Update a scope to add or remove 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.
", "smithy.api#http": { "uri": "/scopes/{scopeId}", "method": "PATCH" }, "smithy.api#idempotent": {} } }, "com.amazonaws.networkflowmonitor#UpdateScopeInput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "resourcesToAdd": { "target": "com.amazonaws.networkflowmonitor#TargetResourceList", "traits": { "smithy.api#documentation": "A list of resources to add to a scope.
", "smithy.api#length": { "min": 1, "max": 1000 } } }, "resourcesToDelete": { "target": "com.amazonaws.networkflowmonitor#TargetResourceList", "traits": { "smithy.api#documentation": "A list of resources to delete from a scope.
", "smithy.api#length": { "min": 1, "max": 1000 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networkflowmonitor#UpdateScopeOutput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.networkflowmonitor#ScopeStatus", "traits": { "smithy.api#documentation": "The status for a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, FAILED, DEACTIVATING, or DEACTIVATED.
A status of DEACTIVATING means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of DEACTIVATED means that the deactivating process is complete.
The Amazon Resource Name (ARN) of the scope.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.networkflowmonitor#TagMap", "traits": { "smithy.api#documentation": "The tags for a scope.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networkflowmonitor#UuidString": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, "com.amazonaws.networkflowmonitor#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "Invalid request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.networkflowmonitor#VpcArn": { "type": "string" }, "com.amazonaws.networkflowmonitor#VpcId": { "type": "string", "traits": { "smithy.api#pattern": "^vpc-[a-zA-Z0-9]{8,32}$" } }, "com.amazonaws.networkflowmonitor#WorkloadInsightsMetric": { "type": "enum", "members": { "TIMEOUTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMEOUTS" } }, "RETRANSMISSIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETRANSMISSIONS" } }, "DATA_TRANSFERRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DATA_TRANSFERRED" } } } }, "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsDataPoint": { "type": "structure", "members": { "timestamps": { "target": "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsTimestampsList", "traits": { "smithy.api#documentation": "An array of the timestamps for the data point.
", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsValuesList", "traits": { "smithy.api#documentation": "The values for the data point.
", "smithy.api#required": {} } }, "label": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The label identifying the data point.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A data point for a top contributor network flow in a scope. Network Flow Monitor returns information about the network flows with the top values for each metric type, which are called top contributors.
" } }, "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsDataPoints": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsDataPoint" } }, "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsRow": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.networkflowmonitor#AccountId", "traits": { "smithy.api#documentation": "The account ID for a specific row of data.
" } }, "localSubnetId": { "target": "com.amazonaws.networkflowmonitor#SubnetId", "traits": { "smithy.api#documentation": "The subnet identifier for the local resource.
" } }, "localAz": { "target": "com.amazonaws.networkflowmonitor#AvailabilityZone", "traits": { "smithy.api#documentation": "The identifier for the Availability Zone where the local resource is located.
" } }, "localVpcId": { "target": "com.amazonaws.networkflowmonitor#VpcId", "traits": { "smithy.api#documentation": "The identifier for the VPC for the local resource.
" } }, "localRegion": { "target": "com.amazonaws.networkflowmonitor#AwsRegion", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the local resource is located.
" } }, "remoteIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "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.
" } }, "value": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The value for a metric.
" } }, "localSubnetArn": { "target": "com.amazonaws.networkflowmonitor#SubnetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a local subnet.
" } }, "localVpcArn": { "target": "com.amazonaws.networkflowmonitor#VpcArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a local VPC.
" } } }, "traits": { "smithy.api#documentation": "A row for a top contributor for a scope.
" } }, "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsRowList": { "type": "list", "member": { "target": "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsRow" } }, "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsTimestampsList": { "type": "list", "member": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } } }, "com.amazonaws.networkflowmonitor#WorkloadInsightsTopContributorsValuesList": { "type": "list", "member": { "target": "smithy.api#Double" } } } }