describe_user_profiles

describe_user_profiles(**kwargs)

Describe specified users.

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.describe_user_profiles(
    IamUserArns=[
        'string',
    ]
)

Parameters

IamUserArns (list) --

An array of IAM or federated user ARNs that identify the users to be described.

• (string) --

Return type

dict

Returns

Response Syntax

{
    'UserProfiles': [
        {
            'IamUserArn': 'string',
            'Name': 'string',
            'SshUsername': 'string',
            'SshPublicKey': 'string',
            'AllowSelfManagement': True|False
        },
    ]
}

Response Structure

• (dict) --

  Contains the response to a DescribeUserProfiles request.

  • UserProfiles (list) --

    A Users object that describes the specified users.

    • (dict) --

      Describes a user's SSH information.

      • IamUserArn (string) --

        The user's IAM ARN.

      • Name (string) --

        The user's name.

      • SshUsername (string) --

        The user's SSH user name.

      • SshPublicKey (string) --

        The user's SSH public key.

      • AllowSelfManagement (boolean) --

        Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

Exceptions

• OpsWorks.Client.exceptions.ValidationException
• OpsWorks.Client.exceptions.ResourceNotFoundException