@datafire/amazonaws_cloud9 v5.0.0

@datafire/amazonaws_cloud9

Client library for AWS Cloud9

Installation and Usage

npm install --save @datafire/amazonaws_cloud9

let amazonaws_cloud9 = require('@datafire/amazonaws_cloud9').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_cloud9.CreateEnvironmentEC2({
  "name": "",
  "instanceType": ""
}).then(data => {
  console.log(data);
});

Description

AWS Cloud9 AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud. For more information about AWS Cloud9, see the AWS Cloud9 User Guide. AWS Cloud9 supports these operations: CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment. CreateEnvironmentMembership: Adds an environment member to an environment. DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. DeleteEnvironmentMembership: Deletes an environment member from an environment. DescribeEnvironmentMemberships: Gets information about environment members for an environment. DescribeEnvironments: Gets information about environments. DescribeEnvironmentStatus: Gets status information for an environment. ListEnvironments: Gets a list of environment identifiers. UpdateEnvironment: Changes the settings of an existing environment. UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.

Actions

CreateEnvironmentEC2

amazonaws_cloud9.CreateEnvironmentEC2({
  "name": "",
  "instanceType": ""
}, context)

Input

• input object
  • automaticStopTimeMinutes AutomaticStopTimeMinutes
  • clientRequestToken ClientRequestToken
  • description EnvironmentDescription
  • instanceType required InstanceType
  • name required EnvironmentName
  • ownerArn UserArn
  • subnetId SubnetId

Output

• output CreateEnvironmentEC2Result

CreateEnvironmentMembership

amazonaws_cloud9.CreateEnvironmentMembership({
  "environmentId": "",
  "userArn": "",
  "permissions": ""
}, context)

Input

• input object
  • environmentId required EnvironmentId
  • permissions required MemberPermissions
  • userArn required UserArn

Output

• output CreateEnvironmentMembershipResult

DeleteEnvironment

amazonaws_cloud9.DeleteEnvironment({
  "environmentId": ""
}, context)

Input

• input object
  • environmentId required EnvironmentId

Output

• output DeleteEnvironmentResult

DeleteEnvironmentMembership

amazonaws_cloud9.DeleteEnvironmentMembership({
  "environmentId": "",
  "userArn": ""
}, context)

Input

• input object
  • environmentId required EnvironmentId
  • userArn required UserArn

Output

• output DeleteEnvironmentMembershipResult

DescribeEnvironmentMemberships

amazonaws_cloud9.DescribeEnvironmentMemberships({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • environmentId EnvironmentId
  • maxResults MaxResults
  • nextToken String
  • permissions PermissionsList
  • userArn UserArn

Output

• output DescribeEnvironmentMembershipsResult

DescribeEnvironmentStatus

amazonaws_cloud9.DescribeEnvironmentStatus({
  "environmentId": ""
}, context)

Input

• input object
  • environmentId required EnvironmentId

Output

• output DescribeEnvironmentStatusResult

DescribeEnvironments

amazonaws_cloud9.DescribeEnvironments({
  "environmentIds": []
}, context)

Input

• input object
  • environmentIds required BoundedEnvironmentIdList

Output

• output DescribeEnvironmentsResult

ListEnvironments

amazonaws_cloud9.ListEnvironments({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults MaxResults
  • nextToken String

Output

• output ListEnvironmentsResult

UpdateEnvironment

amazonaws_cloud9.UpdateEnvironment({
  "environmentId": ""
}, context)

Input

• input object
  • description EnvironmentDescription
  • environmentId required EnvironmentId
  • name EnvironmentName

Output

• output UpdateEnvironmentResult

UpdateEnvironmentMembership

amazonaws_cloud9.UpdateEnvironmentMembership({
  "environmentId": "",
  "userArn": "",
  "permissions": ""
}, context)

Input

• input object
  • environmentId required EnvironmentId
  • permissions required MemberPermissions
  • userArn required UserArn

Output

• output UpdateEnvironmentMembershipResult

Definitions

AutomaticStopTimeMinutes

• AutomaticStopTimeMinutes integer

BadRequestException

• BadRequestException object: The target request is invalid.

BoundedEnvironmentIdList

• BoundedEnvironmentIdList array
  • items EnvironmentId

ClientRequestToken

• ClientRequestToken string

ConflictException

• ConflictException object: A conflict occurred.

CreateEnvironmentEC2Request

• CreateEnvironmentEC2Request object
  • automaticStopTimeMinutes AutomaticStopTimeMinutes
  • clientRequestToken ClientRequestToken
  • description EnvironmentDescription
  • instanceType required InstanceType
  • name required EnvironmentName
  • ownerArn UserArn
  • subnetId SubnetId

CreateEnvironmentEC2Result

• CreateEnvironmentEC2Result object
  • environmentId EnvironmentId

CreateEnvironmentMembershipRequest

• CreateEnvironmentMembershipRequest object
  • environmentId required EnvironmentId
  • permissions required MemberPermissions
  • userArn required UserArn

CreateEnvironmentMembershipResult

• CreateEnvironmentMembershipResult object
  • membership EnvironmentMember

DeleteEnvironmentMembershipRequest

• DeleteEnvironmentMembershipRequest object
  • environmentId required EnvironmentId
  • userArn required UserArn

DeleteEnvironmentMembershipResult

• DeleteEnvironmentMembershipResult object

DeleteEnvironmentRequest

• DeleteEnvironmentRequest object
  • environmentId required EnvironmentId

DeleteEnvironmentResult

• DeleteEnvironmentResult object

DescribeEnvironmentMembershipsRequest

• DescribeEnvironmentMembershipsRequest object
  • environmentId EnvironmentId
  • maxResults MaxResults
  • nextToken String
  • permissions PermissionsList
  • userArn UserArn

DescribeEnvironmentMembershipsResult

• DescribeEnvironmentMembershipsResult object
  • memberships EnvironmentMembersList
  • nextToken String

DescribeEnvironmentStatusRequest

• DescribeEnvironmentStatusRequest object
  • environmentId required EnvironmentId

DescribeEnvironmentStatusResult

• DescribeEnvironmentStatusResult object
  • message String
  • status EnvironmentStatus

DescribeEnvironmentsRequest

• DescribeEnvironmentsRequest object
  • environmentIds required BoundedEnvironmentIdList

DescribeEnvironmentsResult

• DescribeEnvironmentsResult object
  • environments EnvironmentList

Environment

• Environment object: Information about an AWS Cloud9 development environment.
  • arn String
  • description EnvironmentDescription
  • id EnvironmentId
  • name EnvironmentName
  • ownerArn String
  • type EnvironmentType

EnvironmentDescription

• EnvironmentDescription string

EnvironmentId

• EnvironmentId string

EnvironmentIdList

• EnvironmentIdList array
  • items EnvironmentId

EnvironmentList

• EnvironmentList array
  • items Environment

EnvironmentMember

• EnvironmentMember object: Information about an environment member for an AWS Cloud9 development environment.
  • environmentId EnvironmentId
  • lastAccess Timestamp
  • permissions Permissions
  • userArn UserArn
  • userId String

EnvironmentMembersList

• EnvironmentMembersList array
  • items EnvironmentMember

EnvironmentName

• EnvironmentName string

EnvironmentStatus

• EnvironmentStatus string (values: error, creating, connecting, ready, stopping, stopped, deleting)

EnvironmentType

• EnvironmentType string (values: ssh, ec2)

ForbiddenException

• ForbiddenException object: An access permissions issue occurred.

InstanceType

• InstanceType string

InternalServerErrorException

• InternalServerErrorException object: An internal server error occurred.

LimitExceededException

• LimitExceededException object: A service limit was exceeded.

ListEnvironmentsRequest

• ListEnvironmentsRequest object
  • maxResults MaxResults
  • nextToken String

ListEnvironmentsResult

• ListEnvironmentsResult object
  • environmentIds EnvironmentIdList
  • nextToken String

MaxResults

• MaxResults integer

MemberPermissions

• MemberPermissions string (values: read-write, read-only)

NotFoundException

• NotFoundException object: The target resource cannot be found.

Permissions

• Permissions string (values: owner, read-write, read-only)

PermissionsList

• PermissionsList array
  • items Permissions

String

• String string

SubnetId

• SubnetId string

Timestamp

• Timestamp string

TooManyRequestsException

• TooManyRequestsException object: Too many service requests were made over the given time period.

UpdateEnvironmentMembershipRequest

• UpdateEnvironmentMembershipRequest object
  • environmentId required EnvironmentId
  • permissions required MemberPermissions
  • userArn required UserArn

UpdateEnvironmentMembershipResult

• UpdateEnvironmentMembershipResult object
  • membership EnvironmentMember

UpdateEnvironmentRequest

• UpdateEnvironmentRequest object
  • description EnvironmentDescription
  • environmentId required EnvironmentId
  • name EnvironmentName

UpdateEnvironmentResult

• UpdateEnvironmentResult object

UserArn

• UserArn string