Struct aws_sdk_cloud9::Client

pub struct Client { /* private fields */ }

Client for AWS Cloud9

Client for invoking operations on AWS Cloud9. Each operation on AWS Cloud9 is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_cloud9::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_cloud9::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateEnvironmentEC2 operation has a Client::create_environment_ec2, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_environment_ec2()
    .name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_environment_ec2(&self) -> CreateEnvironmentEC2FluentBuilder

Constructs a fluent builder for the CreateEnvironmentEC2 operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the environment to create.

    This name is visible to other IAM users in the same Amazon Web Services account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the environment to create.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    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(impl Into<String>) / set_instance_type(Option<String>):
    required: true
    

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

    
    
  • subnet_id(impl Into<String>) / set_subnet_id(Option<String>):
    required: false
    

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

    
    
  • image_id(impl Into<String>) / set_image_id(Option<String>):
    required: false
    

    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.

    From January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not Cloud9 console users.

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

    AMI aliases

    • Amazon Linux (default): amazonlinux-1-x86_64

    • Amazon Linux 2: amazonlinux-2-x86_64

    • Ubuntu 18.04: ubuntu-18.04-x86_64

    • Ubuntu 22.04: ubuntu-22.04-x86_64

    SSM paths

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

    • Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-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(i32) / set_automatic_stop_time_minutes(Option<i32>):
    required: false
    

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

    
    
  • owner_arn(impl Into<String>) / set_owner_arn(Option<String>):
    required: false
    

    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(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

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

    
    
  • connection_type(ConnectionType) / set_connection_type(Option<ConnectionType>):
    required: false
    

    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(bool) / set_dry_run(Option<bool>):
    required: false
    

    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.

    
    
• On success, responds with CreateEnvironmentEc2Output with field(s):
  • environment_id(Option<String>):

    The ID of the environment that was created.

• On failure, responds with SdkError<CreateEnvironmentEC2Error>

impl Client

pub fn create_environment_membership( &self ) -> CreateEnvironmentMembershipFluentBuilder

Constructs a fluent builder for the CreateEnvironmentMembership operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):
    required: true
    

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

    
    
  • user_arn(impl Into<String>) / set_user_arn(Option<String>):
    required: true
    

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

    
    
  • permissions(MemberPermissions) / set_permissions(Option<MemberPermissions>):
    required: true
    

    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.

    
    
• On success, responds with CreateEnvironmentMembershipOutput with field(s):
  • membership(Option<EnvironmentMember>):

    Information about the environment member that was added.

• On failure, responds with SdkError<CreateEnvironmentMembershipError>

impl Client

pub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder

Constructs a fluent builder for the DeleteEnvironment operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):
    required: true
    

    The ID of the environment to delete.

    
    
• On success, responds with DeleteEnvironmentOutput
• On failure, responds with SdkError<DeleteEnvironmentError>

impl Client

pub fn delete_environment_membership( &self ) -> DeleteEnvironmentMembershipFluentBuilder

Constructs a fluent builder for the DeleteEnvironmentMembership operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):
    required: true
    

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

    
    
  • user_arn(impl Into<String>) / set_user_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteEnvironmentMembershipOutput
• On failure, responds with SdkError<DeleteEnvironmentMembershipError>

impl Client

pub fn describe_environment_memberships( &self ) -> DescribeEnvironmentMembershipsFluentBuilder

Constructs a fluent builder for the DescribeEnvironmentMemberships operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • user_arn(impl Into<String>) / set_user_arn(Option<String>):
    required: false
    

    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(impl Into<String>) / set_environment_id(Option<String>):
    required: false
    

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

    
    
  • permissions(Permissions) / set_permissions(Option<Vec::<Permissions>>):
    required: false
    

    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(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of environment members to get information about.

    
    
• On success, responds with DescribeEnvironmentMembershipsOutput with field(s):
  • memberships(Option<Vec::<EnvironmentMember>>):

    Information about the environment members for the environment.

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

• On failure, responds with SdkError<DescribeEnvironmentMembershipsError>

impl Client

pub fn describe_environment_status( &self ) -> DescribeEnvironmentStatusFluentBuilder

Constructs a fluent builder for the DescribeEnvironmentStatus operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):
    required: true
    

    The ID of the environment to get status information about.

    
    
• On success, responds with DescribeEnvironmentStatusOutput with field(s):
  • status(EnvironmentStatus):

    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.

  • message(String):

    Any informational message about the status of the environment.

• On failure, responds with SdkError<DescribeEnvironmentStatusError>

impl Client

pub fn describe_environments(&self) -> DescribeEnvironmentsFluentBuilder

Constructs a fluent builder for the DescribeEnvironments operation.

• The fluent builder is configurable:
  • environment_ids(impl Into<String>) / set_environment_ids(Option<Vec::<String>>):
    required: true
    

    The IDs of individual environments to get information about.

    
    
• On success, responds with DescribeEnvironmentsOutput with field(s):
  • environments(Option<Vec::<Environment>>):

    Information about the environments that are returned.

• On failure, responds with SdkError<DescribeEnvironmentsError>

impl Client

pub fn list_environments(&self) -> ListEnvironmentsFluentBuilder

Constructs a fluent builder for the ListEnvironments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of environments to get identifiers for.

    
    
• On success, responds with ListEnvironmentsOutput with field(s):
  • next_token(Option<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.

  • environment_ids(Option<Vec::<String>>):

    The list of environment identifiers.

• On failure, responds with SdkError<ListEnvironmentsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The list of tags associated with the Cloud9 development environment.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

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

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

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

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder

Constructs a fluent builder for the UpdateEnvironment operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):
    required: true
    

    The ID of the environment to change settings.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A replacement name for the environment.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Any new or replacement description for the environment.

    
    
  • managed_credentials_action(ManagedCredentialsAction) / set_managed_credentials_action(Option<ManagedCredentialsAction>):
    required: false
    

    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.

    
    
• On success, responds with UpdateEnvironmentOutput
• On failure, responds with SdkError<UpdateEnvironmentError>

impl Client

pub fn update_environment_membership( &self ) -> UpdateEnvironmentMembershipFluentBuilder

Constructs a fluent builder for the UpdateEnvironmentMembership operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):
    required: true
    

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

    
    
  • user_arn(impl Into<String>) / set_user_arn(Option<String>):
    required: true
    

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

    
    
  • permissions(MemberPermissions) / set_permissions(Option<MemberPermissions>):
    required: true
    

    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.

    
    
• On success, responds with UpdateEnvironmentMembershipOutput with field(s):
  • membership(Option<EnvironmentMember>):

    Information about the environment member whose settings were changed.

• On failure, responds with SdkError<UpdateEnvironmentMembershipError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.