Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class UpdateEnvironmentMembershipCommandProtected

Changes the settings of an existing environment member for an Cloud9 development environment.

Example

Use a bare-bones client and the command you need to make an API call.

import { Cloud9Client, UpdateEnvironmentMembershipCommand } from "@aws-sdk/client-cloud9"; // ES Modules import
// const { Cloud9Client, UpdateEnvironmentMembershipCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import
const client = new Cloud9Client(config);
const input = { // UpdateEnvironmentMembershipRequest
environmentId: "STRING_VALUE", // required
userArn: "STRING_VALUE", // required
permissions: "read-write" || "read-only", // required
};
const command = new UpdateEnvironmentMembershipCommand(input);
const response = await client.send(command);
// { // UpdateEnvironmentMembershipResult
// membership: { // EnvironmentMember
// permissions: "owner" || "read-write" || "read-only", // required
// userId: "STRING_VALUE", // required
// userArn: "STRING_VALUE", // required
// environmentId: "STRING_VALUE", // required
// lastAccess: new Date("TIMESTAMP"),
// },
// };

Param

UpdateEnvironmentMembershipCommandInput

Returns

UpdateEnvironmentMembershipCommandOutput

See

Throws

BadRequestException (client fault)

The target request is invalid.

Throws

ConflictException (client fault)

A conflict occurred.

Throws

ForbiddenException (client fault)

An access permissions issue occurred.

Throws

InternalServerErrorException (server fault)

An internal server error occurred.

Throws

LimitExceededException (client fault)

A service limit was exceeded.

Throws

NotFoundException (client fault)

The target resource cannot be found.

Throws

TooManyRequestsException (client fault)

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

Throws

Cloud9ServiceException

Base exception class for all service exceptions from Cloud9 service.

Example

UpdateEnvironmentMembership

//
const input = {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "read-only",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
};
const command = new UpdateEnvironmentMembershipCommand(input);
const response = await client.send(command);
/* response ==
{
"membership": {
"environmentId": "8d9967e2f0624182b74e7690ad69eb31",
"permissions": "read-only",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
"userId": "AIDAJ3BA6O2FMJWCWXHEX"
}
}
*/
// example id: updateenvironmentmembership-1516823876645

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods