Menu
AWS Cloud9
API Reference (API Version 2017-09-23)

DeleteEnvironmentMembership

Deletes an environment member from an AWS Cloud9 development environment.

Request Syntax

{ "environmentId": "string", "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.

environmentId

The ID of the environment to delete the environment member from.

Type: String

Pattern: ^[a-zA-Z0-9]{8,32}$

Required: Yes

userArn

The Amazon Resource Name (ARN) of the environment member to delete from the environment.

Type: String

Pattern: arn:aws:(iam|sts)::\d+:(root|user|federated-user|assumed-role)\/?\S*

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The target request is invalid.

HTTP Status Code: 400

ConflictException

A conflict occurred.

HTTP Status Code: 400

ForbiddenException

An access permissions issue occurred.

HTTP Status Code: 400

InternalServerErrorException

An internal server error occurred.

HTTP Status Code: 500

LimitExceededException

A service limit was exceeded.

HTTP Status Code: 400

NotFoundException

The target resource cannot be found.

HTTP Status Code: 400

TooManyRequestsException

Too many service requests were made over the given time period.

HTTP Status Code: 400

Example

The following example deletes the specified environment member from the specified AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1 Host: cloud9.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AWSCloud9WorkspaceManagementService.DeleteEnvironmentMembership User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20180123/us-east-2/cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=3c6bbcb8EXAMPLE Content-Type: application/x-amz-json-1.1 X-Amz-Date: 20180123T231959Z Content-Length: ... { "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" }

Sample Response

HTTP/1.1 200 OK Date: Tue, 23 Jan 2018 23:20:00 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 2 x-amzn-RequestId: eef3d67a-0093-11e8-a800-95fabd28ffEX Connection: Keep-alive {}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: