NetworkFlowMonitor / Client / list_scopes

list_scopes

NetworkFlowMonitor.Client.list_scopes(**kwargs)

List all the scopes for an account.

See also: AWS API Documentation

Request Syntax

response = client.list_scopes(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token for the next set of results. You receive this token from a previous call.

  • maxResults (integer) – The number of query results that you want to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'scopes': [
        {
            'scopeId': 'string',
            'status': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED'|'DEACTIVATING'|'DEACTIVATED',
            'scopeArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • scopes (list) –

      The scopes returned by the call.

      • (dict) –

        A summary of information about a scope, including the ARN, target ID, and Amazon Web Services Region.

        • scopeId (string) –

          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.

        • status (string) –

          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.

        • scopeArn (string) –

          The Amazon Resource Name (ARN) of the scope.

    • nextToken (string) –

      The token for the next set of results. You receive this token from a previous call.

Exceptions