NetworkFlowMonitor / Client / update_scope

update_scope#

NetworkFlowMonitor.Client.update_scope(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_scope(
    scopeId='string',
    resourcesToAdd=[
        {
            'targetIdentifier': {
                'targetId': {
                    'accountId': 'string'
                },
                'targetType': 'ACCOUNT'
            },
            'region': 'string'
        },
    ],
    resourcesToDelete=[
        {
            'targetIdentifier': {
                'targetId': {
                    'accountId': 'string'
                },
                'targetType': 'ACCOUNT'
            },
            'region': 'string'
        },
    ]
)
Parameters:

  • scopeId (string) –

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

  • resourcesToAdd (list) –

    A list of resources to add to a scope.

    • (dict) –

      A target resource in a scope. The resource is identified by a Region and a target identifier, which includes a target ID and a target type.

      • targetIdentifier (dict) – [REQUIRED]

        A target identifier is a pair of identifying information for a resource that is included in a target. A target identifier includes the target ID and the target type.

        • targetId (dict) – [REQUIRED]

          The identifier for a target.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: accountId.

          • accountId (string) –

            The identifier for the account for a target.

        • targetType (string) – [REQUIRED]

          The type of a target. A target type is currently always ACCOUNT because a target is currently a single Amazon Web Services account.

      • region (string) – [REQUIRED]

        The Amazon Web Services Region where the target resource is located.

  • resourcesToDelete (list) –

    A list of resources to delete from a scope.

    • (dict) –

      A target resource in a scope. The resource is identified by a Region and a target identifier, which includes a target ID and a target type.

      • targetIdentifier (dict) – [REQUIRED]

        A target identifier is a pair of identifying information for a resource that is included in a target. A target identifier includes the target ID and the target type.

        • targetId (dict) – [REQUIRED]

          The identifier for a target.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: accountId.

          • accountId (string) –

            The identifier for the account for a target.

        • targetType (string) – [REQUIRED]

          The type of a target. A target type is currently always ACCOUNT because a target is currently a single Amazon Web Services account.

      • region (string) – [REQUIRED]

        The Amazon Web Services Region where the target resource is located.

Return type:

dict

Returns:

Response Syntax

{
    'scopeId': 'string',
    'status': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED',
    'scopeArn': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • scopeId (string) –

      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.

    • status (string) –

      The status for a call to update a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, or FAILED.

    • scopeArn (string) –

      The Amazon Resource Name (ARN) of the scope.

    • tags (dict) –

      The tags for a scope.

      • (string) –

        • (string) –

Exceptions