Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425123120.1 KB

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

get/scopes/{scopeId}

Path parameters

scopeIdstring required

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 <code>CreateScope</code> API call.

Response

Success

scopeIdstring required

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 <code>CreateScope</code> API call.

status'SUCCEEDED' | 'IN_PROGRESS' | 'FAILED' | 'DEACTIVATING' | 'DEACTIVATED' required
<p>The status for a scope. The status can be one of the following: <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, <code>FAILED</code>, <code>DEACTIVATING</code>, or <code>DEACTIVATED</code>.</p> <p>A status of <code>DEACTIVATING</code> 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 <code>DEACTIVATED</code> means that the deactivating process is complete.</p>
scopeArnstring required

The Amazon Resource Name (ARN) of the scope.

tagsobject

The tags for a scope.