lib/aws-sdk-cloud9/client.rb in aws-sdk-cloud9-1.33.0 vs lib/aws-sdk-cloud9/client.rb in aws-sdk-cloud9-1.34.0
- old
+ new
@@ -335,48 +335,52 @@
super
end
# @!group API Operations
- # Creates an AWS Cloud9 development environment, launches an Amazon
- # Elastic Compute Cloud (Amazon EC2) instance, and then connects from
- # the instance to the environment.
+ # Creates an Cloud9 development environment, launches an Amazon Elastic
+ # Compute Cloud (Amazon EC2) instance, and then connects from the
+ # instance to the environment.
#
# @option params [required, String] :name
# The name of the environment to create.
#
- # This name is visible to other AWS IAM users in the same AWS account.
+ # This name is visible to other IAM users in the same Amazon Web
+ # Services account.
#
# @option params [String] :description
# The description of the environment to create.
#
# @option params [String] :client_request_token
- # A unique, case-sensitive string that helps AWS Cloud9 to ensure this
+ # A unique, case-sensitive string that helps Cloud9 to ensure this
# operation completes no more than one time.
#
# For more information, see [Client Tokens][1] in the *Amazon EC2 API
# Reference*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
#
# @option params [required, String] :instance_type
# The type of instance to connect to the environment (for example,
# `t2.micro`).
#
# @option params [String] :subnet_id
- # The ID of the subnet in Amazon VPC that AWS Cloud9 will use to
- # communicate with the Amazon EC2 instance.
+ # The ID of the subnet in Amazon VPC that Cloud9 will use to communicate
+ # with the Amazon EC2 instance.
#
# @option params [String] :image_id
# 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 AWS Systems Manager (SSM) path.
+ # 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.
+ # 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.
#
# <b>AMI aliases </b>
#
# * <b>Amazon Linux (default): <code>amazonlinux-1-x86_64</code> </b>
#
@@ -400,24 +404,24 @@
# The number of minutes until the running instance is shut down after
# the environment has last been used.
#
# @option params [String] :owner_arn
# 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.
+ # be the ARN of any IAM principal. If this value is not specified, the
+ # ARN defaults to this environment's creator.
#
# @option params [Array<Types::Tag>] :tags
- # An array of key-value pairs that will be associated with the new AWS
+ # An array of key-value pairs that will be associated with the new
# Cloud9 development environment.
#
# @option params [String] :connection_type
# The connection type used for connecting to an Amazon EC2 environment.
# Valid values are `CONNECT_SSH` (default) and `CONNECT_SSM` (connected
- # through AWS Systems Manager).
+ # through Amazon EC2 Systems Manager).
#
- # For more information, see [Accessing no-ingress EC2 instances with AWS
- # Systems Manager][1] in the *AWS Cloud9 User Guide*.
+ # For more information, see [Accessing no-ingress EC2 instances with
+ # Amazon EC2 Systems Manager][1] in the *Cloud9 User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/cloud9/latest/user-guide/ec2-ssm.html
#
@@ -473,11 +477,11 @@
def create_environment_ec2(params = {}, options = {})
req = build_request(:create_environment_ec2, params)
req.send_request(options)
end
- # Adds an environment member to an AWS Cloud9 development environment.
+ # Adds an environment member to an Cloud9 development environment.
#
# @option params [required, String] :environment_id
# The ID of the environment that contains the environment member you
# want to add.
#
@@ -539,13 +543,12 @@
def create_environment_membership(params = {}, options = {})
req = build_request(:create_environment_membership, params)
req.send_request(options)
end
- # Deletes an AWS Cloud9 development environment. If an Amazon EC2
- # instance is connected to the environment, also terminates the
- # instance.
+ # Deletes an Cloud9 development environment. If an Amazon EC2 instance
+ # is connected to the environment, also terminates the instance.
#
# @option params [required, String] :environment_id
# The ID of the environment to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -574,12 +577,11 @@
def delete_environment(params = {}, options = {})
req = build_request(:delete_environment, params)
req.send_request(options)
end
- # Deletes an environment member from an AWS Cloud9 development
- # environment.
+ # Deletes an environment member from an Cloud9 development environment.
#
# @option params [required, String] :environment_id
# The ID of the environment to delete the environment member from.
#
# @option params [required, String] :user_arn
@@ -614,12 +616,12 @@
def delete_environment_membership(params = {}, options = {})
req = build_request(:delete_environment_membership, params)
req.send_request(options)
end
- # Gets information about environment members for an AWS Cloud9
- # development environment.
+ # Gets information about environment members for an Cloud9 development
+ # environment.
#
# @option params [String] :user_arn
# 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.
@@ -660,11 +662,11 @@
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
#
# @example Example: DescribeEnvironmentMemberships1
#
- # # The following example gets information about all of the environment members for the specified AWS Cloud9 development
+ # # 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",
# })
@@ -687,11 +689,11 @@
# ],
# }
#
# @example Example: DescribeEnvironmentMemberships2
#
- # # The following example gets information about the owner of the specified AWS Cloud9 development environment.
+ # # 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",
@@ -710,11 +712,11 @@
# ],
# }
#
# @example Example: DescribeEnvironmentMemberships3
#
- # # The following example gets AWS Cloud9 development environment membership information for the specified user.
+ # # 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",
# })
#
@@ -765,11 +767,11 @@
def describe_environment_memberships(params = {}, options = {})
req = build_request(:describe_environment_memberships, params)
req.send_request(options)
end
- # Gets status information for an AWS Cloud9 development environment.
+ # Gets status information for an Cloud9 development environment.
#
# @option params [required, String] :environment_id
# The ID of the environment to get status information about.
#
# @return [Types::DescribeEnvironmentStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -808,11 +810,11 @@
def describe_environment_status(params = {}, options = {})
req = build_request(:describe_environment_status, params)
req.send_request(options)
end
- # Gets information about AWS Cloud9 development environments.
+ # Gets information about Cloud9 development environments.
#
# @option params [required, Array<String>] :environment_ids
# The IDs of individual environments to get information about.
#
# @return [Types::DescribeEnvironmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -885,11 +887,11 @@
def describe_environments(params = {}, options = {})
req = build_request(:describe_environments, params)
req.send_request(options)
end
- # Gets a list of AWS Cloud9 development environment identifiers.
+ # Gets a list of Cloud9 development environment identifiers.
#
# @option params [String] :next_token
# 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,
@@ -942,16 +944,16 @@
def list_environments(params = {}, options = {})
req = build_request(:list_environments, params)
req.send_request(options)
end
- # Gets a list of the tags associated with an AWS Cloud9 development
+ # Gets a list of the tags associated with an Cloud9 development
# environment.
#
# @option params [required, String] :resource_arn
- # The Amazon Resource Name (ARN) of the AWS Cloud9 development
- # environment to get the tags for.
+ # The Amazon Resource Name (ARN) of the Cloud9 development environment
+ # to get the tags for.
#
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
#
@@ -974,22 +976,21 @@
def list_tags_for_resource(params = {}, options = {})
req = build_request(:list_tags_for_resource, params)
req.send_request(options)
end
- # Adds tags to an AWS Cloud9 development environment.
+ # Adds tags to an Cloud9 development environment.
#
- # Tags that you add to an AWS Cloud9 environment by using this method
- # will NOT be automatically propagated to underlying resources.
+ # Tags that you add to an Cloud9 environment by using this method will
+ # NOT be automatically propagated to underlying resources.
#
# @option params [required, String] :resource_arn
- # The Amazon Resource Name (ARN) of the AWS Cloud9 development
- # environment to add tags to.
+ # The Amazon Resource Name (ARN) of the Cloud9 development environment
+ # to add tags to.
#
# @option params [required, Array<Types::Tag>] :tags
- # The list of tags to add to the given AWS Cloud9 development
- # environment.
+ # The list of tags to add to the given Cloud9 development environment.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -1010,19 +1011,19 @@
def tag_resource(params = {}, options = {})
req = build_request(:tag_resource, params)
req.send_request(options)
end
- # Removes tags from an AWS Cloud9 development environment.
+ # Removes tags from an Cloud9 development environment.
#
# @option params [required, String] :resource_arn
- # The Amazon Resource Name (ARN) of the AWS Cloud9 development
- # environment to remove tags from.
+ # The Amazon Resource Name (ARN) of the Cloud9 development environment
+ # to remove tags from.
#
# @option params [required, Array<String>] :tag_keys
- # The tag names of the tags to remove from the given AWS Cloud9
- # development environment.
+ # The tag names of the tags to remove from the given Cloud9 development
+ # environment.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -1038,12 +1039,11 @@
def untag_resource(params = {}, options = {})
req = build_request(:untag_resource, params)
req.send_request(options)
end
- # Changes the settings of an existing AWS Cloud9 development
- # environment.
+ # Changes the settings of an existing Cloud9 development environment.
#
# @option params [required, String] :environment_id
# The ID of the environment to change settings.
#
# @option params [String] :name
@@ -1082,12 +1082,12 @@
def update_environment(params = {}, options = {})
req = build_request(:update_environment, params)
req.send_request(options)
end
- # Changes the settings of an existing environment member for an AWS
- # Cloud9 development environment.
+ # Changes the settings of an existing environment member for an Cloud9
+ # development environment.
#
# @option params [required, String] :environment_id
# The ID of the environment for the environment member whose settings
# you want to change.
#
@@ -1162,10 +1162,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-cloud9'
- context[:gem_version] = '1.33.0'
+ context[:gem_version] = '1.34.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated