get_scope#

NetworkFlowMonitor.Client.get_scope(**kwargs)#

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

Request Syntax

response = client.get_scope(
    scopeId='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. A scope ID is returned from a CreateScope API call.

Return type:

dict

Returns:

Response Syntax

{
    'scopeId': 'string',
    'status': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED',
    'scopeArn': 'string',
    'targets': [
        {
            'targetIdentifier': {
                'targetId': {
                    'accountId': 'string'
                },
                'targetType': 'ACCOUNT'
            },
            'region': '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. A scope ID is returned from a CreateScope API call.
- status (string) –
  
  The status of 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.
- targets (list) –
  
  The targets for 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) –
      
      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) –
        
        The identifier for a target.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: accountId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        accountId (string) –
        
        The identifier for the account for a target.
      - targetType (string) –
        
        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) –
      
      The Amazon Web Services Region where the target resource is located.
- tags (dict) –
  
  The tags for a scope.
  - (string) –
    - (string) –

Exceptions

NetworkFlowMonitor.Client.exceptions.ServiceQuotaExceededException
NetworkFlowMonitor.Client.exceptions.ValidationException
NetworkFlowMonitor.Client.exceptions.ThrottlingException
NetworkFlowMonitor.Client.exceptions.AccessDeniedException
NetworkFlowMonitor.Client.exceptions.InternalServerException