CodeStar / Client / delete_user_profile

delete_user_profile#

CodeStar.Client.delete_user_profile(**kwargs)#

Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.

Request Syntax

response = client.delete_user_profile(
    userArn='string'
)

Parameters:

userArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.

Return type:

dict

Returns:

Response Syntax

{
    'userArn': 'string'
}

Response Structure

(dict) –
- userArn (string) –
  
  The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.

Exceptions

CodeStar.Client.exceptions.ValidationException