Get Development Environment Memberships for a User

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa", "permissions": "owner",

"userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "userId": "ABCDEFGHIJKLMNOPQRSTU"

} ] }

Get Development Environment Memberships for a User

The following example gets AWS Cloud9 development environment membership information for the speciﬁed user.

Sample Request

POST / HTTP/1.1

Host: cloud9.us-east-2.amazonaws.com Accept-Encoding: identity

Content-Type: application/x-amz-json-1.1

X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironmentMemberships X-Amz-Date: 20180123T231447Z

Authorization: AWS4-HMAC-SHA256 Credential=XXXXXXXXEXAMPLE/XXXXXXXX/us-east-2/

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=XXXXXXXXEXAMPLE

Content-Length: 55

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 { "userArn": "arn:aws:iam::123456789012:user/MyDemoUser"

}

Sample Response

HTTP/1.1 200 OK

Date: Tue, 23 Jan 2018 23:14:48 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 1118

x-amzn-RequestId: 34d50be5-0093-11e8-a7e1-d3b8935decEX Connection: Keep-alive

{ "memberships": [ {

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa", "lastAccess": 1.516403173E9,

"permissions": "owner",

"userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "userId": "XXXXXXXXXXXXXXXXXX"

}, {

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa", "lastAccess": 1.516405159E9,

"permissions": "owner",

"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",

See Also

"userId": "ABCDEFGHIJKLMNOPQRSTUV"

} ]}

Request Syntax

{

"environmentIds": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 58).

The request accepts the following data in JSON format.

environmentIds (p. 25)

The IDs of individual environments to get information about.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

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

"managedCredentialsStatus": "string", "name": "string",

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

The following data is returned in JSON format by the service.

Errors

environments (p. 25)

Information about the environments that are returned.

Type: Array of Environment (p. 52) objects

Errors

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

BadRequestException

The target request is invalid.

HTTP Status Code: 400 ConﬂictException

A conﬂict 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 gets information about the speciﬁed AWS Cloud9 development environments.

Sample Request

POST / HTTP/1.1

See Also

Host: cloud9.us-east-2.amazonaws.com Accept-Encoding: identity

X-Amz-Date: 20180123T225030Z Content-Length: 92

Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20180123/us-east-2/

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=ca32a303EXAMPLE

Content-Type: application/x-amz-json-1.1

X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironments User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 { "environmentIds": [

"8d9967e2f0624182b74e7690ad69ebEX", "349c86d4579e4e7298d500ff57a6b2EX"

] }

Sample Response

HTTP/1.1 200 OK

Date: Tue, 23 Jan 2018 22:50:31 GMT Content-Type: application/x-amz-json-1.1

"id": "d27b18648f174491be6cc6777f1ee66c",

"ideTemplateId": "cee38068079f4d399cbab9ecc9f955c2", "lifecycle":

{"reasonCode": "CREATE_SUCCESS", "status": "CREATED"},

"managedCredentialsStatus": "DISABLED_BY_COLLABORATOR", "name": "foo",

"ownerArn": "arn:aws:iam::5***********:user/usname", "type": "ec2"},

{"arn":

"arn:aws:cloud9:eu-west-1:516690746032:environment:588b0e9bc3134815a4f090b4cca49e84", "description": "",

"id": "588b0e9bc3134815a4f090b4cca49e84",

"ideTemplateId": "cee38068079f4d399cbab9ecc9f955c2", "lifecycle":

{"reasonCode": "CREATE_SUCCESS", "status": "CREATED"},

"name": "TestEnv",

"ownerArn": "arn:aws:iam::XXXXXXXXXXXX:user/USERNAME", "managedCredentialsStatus": "ENABLED_BY_OWNER", "type": "ec2"}

]}

Request Syntax

{ "environmentId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 58).

The request accepts the following data in JSON format.

environmentId (p. 29)

The ID of the environment to get status information about.

Type: String

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

Required: Yes

Response Syntax

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

message (p. 29)

Any informational message about the status of the environment.

Type: String status (p. 29)

The status of the environment. Available values include:

• connecting: The environment is connecting.

• creating: The environment is being created.

• deleting: The environment is being deleted.

• error: The environment is in an error state.

Errors

• ready: The environment is ready.

• stopped: The environment is stopped.

• stopping: The environment is stopping.

Type: String

Errors

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

BadRequestException

The target request is invalid.

HTTP Status Code: 400 ConﬂictException

A conﬂict 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 gets status information about the speciﬁed AWS Cloud9 development environment.

See Also

Sample Request

POST / HTTP/1.1

Host: cloud9.us-east-2.amazonaws.com Accept-Encoding: identity

X-Amz-Date: 20180123T225304Z

X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironmentStatus 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=5e458ca5EXAMPLE

Content-Length: 53

Content-Type: application/x-amz-json-1.1 {

"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"

}

Sample Response

HTTP/1.1 200 OK

Date: Tue, 23 Jan 2018 22:53:07 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 58

x-amzn-RequestId: 2cd6dfae-0090-11e8-a542-51fd7a14e1EX Connection: Keep-alive

{

"message": "Environment is ready to use", "status": "ready"

}

Request Syntax

{

"maxResults": number, "nextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 58).

The request accepts the following data in JSON format.

maxResults (p. 32)

The maximum number of environments to get identiﬁers for.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 25.

Required: No nextToken (p. 32)

During a previous call, if there are more than 25 items in the list, only the ﬁrst 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Type: String Required: No

Response Syntax

{ "environmentIds": [ "string" ], "nextToken": "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.

environmentIds (p. 32)

The list of environment identiﬁers.

Errors

Type: Array of strings

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

nextToken (p. 32)

If there are more than 25 items in the list, only the ﬁrst 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

Type: String

Errors

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

BadRequestException

The target request is invalid.

HTTP Status Code: 400 ConﬂictException

A conﬂict 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 gets the IDs of available AWS Cloud9 development environments.

See Also

Sample Request

POST / HTTP/1.1

Host: cloud9.us-east-2.amazonaws.com Accept-Encoding: identity

X-Amz-Target: AWSCloud9WorkspaceManagementService.ListEnvironments

Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20180123/us-east-2/

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=17a00c64EXAMPLE

X-Amz-Date: 20180123T223531Z

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 Content-Type: application/x-amz-json-1.1

Content-Length: 2 {}

Sample Response

HTTP/1.1 200 OK

Date: Tue, 23 Jan 2018 22:35:34 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 230

x-amzn-RequestId: b9b13fd3-008d-11e8-a65b-093e8a557dEX Connection: Keep-alive

{

"environmentIds": [

"349c86d4579e4e7298d500ff57a6b2EX", "45a3da47af0840f2b0c0824f5ee232EX"

]}

Request Syntax

{

"ResourceARN": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 58).

The request accepts the following data in JSON format.

ResourceARN (p. 35)

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to get the tags for.

Type: String

Pattern: arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):cloud9:([a-z]{2}-[a-z]+-\d{1}):[0-9]{12}:environment:[a-zA-Z0-9]{8,32}

Required: Yes

Response Syntax

{ "Tags": [ {

"Key": "string", "Value": "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.

Tags (p. 35)

The list of tags associated with the AWS Cloud9 development environment.

Type: Array of Tag (p. 57) objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Errors

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

BadRequestException

The target request is invalid.

HTTP Status Code: 400 InternalServerErrorException

An internal server error occurred.

HTTP Status Code: 500 NotFoundException

The target resource cannot be found.

HTTP Status Code: 400

Examples

Example

The following example shows now to get a list of the tags that are associated with an AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

Host: cloud9.eu-west-1.amazonaws.com Accept-Encoding: identity

Content-Type: application/x-amz-json-1.1 X-Amz-Date: 20191218T231127Z

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Target: AWSCloud9WorkspaceManagementService.ListTagsForResource Content-Length: ...

Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20191218/eu-west-1/

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=bb140cb4EXAMPLE

{ "ResourceARN":

"arn:aws:cloud9:eu-west-1:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", }

Sample Response

HTTP/1.1 200 OK

Date: Wed, 18 Dec 2019 23:11:30 GMT Content-Type: application/x-amz-json-1.1

See Also

"Value": "orange"}

]}

Request Syntax

{ "ResourceARN": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 58).

The request accepts the following data in JSON format.

ResourceARN (p. 38)

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to add tags to.

Type: String

Pattern: arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):cloud9:([a-z]{2}-[a-z]+-\d{1}):[0-9]{12}:environment:[a-zA-Z0-9]{8,32}

Required: Yes Tags (p. 38)

The list of tags to add to the given AWS Cloud9 development environment.

Type: Array of Tag (p. 57) objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

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 (p. 60).

Examples

BadRequestException

The target request is invalid.

HTTP Status Code: 400 ConcurrentAccessException

A concurrent access issue occurred.

HTTP Status Code: 400 InternalServerErrorException

An internal server error occurred.

HTTP Status Code: 500 NotFoundException

The target resource cannot be found.

HTTP Status Code: 400

Examples

Example

The following example shows how to add tags to an AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

Host: cloud9.eu-west-1.amazonaws.com Accept-Encoding: identity

Content-Type: application/x-amz-json-1.1 X-Amz-Date: 20191218T231127Z

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Target: AWSCloud9WorkspaceManagementService.TagResource Content-Length: ...

Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20191218/eu-west-1/

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=bb140cb4EXAMPLE

{ "ResourceARN":

"arn:aws:cloud9:eu-west-1:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX",

HTTP/1.1 200 OK

Date: Wed, 18 Dec 2019 23:11:30 GMT Content-Type: application/x-amz-json-1.1 Content-Length: ...

x-amzn-RequestId: beecb831-0092-11e8-84fe-c19e871c26EX Connection: Keep-alive

See Also

{}

Request Syntax

{

"ResourceARN": "string", "TagKeys": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 58).

The request accepts the following data in JSON format.

ResourceARN (p. 41)

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.

Type: String

Pattern: arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):cloud9:([a-z]{2}-[a-z]+-\d{1}):[0-9]{12}:environment:[a-zA-Z0-9]{8,32}

Required: Yes TagKeys (p. 41)

The tag names of the tags to remove from the given AWS Cloud9 development environment.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

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 (p. 60).

BadRequestException

The target request is invalid.

HTTP Status Code: 400

Examples

ConcurrentAccessException

A concurrent access issue occurred.

HTTP Status Code: 400 InternalServerErrorException

An internal server error occurred.

HTTP Status Code: 500 NotFoundException

The target resource cannot be found.

HTTP Status Code: 400

Examples

Example

The following example shows how to remove tags from an AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

Host: cloud9.eu-west-1.amazonaws.com Accept-Encoding: identity

Content-Type: application/x-amz-json-1.1 X-Amz-Date: 20191218T231127Z

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Target: AWSCloud9WorkspaceManagementService.UntagResource Content-Length: ...

Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20191218/eu-west-1/

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=bb140cb4EXAMPLE

{ "ResourceARN":

"arn:aws:cloud9:eu-west-1:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", "TagKeys":

["key"]

}

Sample Response

HTTP/1.1 200 OK

Date: Wed, 18 Dec 2019 23:11:30 GMT Content-Type: application/x-amz-json-1.1

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

• AWS Command Line Interface

See Also

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

UpdateEnvironment

Changes the settings of an existing AWS Cloud9 development environment.

Request Syntax

{ "description": "string", "environmentId": "string",

"managedCredentialsAction": "string", "name": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 58).

The request accepts the following data in JSON format.

description (p. 44)

Any new or replacement description for the environment.

Type: String

Length Constraints: Maximum length of 200.

Required: No environmentId (p. 44)

The ID of the environment to change settings.

Type: String

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

Required: Yes

managedCredentialsAction (p. 44)

Allows the environment owner to turn on or turn oﬀ the AWS managed temporary credentials for an AWS Cloud9 environment by using one of the following values:

• ENABLE

• DISABLE

NoteOnly the environment owner can change the status of managed temporary credentials.

An AccessDeniedException is thrown if an attempt to turn on or turn oﬀ managed temporary credentials is made by an account that's not the environment owner.

Type: String

Valid Values: ENABLE | DISABLE Required: No

name (p. 44)

A replacement name for the environment.

Response Elements

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60.

Required: No

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 (p. 60).

BadRequestException

The target request is invalid.

HTTP Status Code: 400 ConﬂictException

A conﬂict 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 information about the speciﬁed AWS Cloud9 development environment.

See Also

Sample Request

POST / HTTP/1.1

Host: cloud9.us-east-2.amazonaws.com Accept-Encoding: identity

Content-Length: 140

X-Amz-Date: 20180123T232132Z

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Target: AWSCloud9WorkspaceManagementService.UpdateEnvironment

Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20180123/us-east-2/

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=280d6dbaEXAMPLE

Content-Type: application/x-amz-json-1.1 {

"name": "my-changed-demo-environment",

"description": "This is my changed demonstration environment.", "environmentId": "8d9967e2f0624182b74e7690ad69ebEX"

}

Sample Response

HTTP/1.1 200 OK

Date: Tue, 23 Jan 2018 23:21:33 GMT Content-Type: application/x-amz-json-1.1

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

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

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 (p. 58).

The request accepts the following data in JSON format.

environmentId (p. 47)

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 (p. 47)

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 (p. 47)

The Amazon Resource Name (ARN) of the environment member whose settings you want to change.

Type: String

(user\/[\w+=/:,.@-]{1,64}|federated-user\/[\w+=/:,.@-]{2,32}|assumed-role\/

[\w+=:,.@-]{1,64}\/[\w+=,.@-]{1,64}))$

Required: Yes

Response Syntax

{

Response Elements

"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 (p. 47)

Information about the environment member whose settings were changed.

Type: EnvironmentMember (p. 55) object

Errors

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

在文檔中 AWS Cloud9 (頁 28-56)