NetworkSecurityManagerCustomerAPI / Client / list_scopes

list_scopes¶

NetworkSecurityManagerCustomerAPI.Client.list_scopes(**kwargs)¶

Lists the scopes in the account. You can filter the results by status and page through them using maxResults and nextToken.

Request Syntax

response = client.list_scopes(
    maxResults=123,
    nextToken='string',
    status='ACTIVE'|'DRAFT'|'DISABLED'
)

Parameters:

maxResults (integer) – The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
nextToken (string) – The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
status (string) – Filters the results by status: ACTIVE, DRAFT, or DISABLED.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'scopes': [
        {
            'scopeId': 'string',
            'scopeArn': 'string',
            'scopeName': 'string',
            'status': 'DRAFT'|'ACTIVE'|'DISABLED',
            'version': 'string',
            'hasPublishedVersion': True|False,
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
- scopes (list) –
  
  The list of scopes.
  - (dict) –
    
    Summary information about a scope.
    - scopeId (string) –
      
      The service-generated id of the scope.
    - scopeArn (string) –
      
      The Amazon Resource Name (ARN) of the scope.
    - scopeName (string) –
      
      The name of the scope.
    - status (string) –
      
      The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).
    - version (string) –
      
      The version of the resource.
    - hasPublishedVersion (boolean) –
      
      Specifies whether a published version of the resource exists.
    - updatedAt (datetime) –
      
      The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.

Exceptions

NetworkSecurityManagerCustomerAPI.Client.exceptions.ValidationException
NetworkSecurityManagerCustomerAPI.Client.exceptions.InternalServerException
NetworkSecurityManagerCustomerAPI.Client.exceptions.AccessDeniedException
NetworkSecurityManagerCustomerAPI.Client.exceptions.ThrottlingException