Skip to content

Describe Environment Memberships

cloud9_describe_environment_memberships R Documentation

Gets information about environment members for an Cloud9 development environment

Description

Gets information about environment members for an Cloud9 development environment.

Usage

cloud9_describe_environment_memberships(userArn, environmentId,
  permissions, nextToken, maxResults)

Arguments

userArn

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

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

permissions

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

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

The maximum number of environment members to get information about.

Value

A list with the following syntax: 

list(
  memberships = list(
    list(
      permissions = "owner"|"read-write"|"read-only",
      userId = "string",
      userArn = "string",
      environmentId = "string",
      lastAccess = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_environment_memberships(
  userArn = "string",
  environmentId = "string",
  permissions = list(
    "owner"|"read-write"|"read-only"
  ),
  nextToken = "string",
  maxResults = 123
)

Examples

## Not run: 
# The following example gets information about all of the environment
# members for the specified development environment.
svc$describe_environment_memberships(
  environmentId = "8d9967e2f0624182b74e7690ad69ebEX"
)

# The following example gets information about the owner of the specified
# development environment.
svc$describe_environment_memberships(
  environmentId = "8d9967e2f0624182b74e7690ad69ebEX",
  permissions = list(
    "owner"
  )
)

# The following example gets development environment membership
# information for the specified user.
svc$describe_environment_memberships(
  userArn = "arn:aws:iam::123456789012:user/MyDemoUser"
)

## End(Not run)