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

Overview

An API client for Cloud9. To construct a client, you need to configure a :region and :credentials.

client = Aws::Cloud9::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :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 searched 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)
  • :account_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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :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_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::Cloud9::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Cloud9::EndpointParameters.

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



451
452
453
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 451

def initialize(*args)
  super
end

Instance Method Details

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

Creates an 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.", 
  image_id: "amazonlinux-2023-x86_64", 
  instance_type: "t2.micro", 
  owner_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
  subnet_id: "subnet-6300cd1b", 
})

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",
  image_id: "ImageId", # required
  automatic_stop_time_minutes: 1,
  owner_arn: "UserArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  connection_type: "CONNECT_SSH", # accepts CONNECT_SSH, CONNECT_SSM
  dry_run: false,
})

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 IAM users in the same Amazon Web Services account.

  • :description (String) —

    The description of the environment to create.

  • :client_request_token (String) —

    A unique, case-sensitive string that helps 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 Cloud9 will use to communicate with the Amazon EC2 instance.

  • :image_id (required, String) —

    The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path.

    From December 04, 2023, you will be required to include the imageId parameter for the CreateEnvironmentEC2 action. This change will be reflected across all direct methods of communicating with the API, such as Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will only affect direct API consumers, and not Cloud9 console users.

    We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported.

    Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

    AMI aliases

    • Amazon Linux 2: amazonlinux-2-x86_64

    • Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64

    • Ubuntu 18.04: ubuntu-18.04-x86_64

    • Ubuntu 22.04: ubuntu-22.04-x86_64

    SSM paths

    • Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64

    • Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64

    • Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64

    • Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64

  • :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 IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

  • :tags (Array<Types::Tag>) —

    An array of key-value pairs that will be associated with the new Cloud9 development environment.

  • :connection_type (String) —

    The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

    For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

See Also:



614
615
616
617
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 614

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 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:



680
681
682
683
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 680

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

#delete_environment(params = {}) ⇒ Struct

Deletes an 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:



714
715
716
717
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 714

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 a 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:



753
754
755
756
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 753

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 Cloud9 development environment.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeEnvironmentMemberships1


# The following example gets information about all of the environment members for the specified 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 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 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:



903
904
905
906
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 903

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 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:



946
947
948
949
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 946

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 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", 
      lifecycle: {
        status: "CREATED", 
      }, 
      owner_arn: "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", 
      }, 
      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].connection_type #=> String, one of "CONNECT_SSH", "CONNECT_SSM"
resp.environments[0].arn #=> String
resp.environments[0].owner_arn #=> String
resp.environments[0].lifecycle.status #=> String, one of "CREATING", "CREATED", "CREATE_FAILED", "DELETING", "DELETE_FAILED"
resp.environments[0].lifecycle.reason #=> String
resp.environments[0].lifecycle.failure_resource #=> String
resp.environments[0].managed_credentials_status #=> String, one of "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"

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:



1023
1024
1025
1026
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 1023

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 Cloud9 development environment identifiers.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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:



1080
1081
1082
1083
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 1080

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Gets a list of the tags associated with an Cloud9 development environment.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "EnvironmentArn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



1112
1113
1114
1115
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 1112

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to an Cloud9 development environment.

Tags that you add to an Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "EnvironmentArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Array<Types::Tag>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1147
1148
1149
1150
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 1147

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from an Cloud9 development environment.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "EnvironmentArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1175
1176
1177
1178
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 1175

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

#update_environment(params = {}) ⇒ Struct

Changes the settings of an existing 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",
  managed_credentials_action: "ENABLE", # accepts ENABLE, DISABLE
})

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.

  • :managed_credentials_action (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

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1235
1236
1237
1238
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 1235

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 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:



1302
1303
1304
1305
 
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/client.rb', line 1302

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