libZSservicesZSamazonka-cloud9ZSamazonka-cloud9
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Cloud9.Lens

Description

 
Synopsis

Operations

ListEnvironments

listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text) Source #

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.

listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural) Source #

The maximum number of environments to get identifiers for.

listEnvironmentsResponse_nextToken :: Lens' ListEnvironmentsResponse (Maybe Text) Source #

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.

UpdateEnvironment

updateEnvironment_managedCredentialsAction :: Lens' UpdateEnvironment (Maybe ManagedCredentialsAction) Source #

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.

updateEnvironment_name :: Lens' UpdateEnvironment (Maybe Text) Source #

A replacement name for the environment.

updateEnvironment_description :: Lens' UpdateEnvironment (Maybe Text) Source #

Any new or replacement description for the environment.

updateEnvironment_environmentId :: Lens' UpdateEnvironment Text Source #

The ID of the environment to change settings.

DeleteEnvironment

deleteEnvironment_environmentId :: Lens' DeleteEnvironment Text Source #

The ID of the environment to delete.

DescribeEnvironmentStatus

describeEnvironmentStatus_environmentId :: Lens' DescribeEnvironmentStatus Text Source #

The ID of the environment to get status information about.

describeEnvironmentStatusResponse_status :: Lens' DescribeEnvironmentStatusResponse EnvironmentStatus Source #

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.

describeEnvironmentStatusResponse_message :: Lens' DescribeEnvironmentStatusResponse Text Source #

Any informational message about the status of the environment.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

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

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

The list of tags associated with the Cloud9 development environment.

CreateEnvironmentEC2

createEnvironmentEC2_automaticStopTimeMinutes :: Lens' CreateEnvironmentEC2 (Maybe Int) Source #

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

createEnvironmentEC2_subnetId :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

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

createEnvironmentEC2_ownerArn :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

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.

createEnvironmentEC2_imageId :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

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

createEnvironmentEC2_clientRequestToken :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

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.

createEnvironmentEC2_connectionType :: Lens' CreateEnvironmentEC2 (Maybe ConnectionType) Source #

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.

createEnvironmentEC2_description :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

The description of the environment to create.

createEnvironmentEC2_dryRun :: Lens' CreateEnvironmentEC2 (Maybe Bool) Source #

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.

createEnvironmentEC2_tags :: Lens' CreateEnvironmentEC2 (Maybe [Tag]) Source #

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

createEnvironmentEC2_name :: Lens' CreateEnvironmentEC2 Text Source #

The name of the environment to create.

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

createEnvironmentEC2_instanceType :: Lens' CreateEnvironmentEC2 Text Source #

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

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

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

tagResource_tags :: Lens' TagResource [Tag] Source #

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

CreateEnvironmentMembership

createEnvironmentMembership_environmentId :: Lens' CreateEnvironmentMembership Text Source #

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

createEnvironmentMembership_userArn :: Lens' CreateEnvironmentMembership Text Source #

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

createEnvironmentMembership_permissions :: Lens' CreateEnvironmentMembership MemberPermissions Source #

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.

DescribeEnvironments

describeEnvironments_environmentIds :: Lens' DescribeEnvironments (NonEmpty Text) Source #

The IDs of individual environments to get information about.

describeEnvironmentsResponse_environments :: Lens' DescribeEnvironmentsResponse (Maybe [Environment]) Source #

Information about the environments that are returned.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

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

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

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

DeleteEnvironmentMembership

deleteEnvironmentMembership_environmentId :: Lens' DeleteEnvironmentMembership Text Source #

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

deleteEnvironmentMembership_userArn :: Lens' DeleteEnvironmentMembership Text Source #

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

UpdateEnvironmentMembership

updateEnvironmentMembership_environmentId :: Lens' UpdateEnvironmentMembership Text Source #

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

updateEnvironmentMembership_userArn :: Lens' UpdateEnvironmentMembership Text Source #

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

updateEnvironmentMembership_permissions :: Lens' UpdateEnvironmentMembership MemberPermissions Source #

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.

updateEnvironmentMembershipResponse_membership :: Lens' UpdateEnvironmentMembershipResponse (Maybe EnvironmentMember) Source #

Information about the environment member whose settings were changed.

DescribeEnvironmentMemberships

describeEnvironmentMemberships_userArn :: Lens' DescribeEnvironmentMemberships (Maybe Text) Source #

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.

describeEnvironmentMemberships_nextToken :: Lens' DescribeEnvironmentMemberships (Maybe Text) Source #

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.

describeEnvironmentMemberships_permissions :: Lens' DescribeEnvironmentMemberships (Maybe [Permissions]) Source #

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.

describeEnvironmentMemberships_environmentId :: Lens' DescribeEnvironmentMemberships (Maybe Text) Source #

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

describeEnvironmentMemberships_maxResults :: Lens' DescribeEnvironmentMemberships (Maybe Natural) Source #

The maximum number of environment members to get information about.

describeEnvironmentMembershipsResponse_nextToken :: Lens' DescribeEnvironmentMembershipsResponse (Maybe Text) Source #

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.

Types

Environment

environment_lifecycle :: Lens' Environment (Maybe EnvironmentLifecycle) Source #

The state of the environment in its creation or deletion lifecycle.

environment_name :: Lens' Environment (Maybe Text) Source #

The name of the environment.

environment_id :: Lens' Environment (Maybe Text) Source #

The ID of the environment.

environment_connectionType :: Lens' Environment (Maybe ConnectionType) Source #

The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default.

environment_description :: Lens' Environment (Maybe Text) Source #

The description for the environment.

environment_managedCredentialsStatus :: Lens' Environment (Maybe ManagedCredentialsStatus) Source #

Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:

  • ENABLED_ON_CREATE
  • ENABLED_BY_OWNER
  • DISABLED_BY_DEFAULT
  • DISABLED_BY_OWNER
  • DISABLED_BY_COLLABORATOR
  • PENDING_REMOVAL_BY_COLLABORATOR
  • PENDING_REMOVAL_BY_OWNER
  • FAILED_REMOVAL_BY_COLLABORATOR
  • ENABLED_BY_OWNER
  • DISABLED_BY_DEFAULT

environment_type :: Lens' Environment EnvironmentType Source #

The type of environment. Valid values include the following:

  • ec2: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.
  • ssh: Your own server connects to the environment.

environment_arn :: Lens' Environment Text Source #

The Amazon Resource Name (ARN) of the environment.

environment_ownerArn :: Lens' Environment Text Source #

The Amazon Resource Name (ARN) of the environment owner.

EnvironmentLifecycle

environmentLifecycle_status :: Lens' EnvironmentLifecycle (Maybe EnvironmentLifecycleStatus) Source #

The current creation or deletion lifecycle state of the environment.

  • CREATING: The environment is in the process of being created.
  • CREATED: The environment was successfully created.
  • CREATE_FAILED: The environment failed to be created.
  • DELETING: The environment is in the process of being deleted.
  • DELETE_FAILED: The environment failed to delete.

environmentLifecycle_failureResource :: Lens' EnvironmentLifecycle (Maybe Text) Source #

If the environment failed to delete, the Amazon Resource Name (ARN) of the related Amazon Web Services resource.

environmentLifecycle_reason :: Lens' EnvironmentLifecycle (Maybe Text) Source #

Any informational message about the lifecycle state of the environment.

EnvironmentMember

environmentMember_lastAccess :: Lens' EnvironmentMember (Maybe UTCTime) Source #

The time, expressed in epoch time format, when the environment member last opened the environment.

environmentMember_permissions :: Lens' EnvironmentMember Permissions Source #

The type of environment member permissions associated with this environment member. 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.

environmentMember_userId :: Lens' EnvironmentMember Text Source #

The user ID in Identity and Access Management (IAM) of the environment member.

environmentMember_userArn :: Lens' EnvironmentMember Text Source #

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

environmentMember_environmentId :: Lens' EnvironmentMember Text Source #

The ID of the environment for the environment member.

Tag

tag_key :: Lens' Tag Text Source #

The name part of a tag.

tag_value :: Lens' Tag Text Source #

The value part of a tag.