Struct aws_sdk_cloud9::client::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_cloud9::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_cloud9::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_cloud9::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn create_environment_ec2(&self) -> CreateEnvironmentEC2
pub fn create_environment_ec2(&self) -> CreateEnvironmentEC2
Constructs a fluent builder for the CreateEnvironmentEC2
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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>)
:The description of the environment to create.
client_request_token(impl Into<String>)
/set_client_request_token(Option<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(impl Into<String>)
/set_instance_type(Option<String>)
:The type of instance to connect to the environment (for example,
t2.micro
).subnet_id(impl Into<String>)
/set_subnet_id(Option<String>)
: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>)
: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.
The default AMI is used if the parameter isn’t explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.
AMI aliases
-
Amazon Linux (default):
amazonlinux-1-x86_64
-
Amazon Linux 2:
amazonlinux-2-x86_64
-
Ubuntu 18.04:
ubuntu-18.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
-
automatic_stop_time_minutes(i32)
/set_automatic_stop_time_minutes(Option<i32>)
: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>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:An array of key-value pairs that will be associated with the new Cloud9 development environment.
connection_type(ConnectionType)
/set_connection_type(Option<ConnectionType>)
:The connection type used for connecting to an Amazon EC2 environment. Valid values are
CONNECT_SSH
(default) andCONNECT_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>)
: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 isUnauthorizedOperation
.
- 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>
sourcepub fn create_environment_membership(&self) -> CreateEnvironmentMembership
pub fn create_environment_membership(&self) -> CreateEnvironmentMembership
Constructs a fluent builder for the CreateEnvironmentMembership
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:The ID of the environment that contains the environment member you want to add.
user_arn(impl Into<String>)
/set_user_arn(Option<String>)
:The Amazon Resource Name (ARN) of the environment member you want to add.
permissions(MemberPermissions)
/set_permissions(Option<MemberPermissions>)
: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>
sourcepub fn delete_environment(&self) -> DeleteEnvironment
pub fn delete_environment(&self) -> DeleteEnvironment
Constructs a fluent builder for the DeleteEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:The ID of the environment to delete.
- On success, responds with
DeleteEnvironmentOutput
- On failure, responds with
SdkError<DeleteEnvironmentError>
sourcepub fn delete_environment_membership(&self) -> DeleteEnvironmentMembership
pub fn delete_environment_membership(&self) -> DeleteEnvironmentMembership
Constructs a fluent builder for the DeleteEnvironmentMembership
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:The ID of the environment to delete the environment member from.
user_arn(impl Into<String>)
/set_user_arn(Option<String>)
: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>
sourcepub fn describe_environment_memberships(&self) -> DescribeEnvironmentMemberships
pub fn describe_environment_memberships(&self) -> DescribeEnvironmentMemberships
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>)
: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>)
:The ID of the environment to get environment member information about.
permissions(Vec<Permissions>)
/set_permissions(Option<Vec<Permissions>>)
:The type of environment member permissions to get information about. Available values include:
-
owner
: Owns the environment. -
read-only
: Has read-only access to the environment. -
read-write
: Has read-write access to the environment.
If no value is specified, information about all environment members are returned.
-
next_token(impl Into<String>)
/set_next_token(Option<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(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn describe_environments(&self) -> DescribeEnvironments
pub fn describe_environments(&self) -> DescribeEnvironments
Constructs a fluent builder for the DescribeEnvironments
operation.
- The fluent builder is configurable:
environment_ids(Vec<String>)
/set_environment_ids(Option<Vec<String>>)
: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>
sourcepub fn describe_environment_status(&self) -> DescribeEnvironmentStatus
pub fn describe_environment_status(&self) -> DescribeEnvironmentStatus
Constructs a fluent builder for the DescribeEnvironmentStatus
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:The ID of the environment to get status information about.
- On success, responds with
DescribeEnvironmentStatusOutput
with field(s):status(Option<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(Option<String>)
:Any informational message about the status of the environment.
- On failure, responds with
SdkError<DescribeEnvironmentStatusError>
sourcepub fn list_environments(&self) -> ListEnvironments
pub fn list_environments(&self) -> ListEnvironments
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>)
: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>)
: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>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
: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>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Cloud9 development environment to add tags to.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The list of tags to add to the given Cloud9 development environment.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Cloud9 development environment to remove tags from.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
: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>
sourcepub fn update_environment(&self) -> UpdateEnvironment
pub fn update_environment(&self) -> UpdateEnvironment
Constructs a fluent builder for the UpdateEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:The ID of the environment to change settings.
name(impl Into<String>)
/set_name(Option<String>)
:A replacement name for the environment.
description(impl Into<String>)
/set_description(Option<String>)
:Any new or replacement description for the environment.
managed_credentials_action(ManagedCredentialsAction)
/set_managed_credentials_action(Option<ManagedCredentialsAction>)
: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>
sourcepub fn update_environment_membership(&self) -> UpdateEnvironmentMembership
pub fn update_environment_membership(&self) -> UpdateEnvironmentMembership
Constructs a fluent builder for the UpdateEnvironmentMembership
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
: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>)
:The Amazon Resource Name (ARN) of the environment member whose settings you want to change.
permissions(MemberPermissions)
/set_permissions(Option<MemberPermissions>)
: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>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more