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

Class: Aws::Cloud9::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



257
258
259
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 257

def initialize(*args)
  super
end

Instance Method Details

#create_environment_ec2(params = {}) ⇒ Types::CreateEnvironmentEC2Result

Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

Examples:

Example: CreateEnvironmentEC2


resp = client.create_environment_ec2({
  name: "my-demo-environment", 
  automatic_stop_time_minutes: 60, 
  description: "This is my demonstration environment.", 
  instance_type: "t2.micro", 
  owner_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
  subnet_id: "subnet-1fab8aEX", 
})

resp.to_h outputs the following:
{
  environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
}

Request syntax with placeholder values


resp = client.create_environment_ec2({
  name: "EnvironmentName", # required
  description: "EnvironmentDescription",
  client_request_token: "ClientRequestToken",
  instance_type: "InstanceType", # required
  subnet_id: "SubnetId",
  automatic_stop_time_minutes: 1,
  owner_arn: "UserArn",
})

Response structure


resp.environment_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the environment to create.

    This name is visible to other AWS IAM users in the same AWS account.

  • :description (String) —

    The description of the environment to create.

  • :client_request_token (String) —

    A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.

    For more information, see Client Tokens in the Amazon EC2 API Reference.

  • :instance_type (required, String) —

    The type of instance to connect to the environment (for example, t2.micro).

  • :subnet_id (String) —

    The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.

  • :automatic_stop_time_minutes (Integer) —

    The number of minutes until the running instance is shut down after the environment has last been used.

  • :owner_arn (String) —

    The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

Returns:

See Also:



344
345
346
347
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 344

def create_environment_ec2(params = {}, options = {})
  req = build_request(:create_environment_ec2, params)
  req.send_request(options)
end

#create_environment_membership(params = {}) ⇒ Types::CreateEnvironmentMembershipResult

Adds an environment member to an AWS Cloud9 development environment.

Examples:

Example: CreateEnvironmentMembership


resp = client.create_environment_membership({
  environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
  permissions: "read-write", 
  user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
})

resp.to_h outputs the following:
{
  membership: {
    environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
    permissions: "read-write", 
    user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
    user_id: "AIDAJ3BA6O2FMJWCWXHEX", 
  }, 
}

Request syntax with placeholder values


resp = client.create_environment_membership({
  environment_id: "EnvironmentId", # required
  user_arn: "UserArn", # required
  permissions: "read-write", # required, accepts read-write, read-only
})

Response structure


resp.membership.permissions #=> String, one of "owner", "read-write", "read-only"
resp.membership.user_id #=> String
resp.membership.user_arn #=> String
resp.membership.environment_id #=> String
resp.membership.last_access #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :environment_id (required, String) —

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

  • :user_arn (required, String) —

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

  • :permissions (required, 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.

Returns:

See Also:



410
411
412
413
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 410

def create_environment_membership(params = {}, options = {})
  req = build_request(:create_environment_membership, params)
  req.send_request(options)
end

#delete_environment(params = {}) ⇒ Struct

Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

Examples:

Example: DeleteEnvironment


resp = client.delete_environment({
  environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_environment({
  environment_id: "EnvironmentId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :environment_id (required, String) —

    The ID of the environment to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



445
446
447
448
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 445

def delete_environment(params = {}, options = {})
  req = build_request(:delete_environment, params)
  req.send_request(options)
end

#delete_environment_membership(params = {}) ⇒ Struct

Deletes an environment member from an AWS Cloud9 development environment.

Examples:

Example: DeleteEnvironmentMembership


resp = client.delete_environment_membership({
  environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
  user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_environment_membership({
  environment_id: "EnvironmentId", # required
  user_arn: "UserArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :environment_id (required, String) —

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

  • :user_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



485
486
487
488
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 485

def delete_environment_membership(params = {}, options = {})
  req = build_request(:delete_environment_membership, params)
  req.send_request(options)
end

#describe_environment_memberships(params = {}) ⇒ Types::DescribeEnvironmentMembershipsResult

Gets information about environment members for an AWS Cloud9 development environment.

Examples:

Example: DescribeEnvironmentMemberships1


# The following example gets information about all of the environment members for the specified AWS Cloud9 development
# environment.

resp = client.describe_environment_memberships({
  environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
})

resp.to_h outputs the following:
{
  memberships: [
    {
      environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
      permissions: "read-write", 
      user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
      user_id: "AIDAJ3BA6O2FMJWCWXHEX", 
    }, 
    {
      environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
      permissions: "owner", 
      user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
      user_id: "AIDAJNUEDQAQWFELJDLEX", 
    }, 
  ], 
}

Example: DescribeEnvironmentMemberships2


# The following example gets information about the owner of the specified AWS Cloud9 development environment.

resp = client.describe_environment_memberships({
  environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
  permissions: [
    "owner", 
  ], 
})

resp.to_h outputs the following:
{
  memberships: [
    {
      environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
      permissions: "owner", 
      user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
      user_id: "AIDAJNUEDQAQWFELJDLEX", 
    }, 
  ], 
}

Example: DescribeEnvironmentMemberships3


# The following example gets AWS Cloud9 development environment membership information for the specified user.

resp = client.describe_environment_memberships({
  user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
})

resp.to_h outputs the following:
{
  memberships: [
    {
      environment_id: "10a75714bd494714929e7f5ec4125aEX", 
      last_access: Time.parse("2018-01-19T11:06:13Z"), 
      permissions: "owner", 
      user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
      user_id: "AIDAJNUEDQAQWFELJDLEX", 
    }, 
    {
      environment_id: "12bfc3cd537f41cb9776f8af5525c9EX", 
      last_access: Time.parse("2018-01-19T11:39:19Z"), 
      permissions: "owner", 
      user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
      user_id: "AIDAJNUEDQAQWFELJDLEX", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_environment_memberships({
  user_arn: "UserArn",
  environment_id: "EnvironmentId",
  permissions: ["owner"], # accepts owner, read-write, read-only
  next_token: "String",
  max_results: 1,
})

Response structure


resp.memberships #=> Array
resp.memberships[0].permissions #=> String, one of "owner", "read-write", "read-only"
resp.memberships[0].user_id #=> String
resp.memberships[0].user_arn #=> String
resp.memberships[0].environment_id #=> String
resp.memberships[0].last_access #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_arn (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.

  • :environment_id (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.

  • :next_token (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.

  • :max_results (Integer) —

    The maximum number of environment members to get information about.

Returns:

See Also:



634
635
636
637
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 634

def describe_environment_memberships(params = {}, options = {})
  req = build_request(:describe_environment_memberships, params)
  req.send_request(options)
end

#describe_environment_status(params = {}) ⇒ Types::DescribeEnvironmentStatusResult

Gets status information for an AWS Cloud9 development environment.

Examples:

Example: DescribeEnvironmentStatus


resp = client.describe_environment_status({
  environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
})

resp.to_h outputs the following:
{
  message: "Environment is ready to use", 
  status: "ready", 
}

Request syntax with placeholder values


resp = client.describe_environment_status({
  environment_id: "EnvironmentId", # required
})

Response structure


resp.status #=> String, one of "error", "creating", "connecting", "ready", "stopping", "stopped", "deleting"
resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :environment_id (required, String) —

    The ID of the environment to get status information about.

Returns:

See Also:



677
678
679
680
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 677

def describe_environment_status(params = {}, options = {})
  req = build_request(:describe_environment_status, params)
  req.send_request(options)
end

#describe_environments(params = {}) ⇒ Types::DescribeEnvironmentsResult

Gets information about AWS Cloud9 development environments.

Examples:

Example: DescribeEnvironments


resp = client.describe_environments({
  environment_ids: [
    "8d9967e2f0624182b74e7690ad69ebEX", 
    "349c86d4579e4e7298d500ff57a6b2EX", 
  ], 
})

resp.to_h outputs the following:
{
  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", 
      owner_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
    }, 
    {
      name: "another-demo-environment", 
      type: "ssh", 
      arn: "arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX", 
      id: "349c86d4579e4e7298d500ff57a6b2EX", 
      owner_arn: "arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_environments({
  environment_ids: ["EnvironmentId"], # required
})

Response structure


resp.environments #=> Array
resp.environments[0].id #=> String
resp.environments[0].name #=> String
resp.environments[0].description #=> String
resp.environments[0].type #=> String, one of "ssh", "ec2"
resp.environments[0].arn #=> String
resp.environments[0].owner_arn #=> String
resp.environments[0].lifecycle.status #=> String, one of "CREATED", "DELETING", "DELETE_FAILED"
resp.environments[0].lifecycle.reason #=> String
resp.environments[0].lifecycle.failure_resource #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :environment_ids (required, Array<String>) —

    The IDs of individual environments to get information about.

Returns:

See Also:



745
746
747
748
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 745

def describe_environments(params = {}, options = {})
  req = build_request(:describe_environments, params)
  req.send_request(options)
end

#list_environments(params = {}) ⇒ Types::ListEnvironmentsResult

Gets a list of AWS Cloud9 development environment identifiers.

Examples:

Example: ListEnvironments


resp = client.list_environments({
})

resp.to_h outputs the following:
{
  environment_ids: [
    "349c86d4579e4e7298d500ff57a6b2EX", 
    "45a3da47af0840f2b0c0824f5ee232EX", 
  ], 
}

Request syntax with placeholder values


resp = client.list_environments({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.environment_ids #=> Array
resp.environment_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (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.

  • :max_results (Integer) —

    The maximum number of environments to get identifiers for.

Returns:

See Also:



800
801
802
803
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 800

def list_environments(params = {}, options = {})
  req = build_request(:list_environments, params)
  req.send_request(options)
end

#update_environment(params = {}) ⇒ Struct

Changes the settings of an existing AWS Cloud9 development environment.

Examples:

Example: UpdateEnvironment


resp = client.update_environment({
  name: "my-changed-demo-environment", 
  description: "This is my changed demonstration environment.", 
  environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.update_environment({
  environment_id: "EnvironmentId", # required
  name: "EnvironmentName",
  description: "EnvironmentDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :environment_id (required, 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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



844
845
846
847
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 844

def update_environment(params = {}, options = {})
  req = build_request(:update_environment, params)
  req.send_request(options)
end

#update_environment_membership(params = {}) ⇒ Types::UpdateEnvironmentMembershipResult

Changes the settings of an existing environment member for an AWS Cloud9 development environment.

Examples:

Example: UpdateEnvironmentMembership


resp = client.update_environment_membership({
  environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
  permissions: "read-only", 
  user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
})

resp.to_h outputs the following:
{
  membership: {
    environment_id: "8d9967e2f0624182b74e7690ad69eb31", 
    permissions: "read-only", 
    user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
    user_id: "AIDAJ3BA6O2FMJWCWXHEX", 
  }, 
}

Request syntax with placeholder values


resp = client.update_environment_membership({
  environment_id: "EnvironmentId", # required
  user_arn: "UserArn", # required
  permissions: "read-write", # required, accepts read-write, read-only
})

Response structure


resp.membership.permissions #=> String, one of "owner", "read-write", "read-only"
resp.membership.user_id #=> String
resp.membership.user_arn #=> String
resp.membership.environment_id #=> String
resp.membership.last_access #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :environment_id (required, String) —

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

  • :user_arn (required, String) —

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

  • :permissions (required, 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.

Returns:

See Also:



911
912
913
914
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 911

def update_environment_membership(params = {}, options = {})
  req = build_request(:update_environment_membership, params)
  req.send_request(options)
end