You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Cloud9::Types::DescribeEnvironmentMembershipsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb

Overview

Note:

When making an API call, you may pass DescribeEnvironmentMembershipsRequest data as a hash:

{
  user_arn: "UserArn",
  environment_id: "EnvironmentId",
  permissions: ["owner"], # accepts owner, read-write, read-only
  next_token: "String",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#environment_idString

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

Returns:

  • (String)


242
243
244
245
246
247
248
249
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 242

class DescribeEnvironmentMembershipsRequest < Struct.new(
  :user_arn,
  :environment_id,
  :permissions,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of environment members to get information about.

Returns:

  • (Integer)


242
243
244
245
246
247
248
249
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 242

class DescribeEnvironmentMembershipsRequest < Struct.new(
  :user_arn,
  :environment_id,
  :permissions,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


242
243
244
245
246
247
248
249
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 242

class DescribeEnvironmentMembershipsRequest < Struct.new(
  :user_arn,
  :environment_id,
  :permissions,
  :next_token,
  :max_results)
  include Aws::Structure
end

#permissionsArray<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.

Returns:

  • (Array<String>)


242
243
244
245
246
247
248
249
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 242

class DescribeEnvironmentMembershipsRequest < Struct.new(
  :user_arn,
  :environment_id,
  :permissions,
  :next_token,
  :max_results)
  include Aws::Structure
end

#user_arnString

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.

Returns:

  • (String)


242
243
244
245
246
247
248
249
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 242

class DescribeEnvironmentMembershipsRequest < Struct.new(
  :user_arn,
  :environment_id,
  :permissions,
  :next_token,
  :max_results)
  include Aws::Structure
end