UpdateEnvironmentMembership
Changes the settings of an existing environment member for an AWS Cloud9 development environment.
Request Syntax
{
"environmentId": "string
",
"permissions": "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 for the environment member whose settings you want to change.
Type: String
Pattern:
^[a-zA-Z0-9]{8,32}$
Required: Yes
- permissions
-
The replacement type of environment member permissions you want to associate with this environment member. Available values include:
-
read-only
: Has read-only access to the environment. -
read-write
: Has read-write access to the environment.
Type: String
Valid Values:
read-write | read-only
Required: Yes
-
- userArn
-
The Amazon Resource Name (ARN) of the environment member whose settings you want to change.
Type: String
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(iam|sts)::\d+:(root|(user\/[\w+=/:,.@-]{1,64}|federated-user\/[\w+=/:,.@-]{2,32}|assumed-role\/[\w+=:,.@-]{1,64}\/[\w+=,.@-]{1,64}))$
Required: Yes
Response Syntax
{
"membership": {
"environmentId": "string",
"lastAccess": number,
"permissions": "string",
"userArn": "string",
"userId": "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.
- membership
-
Information about the environment member whose settings were changed.
Type: EnvironmentMember object
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
Examples
Example
The following example changes membership status of the specified environment member for the specified AWS Cloud9 development environment.
Sample Request
POST / HTTP/1.1
Host: cloud9.<region>.amazonaws.com
Accept-Encoding: identity
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Length: <PayloadSizeBytes>
X-Amz-Target: AWSCloud9WorkspaceManagementService.UpdateEnvironmentMembership
X-Amz-Date: <Date>
{
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
"permissions": "read-only",
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
}
Sample Response
HTTP/1.1 200 OK
Date: <Date>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
x-amzn-RequestId: <RequestId>
Connection: Keep-alive
{
"membership": {
"environmentId": "8d9967e2f0624182b74e7690ad69eb31",
"permissions": "read-only",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
"userId": "AIDAJ3BA6O2FMJWCWXHEX"
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: