Class: AWS.Cloud9

/*  */

 var params = {
  environmentId: "8d9967e2f0624182b74e7690ad69ebEX", 
  permissions: "read-write", 
  userArn: "arn:aws:iam::123456789012:user/AnotherDemoUser"
 };
 cloud9.createEnvironmentMembership(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    membership: {
     environmentId: "8d9967e2f0624182b74e7690ad69ebEX", 
     permissions: "read-write", 
     userArn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
     userId: "AIDAJ3BA6O2FMJWCWXHEX"
    }
   }
   */
 });

var params = {
  environmentId: 'STRING_VALUE', /* required */
  permissions: read-write | read-only, /* required */
  userArn: 'STRING_VALUE' /* required */
};
cloud9.createEnvironmentMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • environmentId — (String)

    The ID of the environment that contains the environment member you want to add.

  • userArn — (String)

    The Amazon Resource Name (ARN) of the environment member you want to add.

  • permissions — (String)

    The 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.

    Possible values include:
    • "read-write"
    • "read-only"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • membership — (map)

      Information about the environment member that was added.

      • permissions — required — (String)

        The type of environment member permissions associated with this environment member. Available values include:

        • owner: Owns the environment.

        • read-only: Has read-only access to the environment.

        • read-write: Has read-write access to the environment.

        Possible values include:
        • "owner"
        • "read-write"
        • "read-only"
      • userId — required — (String)

        The user ID in Identity and Access Management (IAM) of the environment member.

      • userArn — required — (String)

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

      • environmentId — required — (String)

        The ID of the environment for the environment member.

      • lastAccess — (Date)

        The time, expressed in epoch time format, when the environment member last opened the environment.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/*  */

 var params = {
  environmentId: "8d9967e2f0624182b74e7690ad69ebEX"
 };
 cloud9.deleteEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  environmentId: 'STRING_VALUE' /* required */
};
cloud9.deleteEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • environmentId — (String)

    The ID of the environment to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/*  */

 var params = {
  environmentId: "8d9967e2f0624182b74e7690ad69ebEX", 
  userArn: "arn:aws:iam::123456789012:user/AnotherDemoUser"
 };
 cloud9.deleteEnvironmentMembership(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  environmentId: 'STRING_VALUE', /* required */
  userArn: 'STRING_VALUE' /* required */
};
cloud9.deleteEnvironmentMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • environmentId — (String)

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

  • userArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* The following example gets information about all of the environment members for the specified development environment. */

 var params = {
  environmentId: "8d9967e2f0624182b74e7690ad69ebEX"
 };
 cloud9.describeEnvironmentMemberships(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    memberships: [
       {
      environmentId: "8d9967e2f0624182b74e7690ad69ebEX", 
      permissions: "read-write", 
      userArn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
      userId: "AIDAJ3BA6O2FMJWCWXHEX"
     }, 
       {
      environmentId: "8d9967e2f0624182b74e7690ad69ebEX", 
      permissions: "owner", 
      userArn: "arn:aws:iam::123456789012:user/MyDemoUser", 
      userId: "AIDAJNUEDQAQWFELJDLEX"
     }
    ]
   }
   */
 });

/* The following example gets information about the owner of the specified development environment. */

 var params = {
  environmentId: "8d9967e2f0624182b74e7690ad69ebEX", 
  permissions: [
     "owner"
  ]
 };
 cloud9.describeEnvironmentMemberships(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    memberships: [
       {
      environmentId: "8d9967e2f0624182b74e7690ad69ebEX", 
      permissions: "owner", 
      userArn: "arn:aws:iam::123456789012:user/MyDemoUser", 
      userId: "AIDAJNUEDQAQWFELJDLEX"
     }
    ]
   }
   */
 });

/* The following example gets development environment membership information for the specified user. */

 var params = {
  userArn: "arn:aws:iam::123456789012:user/MyDemoUser"
 };
 cloud9.describeEnvironmentMemberships(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    memberships: [
       {
      environmentId: "10a75714bd494714929e7f5ec4125aEX", 
      lastAccess: <Date Representation>, 
      permissions: "owner", 
      userArn: "arn:aws:iam::123456789012:user/MyDemoUser", 
      userId: "AIDAJNUEDQAQWFELJDLEX"
     }, 
       {
      environmentId: "12bfc3cd537f41cb9776f8af5525c9EX", 
      lastAccess: <Date Representation>, 
      permissions: "owner", 
      userArn: "arn:aws:iam::123456789012:user/MyDemoUser", 
      userId: "AIDAJNUEDQAQWFELJDLEX"
     }
    ]
   }
   */
 });

var params = {
  environmentId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  permissions: [
    owner | read-write | read-only,
    /* more items */
  ],
  userArn: 'STRING_VALUE'
};
cloud9.describeEnvironmentMemberships(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • userArn — (String)

    The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

  • environmentId — (String)

    The ID of the environment to get environment member information about.

  • permissions — (Array<String>)

    The type of environment member permissions to get information about. Available values include:

    • owner: Owns the environment.

    • read-only: Has read-only access to the environment.

    • read-write: Has read-write access to the environment.

    If no value is specified, information about all environment members are returned.

  • nextToken — (String)

    During a previous call, if there are more than 25 items in the list, only the first 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.

  • maxResults — (Integer)

    The maximum number of environment members to get information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • memberships — (Array<map>)

      Information about the environment members for the environment.

      • permissions — required — (String)

        The type of environment member permissions associated with this environment member. Available values include:

        • owner: Owns the environment.

        • read-only: Has read-only access to the environment.

        • read-write: Has read-write access to the environment.

        Possible values include:
        • "owner"
        • "read-write"
        • "read-only"
      • userId — required — (String)

        The user ID in Identity and Access Management (IAM) of the environment member.

      • userArn — required — (String)

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

      • environmentId — required — (String)

        The ID of the environment for the environment member.

      • lastAccess — (Date)

        The time, expressed in epoch time format, when the environment member last opened the environment.

    • nextToken — (String)

      If there are more than 25 items in the list, only the first 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/*  */

 var params = {
  environmentIds: [
     "8d9967e2f0624182b74e7690ad69ebEX", 
     "349c86d4579e4e7298d500ff57a6b2EX"
  ]
 };
 cloud9.describeEnvironments(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    environments: [
       {
      name: "my-demo-environment", 
      type: "ec2", 
      arn: "arn:aws:cloud9:us-east-2:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", 
      description: "This is my demonstration environment.", 
      id: "8d9967e2f0624182b74e7690ad69ebEX", 
      lifecycle: {
       status: "CREATED"
      }, 
      ownerArn: "arn:aws:iam::123456789012:user/MyDemoUser"
     }, 
       {
      name: "another-demo-environment", 
      type: "ssh", 
      arn: "arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX", 
      description: "", 
      id: "349c86d4579e4e7298d500ff57a6b2EX", 
      lifecycle: {
       status: "CREATED"
      }, 
      ownerArn: "arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser"
     }
    ]
   }
   */
 });

var params = {
  environmentIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloud9.describeEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • environmentIds — (Array<String>)

    The IDs of individual environments to get information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • environments — (Array<map>)

      Information about the environments that are returned.

      • id — (String)

        The ID of the environment.

      • name — (String)

        The name of the environment.

      • description — (String)

        The description for the environment.

      • type — required — (String)

        The type of environment. Valid values include the following:

        • ec2: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.

        • ssh: Your own server connects to the environment.

        Possible values include:
        • "ssh"
        • "ec2"
      • connectionType — (String)

        The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default.

        Possible values include:
        • "CONNECT_SSH"
        • "CONNECT_SSM"
      • arn — required — (String)

        The Amazon Resource Name (ARN) of the environment.

      • ownerArn — required — (String)

        The Amazon Resource Name (ARN) of the environment owner.

      • lifecycle — (map)

        The state of the environment in its creation or deletion lifecycle.

        • status — (String)

          The current creation or deletion lifecycle state of the environment.

          • CREATING: The environment is in the process of being created.

          • CREATED: The environment was successfully created.

          • CREATE_FAILED: The environment failed to be created.

          • DELETING: The environment is in the process of being deleted.

          • DELETE_FAILED: The environment failed to delete.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "CREATE_FAILED"
          • "DELETING"
          • "DELETE_FAILED"
        • reason — (String)

          Any informational message about the lifecycle state of the environment.

        • failureResource — (String)

          If the environment failed to delete, the Amazon Resource Name (ARN) of the related Amazon Web Services resource.

      • managedCredentialsStatus — (String)

        Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:

        • ENABLED_ON_CREATE

        • ENABLED_BY_OWNER

        • DISABLED_BY_DEFAULT

        • DISABLED_BY_OWNER

        • DISABLED_BY_COLLABORATOR

        • PENDING_REMOVAL_BY_COLLABORATOR

        • PENDING_REMOVAL_BY_OWNER

        • FAILED_REMOVAL_BY_COLLABORATOR

        • ENABLED_BY_OWNER

        • DISABLED_BY_DEFAULT

        Possible values include:
        • "ENABLED_ON_CREATE"
        • "ENABLED_BY_OWNER"
        • "DISABLED_BY_DEFAULT"
        • "DISABLED_BY_OWNER"
        • "DISABLED_BY_COLLABORATOR"
        • "PENDING_REMOVAL_BY_COLLABORATOR"
        • "PENDING_START_REMOVAL_BY_COLLABORATOR"
        • "PENDING_REMOVAL_BY_OWNER"
        • "PENDING_START_REMOVAL_BY_OWNER"
        • "FAILED_REMOVAL_BY_COLLABORATOR"
        • "FAILED_REMOVAL_BY_OWNER"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/*  */

 var params = {
  environmentId: "8d9967e2f0624182b74e7690ad69ebEX"
 };
 cloud9.describeEnvironmentStatus(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    message: "Environment is ready to use", 
    status: "ready"
   }
   */
 });

var params = {
  environmentId: 'STRING_VALUE' /* required */
};
cloud9.describeEnvironmentStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • environmentId — (String)

    The ID of the environment to get status information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • status — (String)

      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.

      • ready: The environment is ready.

      • stopped: The environment is stopped.

      • stopping: The environment is stopping.

      Possible values include:
      • "error"
      • "creating"
      • "connecting"
      • "ready"
      • "stopping"
      • "stopped"
      • "deleting"
    • message — (String)

      Any informational message about the status of the environment.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/*  */

 var params = {
 };
 cloud9.listEnvironments(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    environmentIds: [
       "349c86d4579e4e7298d500ff57a6b2EX", 
       "45a3da47af0840f2b0c0824f5ee232EX"
    ]
   }
   */
 });

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
cloud9.listEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    During a previous call, if there are more than 25 items in the list, only the first 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.

  • maxResults — (Integer)

    The maximum number of environments to get identifiers for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      If there are more than 25 items in the list, only the first 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.

    • environmentIds — (Array<String>)

      The list of environment identifiers.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
cloud9.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (Array<map>)

      The list of tags associated with the Cloud9 development environment.

      • Key — required — (String)

        The name part of a tag.

      • Value — required — (String)

        The value part of a tag.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
cloud9.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

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

  • Tags — (Array<map>)

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

    • Key — required — (String)

      The name part of a tag.

    • Value — required — (String)

      The value part of a tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloud9.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

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

  • TagKeys — (Array<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/*  */

 var params = {
  name: "my-changed-demo-environment", 
  description: "This is my changed demonstration environment.", 
  environmentId: "8d9967e2f0624182b74e7690ad69ebEX"
 };
 cloud9.updateEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  environmentId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  managedCredentialsAction: ENABLE | DISABLE,
  name: 'STRING_VALUE'
};
cloud9.updateEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • environmentId — (String)

    The ID of the environment to change settings.

  • name — (String)

    A replacement name for the environment.

  • description — (String)

    Any new or replacement description for the environment.

  • managedCredentialsAction — (String)

    Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials for an Cloud9 environment by using one of the following values:

    • ENABLE

    • DISABLE

    Note: Only the environment owner can change the status of managed temporary credentials. An AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary credentials is made by an account that's not the environment owner.
    Possible values include:
    • "ENABLE"
    • "DISABLE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/*  */

 var params = {
  environmentId: "8d9967e2f0624182b74e7690ad69ebEX", 
  permissions: "read-only", 
  userArn: "arn:aws:iam::123456789012:user/AnotherDemoUser"
 };
 cloud9.updateEnvironmentMembership(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    membership: {
     environmentId: "8d9967e2f0624182b74e7690ad69eb31", 
     permissions: "read-only", 
     userArn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
     userId: "AIDAJ3BA6O2FMJWCWXHEX"
    }
   }
   */
 });

var params = {
  environmentId: 'STRING_VALUE', /* required */
  permissions: read-write | read-only, /* required */
  userArn: 'STRING_VALUE' /* required */
};
cloud9.updateEnvironmentMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • environmentId — (String)

    The ID of the environment for the environment member whose settings you want to change.

  • userArn — (String)

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

  • permissions — (String)

    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.

    Possible values include:
    • "read-write"
    • "read-only"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • membership — (map)

      Information about the environment member whose settings were changed.

      • permissions — required — (String)

        The type of environment member permissions associated with this environment member. Available values include:

        • owner: Owns the environment.

        • read-only: Has read-only access to the environment.

        • read-write: Has read-write access to the environment.

        Possible values include:
        • "owner"
        • "read-write"
        • "read-only"
      • userId — required — (String)

        The user ID in Identity and Access Management (IAM) of the environment member.

      • userArn — required — (String)

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

      • environmentId — required — (String)

        The ID of the environment for the environment member.

      • lastAccess — (Date)

        The time, expressed in epoch time format, when the environment member last opened the environment.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.