B2BI / Client / list_profiles

list_profiles#

B2BI.Client.list_profiles(**kwargs)#

Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.

Request Syntax

response = client.list_profiles(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
maxResults (integer) – Specifies the maximum number of profiles to return.

Return type:

dict

Returns:

Response Syntax

{
    'profiles': [
        {
            'profileId': 'string',
            'name': 'string',
            'businessName': 'string',
            'logging': 'ENABLED'|'DISABLED',
            'logGroupName': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- profiles (list) –
  
  Returns an array of ProfileSummary objects.
  - (dict) –
    
    Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.
    - profileId (string) –
      
      Returns the unique, system-generated identifier for the profile.
    - name (string) –
      
      Returns the display name for profile.
    - businessName (string) –
      
      Returns the name for the business associated with this profile.
    - logging (string) –
      
      Specifies whether or not logging is enabled for this profile.
    - logGroupName (string) –
      
      Returns the name of the logging group.
    - createdAt (datetime) –
      
      Returns the timestamp for creation date and time of the profile.
    - modifiedAt (datetime) –
      
      Returns the timestamp that identifies the most recent date and time that the profile was modified.
- nextToken (string) –
  
  When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

Exceptions

B2BI.Client.exceptions.AccessDeniedException
B2BI.Client.exceptions.ValidationException
B2BI.Client.exceptions.ThrottlingException
B2BI.Client.exceptions.InternalServerException