DeleteUserProfile
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
{
"userArn": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- userArn
-
The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 95.
Pattern:
^arn:aws:iam::\d{12}:user(?:(\u002F)|(\u002F[\u0021-\u007E]+\u002F))[\w+=,.@-]+$
Required: Yes
Response Syntax
{
"userArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- userArn
-
The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 95.
Pattern:
^arn:aws:iam::\d{12}:user(?:(\u002F)|(\u002F[\u0021-\u007E]+\u002F))[\w+=,.@-]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ValidationException
-
The specified input is either not valid, or it could not be validated.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeleteUserProfile.
Sample Request
POST / HTTP/1.1
Host: codestar.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 54
X-Amz-Target: CodeStar_20170419.DeleteUserProfile
X-Amz-Date: 20170406T014701Z
User-Agent: aws-cli/1.11.36 Python/2.7.9 Windows/7 botocore/1.4.93
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AIDACKCEVSQ6C2EXAMPLE/20170406/us-east-1/codestar/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=c25ddcd5EXAMPLE
{"userArn": "arn:aws:iam::111111111111:user/DemoUser"}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: ef0e59a1-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 53
Date: Thu, 06 Apr 2017 01:47:03 GMT
{"userArn":"arn:aws:iam::111111111111:user/DemoUser"}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: