CreateMonitor

$result = $client->createMonitor([/* ... */]);
$promise = $client->createMonitorAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createMonitor([
    'clientToken' => '<string>',
    'localResources' => [ // REQUIRED
        [
            'identifier' => '<string>', // REQUIRED
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::Region', // REQUIRED
        ],
        // ...
    ],
    'monitorName' => '<string>', // REQUIRED
    'remoteResources' => [
        [
            'identifier' => '<string>', // REQUIRED
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::AWSService|AWS::Region', // REQUIRED
        ],
        // ...
    ],
    'scopeArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'localResources' => [
        [
            'identifier' => '<string>',
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::Region',
        ],
        // ...
    ],
    'modifiedAt' => <DateTime>,
    'monitorArn' => '<string>',
    'monitorName' => '<string>',
    'monitorStatus' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING',
    'remoteResources' => [
        [
            'identifier' => '<string>',
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::AWSService|AWS::Region',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ConflictException:

The requested resource is in use.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

CreateScope

$result = $client->createScope([/* ... */]);
$promise = $client->createScopeAsync([/* ... */]);

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).

Parameter Syntax

$result = $client->createScope([
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
    'targets' => [ // REQUIRED
        [
            'region' => '<string>', // REQUIRED
            'targetIdentifier' => [ // REQUIRED
                'targetId' => [ // REQUIRED
                    'accountId' => '<string>',
                ],
                'targetType' => 'ACCOUNT', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'scopeArn' => '<string>',
    'scopeId' => '<string>',
    'status' => 'SUCCEEDED|IN_PROGRESS|FAILED|DEACTIVATING|DEACTIVATED',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ConflictException:

The requested resource is in use.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

DeleteMonitor

$result = $client->deleteMonitor([/* ... */]);
$promise = $client->deleteMonitorAsync([/* ... */]);

Deletes a monitor in Network Flow Monitor.

Parameter Syntax

$result = $client->deleteMonitor([
    'monitorName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ConflictException:

The requested resource is in use.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

DeleteScope

$result = $client->deleteScope([/* ... */]);
$promise = $client->deleteScopeAsync([/* ... */]);

Deletes a scope that has been defined.

Parameter Syntax

$result = $client->deleteScope([
    'scopeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ConflictException:

The requested resource is in use.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

GetMonitor

$result = $client->getMonitor([/* ... */]);
$promise = $client->getMonitorAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getMonitor([
    'monitorName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'localResources' => [
        [
            'identifier' => '<string>',
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::Region',
        ],
        // ...
    ],
    'modifiedAt' => <DateTime>,
    'monitorArn' => '<string>',
    'monitorName' => '<string>',
    'monitorStatus' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING',
    'remoteResources' => [
        [
            'identifier' => '<string>',
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::AWSService|AWS::Region',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

GetQueryResultsMonitorTopContributors

$result = $client->getQueryResultsMonitorTopContributors([/* ... */]);
$promise = $client->getQueryResultsMonitorTopContributorsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getQueryResultsMonitorTopContributors([
    'maxResults' => <integer>,
    'monitorName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'queryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'topContributors' => [
        [
            'destinationCategory' => 'INTRA_AZ|INTER_AZ|INTER_VPC|UNCLASSIFIED|AMAZON_S3|AMAZON_DYNAMODB|INTER_REGION',
            'dnatIp' => '<string>',
            'kubernetesMetadata' => [
                'localPodName' => '<string>',
                'localPodNamespace' => '<string>',
                'localServiceName' => '<string>',
                'remotePodName' => '<string>',
                'remotePodNamespace' => '<string>',
                'remoteServiceName' => '<string>',
            ],
            'localAz' => '<string>',
            'localInstanceArn' => '<string>',
            'localInstanceId' => '<string>',
            'localIp' => '<string>',
            'localRegion' => '<string>',
            'localSubnetArn' => '<string>',
            'localSubnetId' => '<string>',
            'localVpcArn' => '<string>',
            'localVpcId' => '<string>',
            'remoteAz' => '<string>',
            'remoteInstanceArn' => '<string>',
            'remoteInstanceId' => '<string>',
            'remoteIp' => '<string>',
            'remoteRegion' => '<string>',
            'remoteSubnetArn' => '<string>',
            'remoteSubnetId' => '<string>',
            'remoteVpcArn' => '<string>',
            'remoteVpcId' => '<string>',
            'snatIp' => '<string>',
            'targetPort' => <integer>,
            'traversedConstructs' => [
                [
                    'componentArn' => '<string>',
                    'componentId' => '<string>',
                    'componentType' => '<string>',
                    'serviceName' => '<string>',
                ],
                // ...
            ],
            'value' => <integer>,
        ],
        // ...
    ],
    'unit' => 'Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None',
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

GetQueryResultsWorkloadInsightsTopContributors

$result = $client->getQueryResultsWorkloadInsightsTopContributors([/* ... */]);
$promise = $client->getQueryResultsWorkloadInsightsTopContributorsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getQueryResultsWorkloadInsightsTopContributors([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queryId' => '<string>', // REQUIRED
    'scopeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'topContributors' => [
        [
            'accountId' => '<string>',
            'localAz' => '<string>',
            'localRegion' => '<string>',
            'localSubnetArn' => '<string>',
            'localSubnetId' => '<string>',
            'localVpcArn' => '<string>',
            'localVpcId' => '<string>',
            'remoteIdentifier' => '<string>',
            'value' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

GetQueryResultsWorkloadInsightsTopContributorsData

$result = $client->getQueryResultsWorkloadInsightsTopContributorsData([/* ... */]);
$promise = $client->getQueryResultsWorkloadInsightsTopContributorsDataAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getQueryResultsWorkloadInsightsTopContributorsData([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queryId' => '<string>', // REQUIRED
    'scopeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'datapoints' => [
        [
            'label' => '<string>',
            'timestamps' => [<DateTime>, ...],
            'values' => [<float>, ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'unit' => 'Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None',
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

GetQueryStatusMonitorTopContributors

$result = $client->getQueryStatusMonitorTopContributors([/* ... */]);
$promise = $client->getQueryStatusMonitorTopContributorsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getQueryStatusMonitorTopContributors([
    'monitorName' => '<string>', // REQUIRED
    'queryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'QUEUED|RUNNING|SUCCEEDED|FAILED|CANCELED',
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

GetQueryStatusWorkloadInsightsTopContributors

$result = $client->getQueryStatusWorkloadInsightsTopContributors([/* ... */]);
$promise = $client->getQueryStatusWorkloadInsightsTopContributorsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getQueryStatusWorkloadInsightsTopContributors([
    'queryId' => '<string>', // REQUIRED
    'scopeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'QUEUED|RUNNING|SUCCEEDED|FAILED|CANCELED',
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

GetQueryStatusWorkloadInsightsTopContributorsData

$result = $client->getQueryStatusWorkloadInsightsTopContributorsData([/* ... */]);
$promise = $client->getQueryStatusWorkloadInsightsTopContributorsDataAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getQueryStatusWorkloadInsightsTopContributorsData([
    'queryId' => '<string>', // REQUIRED
    'scopeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'QUEUED|RUNNING|SUCCEEDED|FAILED|CANCELED',
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

GetScope

$result = $client->getScope([/* ... */]);
$promise = $client->getScopeAsync([/* ... */]);

Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.

Parameter Syntax

$result = $client->getScope([
    'scopeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'scopeArn' => '<string>',
    'scopeId' => '<string>',
    'status' => 'SUCCEEDED|IN_PROGRESS|FAILED|DEACTIVATING|DEACTIVATED',
    'tags' => ['<string>', ...],
    'targets' => [
        [
            'region' => '<string>',
            'targetIdentifier' => [
                'targetId' => [
                    'accountId' => '<string>',
                ],
                'targetType' => 'ACCOUNT',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

ListMonitors

$result = $client->listMonitors([/* ... */]);
$promise = $client->listMonitorsAsync([/* ... */]);

List all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the STATUS parameter.

Parameter Syntax

$result = $client->listMonitors([
    'maxResults' => <integer>,
    'monitorStatus' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'monitors' => [
        [
            'monitorArn' => '<string>',
            'monitorName' => '<string>',
            'monitorStatus' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

ListScopes

$result = $client->listScopes([/* ... */]);
$promise = $client->listScopesAsync([/* ... */]);

List all the scopes for an account.

Parameter Syntax

$result = $client->listScopes([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'scopes' => [
        [
            'scopeArn' => '<string>',
            'scopeId' => '<string>',
            'status' => 'SUCCEEDED|IN_PROGRESS|FAILED|DEACTIVATING|DEACTIVATED',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns all the tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ConflictException:

The requested resource is in use.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

StartQueryMonitorTopContributors

$result = $client->startQueryMonitorTopContributors([/* ... */]);
$promise = $client->startQueryMonitorTopContributorsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startQueryMonitorTopContributors([
    'destinationCategory' => 'INTRA_AZ|INTER_AZ|INTER_VPC|UNCLASSIFIED|AMAZON_S3|AMAZON_DYNAMODB|INTER_REGION', // REQUIRED
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'limit' => <integer>,
    'metricName' => 'ROUND_TRIP_TIME|TIMEOUTS|RETRANSMISSIONS|DATA_TRANSFERRED', // REQUIRED
    'monitorName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'queryId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

StartQueryWorkloadInsightsTopContributors

$result = $client->startQueryWorkloadInsightsTopContributors([/* ... */]);
$promise = $client->startQueryWorkloadInsightsTopContributorsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startQueryWorkloadInsightsTopContributors([
    'destinationCategory' => 'INTRA_AZ|INTER_AZ|INTER_VPC|UNCLASSIFIED|AMAZON_S3|AMAZON_DYNAMODB|INTER_REGION', // REQUIRED
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'limit' => <integer>,
    'metricName' => 'TIMEOUTS|RETRANSMISSIONS|DATA_TRANSFERRED', // REQUIRED
    'scopeId' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'queryId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

StartQueryWorkloadInsightsTopContributorsData

$result = $client->startQueryWorkloadInsightsTopContributorsData([/* ... */]);
$promise = $client->startQueryWorkloadInsightsTopContributorsDataAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startQueryWorkloadInsightsTopContributorsData([
    'destinationCategory' => 'INTRA_AZ|INTER_AZ|INTER_VPC|UNCLASSIFIED|AMAZON_S3|AMAZON_DYNAMODB|INTER_REGION', // REQUIRED
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'metricName' => 'TIMEOUTS|RETRANSMISSIONS|DATA_TRANSFERRED', // REQUIRED
    'scopeId' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'queryId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

StopQueryMonitorTopContributors

$result = $client->stopQueryMonitorTopContributors([/* ... */]);
$promise = $client->stopQueryMonitorTopContributorsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopQueryMonitorTopContributors([
    'monitorName' => '<string>', // REQUIRED
    'queryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

StopQueryWorkloadInsightsTopContributors

$result = $client->stopQueryWorkloadInsightsTopContributors([/* ... */]);
$promise = $client->stopQueryWorkloadInsightsTopContributorsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopQueryWorkloadInsightsTopContributors([
    'queryId' => '<string>', // REQUIRED
    'scopeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

StopQueryWorkloadInsightsTopContributorsData

$result = $client->stopQueryWorkloadInsightsTopContributorsData([/* ... */]);
$promise = $client->stopQueryWorkloadInsightsTopContributorsDataAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopQueryWorkloadInsightsTopContributorsData([
    'queryId' => '<string>', // REQUIRED
    'scopeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds a tag to a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ConflictException:

The requested resource is in use.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ConflictException:

The requested resource is in use.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

UpdateMonitor

$result = $client->updateMonitor([/* ... */]);
$promise = $client->updateMonitorAsync([/* ... */]);

Update a monitor to add or remove local or remote resources.

Parameter Syntax

$result = $client->updateMonitor([
    'clientToken' => '<string>',
    'localResourcesToAdd' => [
        [
            'identifier' => '<string>', // REQUIRED
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::Region', // REQUIRED
        ],
        // ...
    ],
    'localResourcesToRemove' => [
        [
            'identifier' => '<string>', // REQUIRED
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::Region', // REQUIRED
        ],
        // ...
    ],
    'monitorName' => '<string>', // REQUIRED
    'remoteResourcesToAdd' => [
        [
            'identifier' => '<string>', // REQUIRED
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::AWSService|AWS::Region', // REQUIRED
        ],
        // ...
    ],
    'remoteResourcesToRemove' => [
        [
            'identifier' => '<string>', // REQUIRED
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::AWSService|AWS::Region', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'localResources' => [
        [
            'identifier' => '<string>',
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::Region',
        ],
        // ...
    ],
    'modifiedAt' => <DateTime>,
    'monitorArn' => '<string>',
    'monitorName' => '<string>',
    'monitorStatus' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING',
    'remoteResources' => [
        [
            'identifier' => '<string>',
            'type' => 'AWS::EC2::VPC|AWS::AvailabilityZone|AWS::EC2::Subnet|AWS::AWSService|AWS::Region',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.

UpdateScope

$result = $client->updateScope([/* ... */]);
$promise = $client->updateScopeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateScope([
    'resourcesToAdd' => [
        [
            'region' => '<string>', // REQUIRED
            'targetIdentifier' => [ // REQUIRED
                'targetId' => [ // REQUIRED
                    'accountId' => '<string>',
                ],
                'targetType' => 'ACCOUNT', // REQUIRED
            ],
        ],
        // ...
    ],
    'resourcesToDelete' => [
        [
            'region' => '<string>', // REQUIRED
            'targetIdentifier' => [ // REQUIRED
                'targetId' => [ // REQUIRED
                    'accountId' => '<string>',
                ],
                'targetType' => 'ACCOUNT', // REQUIRED
            ],
        ],
        // ...
    ],
    'scopeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'scopeArn' => '<string>',
    'scopeId' => '<string>',
    'status' => 'SUCCEEDED|IN_PROGRESS|FAILED|DEACTIVATING|DEACTIVATED',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeded a service quota.

ResourceNotFoundException:

The request specifies a resource that doesn't exist.

ConflictException:

The requested resource is in use.

ValidationException:

Invalid request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

An internal error occurred.