WellArchitected / Client / list_profiles

list_profiles#

WellArchitected.Client.list_profiles(**kwargs)#

List profiles.

Request Syntax

response = client.list_profiles(
    ProfileNamePrefix='string',
    ProfileOwnerType='SELF'|'SHARED',
    NextToken='string',
    MaxResults=123
)

Parameters:

ProfileNamePrefix (string) – Prefix for profile name.
ProfileOwnerType (string) – Profile owner type.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.

Return type:

dict

Returns:

Response Syntax

{
    'ProfileSummaries': [
        {
            'ProfileArn': 'string',
            'ProfileVersion': 'string',
            'ProfileName': 'string',
            'ProfileDescription': 'string',
            'Owner': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ProfileSummaries (list) –
  
  Profile summaries.
  - (dict) –
    
    Summary of a profile.
    - ProfileArn (string) –
      
      The profile ARN.
    - ProfileVersion (string) –
      
      The profile version.
    - ProfileName (string) –
      
      The profile name.
    - ProfileDescription (string) –
      
      The profile description.
    - Owner (string) –
      
      An Amazon Web Services account ID.
    - CreatedAt (datetime) –
      
      The date and time recorded.
    - UpdatedAt (datetime) –
      
      The date and time recorded.
- NextToken (string) –
  
  The token to use to retrieve the next set of results.

Exceptions

WellArchitected.Client.exceptions.ValidationException
WellArchitected.Client.exceptions.InternalServerException
WellArchitected.Client.exceptions.AccessDeniedException
WellArchitected.Client.exceptions.ThrottlingException