| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Cloud9
Description
Derived from API version 2017-09-23 of the AWS service descriptions, licensed under Apache 2.0.
Cloud9
Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.
For more information about Cloud9, see the Cloud9 User Guide.
Cloud9 supports these operations:
CreateEnvironmentEC2: Creates an Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.CreateEnvironmentMembership: Adds an environment member to an environment.DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.DeleteEnvironmentMembership: Deletes an environment member from an environment.DescribeEnvironmentMemberships: Gets information about environment members for an environment.DescribeEnvironments: Gets information about environments.DescribeEnvironmentStatus: Gets status information for an environment.ListEnvironments: Gets a list of environment identifiers.ListTagsForResource: Gets the tags for an environment.TagResource: Adds tags to an environment.UntagResource: Removes tags from an environment.UpdateEnvironment: Changes the settings of an existing environment.UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConcurrentAccessException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _ForbiddenException :: AsError a => Fold a ServiceError
- _InternalServerErrorException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- data CreateEnvironmentEC2 = CreateEnvironmentEC2' (Maybe Int) (Maybe Text) (Maybe ConnectionType) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive [Sensitive Tag])) Text Text
- newCreateEnvironmentEC2 :: Text -> Text -> CreateEnvironmentEC2
- data CreateEnvironmentEC2Response = CreateEnvironmentEC2Response' (Maybe Text) Int
- newCreateEnvironmentEC2Response :: Int -> CreateEnvironmentEC2Response
- data CreateEnvironmentMembership = CreateEnvironmentMembership' Text Text MemberPermissions
- newCreateEnvironmentMembership :: Text -> Text -> MemberPermissions -> CreateEnvironmentMembership
- data CreateEnvironmentMembershipResponse = CreateEnvironmentMembershipResponse' Int EnvironmentMember
- newCreateEnvironmentMembershipResponse :: Int -> EnvironmentMember -> CreateEnvironmentMembershipResponse
- data DeleteEnvironment = DeleteEnvironment' Text
- newDeleteEnvironment :: Text -> DeleteEnvironment
- data DeleteEnvironmentResponse = DeleteEnvironmentResponse' Int
- newDeleteEnvironmentResponse :: Int -> DeleteEnvironmentResponse
- data DeleteEnvironmentMembership = DeleteEnvironmentMembership' Text Text
- newDeleteEnvironmentMembership :: Text -> Text -> DeleteEnvironmentMembership
- data DeleteEnvironmentMembershipResponse = DeleteEnvironmentMembershipResponse' Int
- newDeleteEnvironmentMembershipResponse :: Int -> DeleteEnvironmentMembershipResponse
- data DescribeEnvironmentMemberships = DescribeEnvironmentMemberships' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe [Permissions]) (Maybe Text)
- newDescribeEnvironmentMemberships :: DescribeEnvironmentMemberships
- data DescribeEnvironmentMembershipsResponse = DescribeEnvironmentMembershipsResponse' (Maybe [EnvironmentMember]) (Maybe Text) Int
- newDescribeEnvironmentMembershipsResponse :: Int -> DescribeEnvironmentMembershipsResponse
- data DescribeEnvironmentStatus = DescribeEnvironmentStatus' Text
- newDescribeEnvironmentStatus :: Text -> DescribeEnvironmentStatus
- data DescribeEnvironmentStatusResponse = DescribeEnvironmentStatusResponse' Int EnvironmentStatus Text
- newDescribeEnvironmentStatusResponse :: Int -> EnvironmentStatus -> Text -> DescribeEnvironmentStatusResponse
- data DescribeEnvironments = DescribeEnvironments' (NonEmpty Text)
- newDescribeEnvironments :: NonEmpty Text -> DescribeEnvironments
- data DescribeEnvironmentsResponse = DescribeEnvironmentsResponse' (Maybe [Environment]) Int
- newDescribeEnvironmentsResponse :: Int -> DescribeEnvironmentsResponse
- data ListEnvironments = ListEnvironments' (Maybe Natural) (Maybe Text)
- newListEnvironments :: ListEnvironments
- data ListEnvironmentsResponse = ListEnvironmentsResponse' (Maybe [Text]) (Maybe Text) Int
- newListEnvironmentsResponse :: Int -> ListEnvironmentsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (Sensitive [Sensitive Tag])) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data TagResource = TagResource' Text (Sensitive [Sensitive Tag])
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (Sensitive [Sensitive Text])
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateEnvironment = UpdateEnvironment' (Maybe (Sensitive Text)) (Maybe ManagedCredentialsAction) (Maybe Text) Text
- newUpdateEnvironment :: Text -> UpdateEnvironment
- data UpdateEnvironmentResponse = UpdateEnvironmentResponse' Int
- newUpdateEnvironmentResponse :: Int -> UpdateEnvironmentResponse
- data UpdateEnvironmentMembership = UpdateEnvironmentMembership' Text Text MemberPermissions
- newUpdateEnvironmentMembership :: Text -> Text -> MemberPermissions -> UpdateEnvironmentMembership
- data UpdateEnvironmentMembershipResponse = UpdateEnvironmentMembershipResponse' (Maybe EnvironmentMember) Int
- newUpdateEnvironmentMembershipResponse :: Int -> UpdateEnvironmentMembershipResponse
- newtype ConnectionType where
- ConnectionType' { }
- pattern ConnectionType_CONNECT_SSH :: ConnectionType
- pattern ConnectionType_CONNECT_SSM :: ConnectionType
- newtype EnvironmentLifecycleStatus where
- EnvironmentLifecycleStatus' { }
- pattern EnvironmentLifecycleStatus_CREATED :: EnvironmentLifecycleStatus
- pattern EnvironmentLifecycleStatus_CREATE_FAILED :: EnvironmentLifecycleStatus
- pattern EnvironmentLifecycleStatus_CREATING :: EnvironmentLifecycleStatus
- pattern EnvironmentLifecycleStatus_DELETE_FAILED :: EnvironmentLifecycleStatus
- pattern EnvironmentLifecycleStatus_DELETING :: EnvironmentLifecycleStatus
- newtype EnvironmentStatus where
- EnvironmentStatus' { }
- pattern EnvironmentStatus_Connecting :: EnvironmentStatus
- pattern EnvironmentStatus_Creating :: EnvironmentStatus
- pattern EnvironmentStatus_Deleting :: EnvironmentStatus
- pattern EnvironmentStatus_Error :: EnvironmentStatus
- pattern EnvironmentStatus_Ready :: EnvironmentStatus
- pattern EnvironmentStatus_Stopped :: EnvironmentStatus
- pattern EnvironmentStatus_Stopping :: EnvironmentStatus
- newtype EnvironmentType where
- EnvironmentType' { }
- pattern EnvironmentType_Ec2 :: EnvironmentType
- pattern EnvironmentType_Ssh :: EnvironmentType
- newtype ManagedCredentialsAction where
- newtype ManagedCredentialsStatus where
- ManagedCredentialsStatus' { }
- pattern ManagedCredentialsStatus_DISABLED_BY_COLLABORATOR :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_DISABLED_BY_DEFAULT :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_DISABLED_BY_OWNER :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_ENABLED_BY_OWNER :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_ENABLED_ON_CREATE :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_FAILED_REMOVAL_BY_COLLABORATOR :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_FAILED_REMOVAL_BY_OWNER :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_PENDING_REMOVAL_BY_COLLABORATOR :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_PENDING_REMOVAL_BY_OWNER :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_PENDING_START_REMOVAL_BY_COLLABORATOR :: ManagedCredentialsStatus
- pattern ManagedCredentialsStatus_PENDING_START_REMOVAL_BY_OWNER :: ManagedCredentialsStatus
- newtype MemberPermissions where
- MemberPermissions' { }
- pattern MemberPermissions_Read_only :: MemberPermissions
- pattern MemberPermissions_Read_write :: MemberPermissions
- newtype Permissions where
- Permissions' { }
- pattern Permissions_Owner :: Permissions
- pattern Permissions_Read_only :: Permissions
- pattern Permissions_Read_write :: Permissions
- data Environment = Environment' (Maybe ConnectionType) (Maybe (Sensitive Text)) (Maybe Text) (Maybe EnvironmentLifecycle) (Maybe ManagedCredentialsStatus) (Maybe Text) EnvironmentType Text Text
- newEnvironment :: EnvironmentType -> Text -> Text -> Environment
- data EnvironmentLifecycle = EnvironmentLifecycle' (Maybe Text) (Maybe Text) (Maybe EnvironmentLifecycleStatus)
- newEnvironmentLifecycle :: EnvironmentLifecycle
- data EnvironmentMember = EnvironmentMember' (Maybe POSIX) Permissions Text Text Text
- newEnvironmentMember :: Permissions -> Text -> Text -> Text -> EnvironmentMember
- data Tag = Tag' (Sensitive Text) (Sensitive Text)
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2017-09-23 of the Amazon Cloud9 SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Cloud9.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
The target request is invalid.
ConcurrentAccessException
_ConcurrentAccessException :: AsError a => Fold a ServiceError Source #
A concurrent access issue occurred.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
A conflict occurred.
ForbiddenException
_ForbiddenException :: AsError a => Fold a ServiceError Source #
An access permissions issue occurred.
InternalServerErrorException
_InternalServerErrorException :: AsError a => Fold a ServiceError Source #
An internal server error occurred.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A service limit was exceeded.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
The target resource cannot be found.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
Too many service requests were made over the given time period.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateEnvironmentEC2
data CreateEnvironmentEC2 Source #
See: newCreateEnvironmentEC2 smart constructor.
Constructors
| CreateEnvironmentEC2' (Maybe Int) (Maybe Text) (Maybe ConnectionType) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive [Sensitive Tag])) Text Text |
Instances
newCreateEnvironmentEC2 Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateEnvironmentEC2 |
Create a value of CreateEnvironmentEC2 with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticStopTimeMinutes:CreateEnvironmentEC2', createEnvironmentEC2_automaticStopTimeMinutes - The number of minutes until the running instance is shut down after the
environment has last been used.
$sel:clientRequestToken:CreateEnvironmentEC2', createEnvironmentEC2_clientRequestToken - 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, createEnvironmentEC2_connectionType - 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, createEnvironmentEC2_description - The description of the environment to create.
$sel:dryRun:CreateEnvironmentEC2', createEnvironmentEC2_dryRun - 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.
$sel:imageId:CreateEnvironmentEC2', createEnvironmentEC2_imageId - 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 Amazon Linux AMI is currently used if the parameter isn't explicitly assigned a value in the request.
In the future the parameter for Amazon Linux will no longer be available when you specify an AMI for your instance. Amazon Linux 2 will then become the default AMI, which is used to launch your instance if no parameter is explicitly defined.
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, createEnvironmentEC2_ownerArn - 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.
$sel:subnetId:CreateEnvironmentEC2', createEnvironmentEC2_subnetId - The ID of the subnet in Amazon VPC that Cloud9 will use to communicate
with the Amazon EC2 instance.
$sel:tags:CreateEnvironmentEC2', createEnvironmentEC2_tags - An array of key-value pairs that will be associated with the new Cloud9
development environment.
CreateEnvironmentEC2, createEnvironmentEC2_name - The name of the environment to create.
This name is visible to other IAM users in the same Amazon Web Services account.
$sel:instanceType:CreateEnvironmentEC2', createEnvironmentEC2_instanceType - The type of instance to connect to the environment (for example,
t2.micro).
data CreateEnvironmentEC2Response Source #
See: newCreateEnvironmentEC2Response smart constructor.
Constructors
| CreateEnvironmentEC2Response' (Maybe Text) Int |
Instances
newCreateEnvironmentEC2Response Source #
Create a value of CreateEnvironmentEC2Response with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateEnvironmentEC2Response, createEnvironmentEC2Response_environmentId - The ID of the environment that was created.
$sel:httpStatus:CreateEnvironmentEC2Response', createEnvironmentEC2Response_httpStatus - The response's http status code.
CreateEnvironmentMembership
data CreateEnvironmentMembership Source #
See: newCreateEnvironmentMembership smart constructor.
Constructors
| CreateEnvironmentMembership' Text Text MemberPermissions |
Instances
newCreateEnvironmentMembership Source #
Arguments
| :: Text | |
| -> Text | |
| -> MemberPermissions | |
| -> CreateEnvironmentMembership |
Create a value of CreateEnvironmentMembership with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateEnvironmentMembership, createEnvironmentMembership_environmentId - The ID of the environment that contains the environment member you want
to add.
CreateEnvironmentMembership, createEnvironmentMembership_userArn - The Amazon Resource Name (ARN) of the environment member you want to
add.
CreateEnvironmentMembership, createEnvironmentMembership_permissions - 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.
data CreateEnvironmentMembershipResponse Source #
See: newCreateEnvironmentMembershipResponse smart constructor.
Constructors
| CreateEnvironmentMembershipResponse' Int EnvironmentMember |
Instances
newCreateEnvironmentMembershipResponse Source #
Arguments
| :: Int | |
| -> EnvironmentMember | |
| -> CreateEnvironmentMembershipResponse |
Create a value of CreateEnvironmentMembershipResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateEnvironmentMembershipResponse', createEnvironmentMembershipResponse_httpStatus - The response's http status code.
$sel:membership:CreateEnvironmentMembershipResponse', createEnvironmentMembershipResponse_membership - Information about the environment member that was added.
DeleteEnvironment
data DeleteEnvironment Source #
See: newDeleteEnvironment smart constructor.
Constructors
| DeleteEnvironment' Text |
Instances
Arguments
| :: Text | |
| -> DeleteEnvironment |
Create a value of DeleteEnvironment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEnvironment, deleteEnvironment_environmentId - The ID of the environment to delete.
data DeleteEnvironmentResponse Source #
See: newDeleteEnvironmentResponse smart constructor.
Constructors
| DeleteEnvironmentResponse' Int |
Instances
newDeleteEnvironmentResponse Source #
Create a value of DeleteEnvironmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEnvironmentResponse', deleteEnvironmentResponse_httpStatus - The response's http status code.
DeleteEnvironmentMembership
data DeleteEnvironmentMembership Source #
See: newDeleteEnvironmentMembership smart constructor.
Constructors
| DeleteEnvironmentMembership' Text Text |
Instances
newDeleteEnvironmentMembership Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteEnvironmentMembership |
Create a value of DeleteEnvironmentMembership with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEnvironmentMembership, deleteEnvironmentMembership_environmentId - The ID of the environment to delete the environment member from.
DeleteEnvironmentMembership, deleteEnvironmentMembership_userArn - The Amazon Resource Name (ARN) of the environment member to delete from
the environment.
data DeleteEnvironmentMembershipResponse Source #
See: newDeleteEnvironmentMembershipResponse smart constructor.
Constructors
| DeleteEnvironmentMembershipResponse' Int |
Instances
newDeleteEnvironmentMembershipResponse Source #
Arguments
| :: Int | |
| -> DeleteEnvironmentMembershipResponse |
Create a value of DeleteEnvironmentMembershipResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEnvironmentMembershipResponse', deleteEnvironmentMembershipResponse_httpStatus - The response's http status code.
DescribeEnvironmentMemberships (Paginated)
data DescribeEnvironmentMemberships Source #
See: newDescribeEnvironmentMemberships smart constructor.
Constructors
| DescribeEnvironmentMemberships' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe [Permissions]) (Maybe Text) |
Instances
newDescribeEnvironmentMemberships :: DescribeEnvironmentMemberships Source #
Create a value of DescribeEnvironmentMemberships with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeEnvironmentMemberships, describeEnvironmentMemberships_environmentId - The ID of the environment to get environment member information about.
$sel:maxResults:DescribeEnvironmentMemberships', describeEnvironmentMemberships_maxResults - The maximum number of environment members to get information about.
DescribeEnvironmentMemberships, describeEnvironmentMemberships_nextToken - 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, describeEnvironmentMemberships_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.
DescribeEnvironmentMemberships, describeEnvironmentMemberships_userArn - 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.
data DescribeEnvironmentMembershipsResponse Source #
See: newDescribeEnvironmentMembershipsResponse smart constructor.
Constructors
| DescribeEnvironmentMembershipsResponse' (Maybe [EnvironmentMember]) (Maybe Text) Int |
Instances
newDescribeEnvironmentMembershipsResponse Source #
Arguments
| :: Int | |
| -> DescribeEnvironmentMembershipsResponse |
Create a value of DescribeEnvironmentMembershipsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:memberships:DescribeEnvironmentMembershipsResponse', describeEnvironmentMembershipsResponse_memberships - Information about the environment members for the environment.
DescribeEnvironmentMemberships, describeEnvironmentMembershipsResponse_nextToken - 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.
$sel:httpStatus:DescribeEnvironmentMembershipsResponse', describeEnvironmentMembershipsResponse_httpStatus - The response's http status code.
DescribeEnvironmentStatus
data DescribeEnvironmentStatus Source #
See: newDescribeEnvironmentStatus smart constructor.
Constructors
| DescribeEnvironmentStatus' Text |
Instances
newDescribeEnvironmentStatus Source #
Arguments
| :: Text | |
| -> DescribeEnvironmentStatus |
Create a value of DescribeEnvironmentStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeEnvironmentStatus, describeEnvironmentStatus_environmentId - The ID of the environment to get status information about.
data DescribeEnvironmentStatusResponse Source #
See: newDescribeEnvironmentStatusResponse smart constructor.
Constructors
| DescribeEnvironmentStatusResponse' Int EnvironmentStatus Text |
Instances
newDescribeEnvironmentStatusResponse Source #
Arguments
| :: Int | |
| -> EnvironmentStatus | |
| -> Text | |
| -> DescribeEnvironmentStatusResponse |
Create a value of DescribeEnvironmentStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeEnvironmentStatusResponse', describeEnvironmentStatusResponse_httpStatus - The response's http status code.
DescribeEnvironmentStatusResponse, describeEnvironmentStatusResponse_status - 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.
$sel:message:DescribeEnvironmentStatusResponse', describeEnvironmentStatusResponse_message - Any informational message about the status of the environment.
DescribeEnvironments
data DescribeEnvironments Source #
See: newDescribeEnvironments smart constructor.
Constructors
| DescribeEnvironments' (NonEmpty Text) |
Instances
newDescribeEnvironments Source #
Create a value of DescribeEnvironments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environmentIds:DescribeEnvironments', describeEnvironments_environmentIds - The IDs of individual environments to get information about.
data DescribeEnvironmentsResponse Source #
See: newDescribeEnvironmentsResponse smart constructor.
Constructors
| DescribeEnvironmentsResponse' (Maybe [Environment]) Int |
Instances
newDescribeEnvironmentsResponse Source #
Create a value of DescribeEnvironmentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environments:DescribeEnvironmentsResponse', describeEnvironmentsResponse_environments - Information about the environments that are returned.
$sel:httpStatus:DescribeEnvironmentsResponse', describeEnvironmentsResponse_httpStatus - The response's http status code.
ListEnvironments (Paginated)
data ListEnvironments Source #
See: newListEnvironments smart constructor.
Constructors
| ListEnvironments' (Maybe Natural) (Maybe Text) |
Instances
newListEnvironments :: ListEnvironments Source #
Create a value of ListEnvironments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListEnvironments', listEnvironments_maxResults - The maximum number of environments to get identifiers for.
ListEnvironments, listEnvironments_nextToken - 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.
data ListEnvironmentsResponse Source #
See: newListEnvironmentsResponse smart constructor.
Instances
newListEnvironmentsResponse Source #
Create a value of ListEnvironmentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environmentIds:ListEnvironmentsResponse', listEnvironmentsResponse_environmentIds - The list of environment identifiers.
ListEnvironments, listEnvironmentsResponse_nextToken - 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.
$sel:httpStatus:ListEnvironmentsResponse', listEnvironmentsResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:ListTagsForResource', listTagsForResource_resourceARN - The Amazon Resource Name (ARN) of the Cloud9 development environment to
get the tags for.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The list of tags associated with the Cloud9 development environment.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (Sensitive [Sensitive Tag]) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:TagResource', tagResource_resourceARN - The Amazon Resource Name (ARN) of the Cloud9 development environment to
add tags to.
$sel:tags:TagResource', tagResource_tags - The list of tags to add to the given Cloud9 development environment.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (Sensitive [Sensitive Text]) |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:UntagResource', untagResource_resourceARN - The Amazon Resource Name (ARN) of the Cloud9 development environment to
remove tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag names of the tags to remove from the given Cloud9 development
environment.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateEnvironment
data UpdateEnvironment Source #
See: newUpdateEnvironment smart constructor.
Constructors
| UpdateEnvironment' (Maybe (Sensitive Text)) (Maybe ManagedCredentialsAction) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> UpdateEnvironment |
Create a value of UpdateEnvironment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateEnvironment, updateEnvironment_description - Any new or replacement description for the environment.
$sel:managedCredentialsAction:UpdateEnvironment', updateEnvironment_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.
UpdateEnvironment, updateEnvironment_name - A replacement name for the environment.
UpdateEnvironment, updateEnvironment_environmentId - The ID of the environment to change settings.
data UpdateEnvironmentResponse Source #
See: newUpdateEnvironmentResponse smart constructor.
Constructors
| UpdateEnvironmentResponse' Int |
Instances
newUpdateEnvironmentResponse Source #
Create a value of UpdateEnvironmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateEnvironmentResponse', updateEnvironmentResponse_httpStatus - The response's http status code.
UpdateEnvironmentMembership
data UpdateEnvironmentMembership Source #
See: newUpdateEnvironmentMembership smart constructor.
Constructors
| UpdateEnvironmentMembership' Text Text MemberPermissions |
Instances
newUpdateEnvironmentMembership Source #
Arguments
| :: Text | |
| -> Text | |
| -> MemberPermissions | |
| -> UpdateEnvironmentMembership |
Create a value of UpdateEnvironmentMembership with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateEnvironmentMembership, updateEnvironmentMembership_environmentId - The ID of the environment for the environment member whose settings you
want to change.
UpdateEnvironmentMembership, updateEnvironmentMembership_userArn - The Amazon Resource Name (ARN) of the environment member whose settings
you want to change.
UpdateEnvironmentMembership, updateEnvironmentMembership_permissions - 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.
data UpdateEnvironmentMembershipResponse Source #
See: newUpdateEnvironmentMembershipResponse smart constructor.
Constructors
| UpdateEnvironmentMembershipResponse' (Maybe EnvironmentMember) Int |
Instances
newUpdateEnvironmentMembershipResponse Source #
Arguments
| :: Int | |
| -> UpdateEnvironmentMembershipResponse |
Create a value of UpdateEnvironmentMembershipResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:membership:UpdateEnvironmentMembershipResponse', updateEnvironmentMembershipResponse_membership - Information about the environment member whose settings were changed.
$sel:httpStatus:UpdateEnvironmentMembershipResponse', updateEnvironmentMembershipResponse_httpStatus - The response's http status code.
Types
ConnectionType
newtype ConnectionType Source #
Constructors
| ConnectionType' | |
Fields | |
Bundled Patterns
| pattern ConnectionType_CONNECT_SSH :: ConnectionType | |
| pattern ConnectionType_CONNECT_SSM :: ConnectionType |
Instances
EnvironmentLifecycleStatus
newtype EnvironmentLifecycleStatus Source #
Constructors
| EnvironmentLifecycleStatus' | |
Fields | |
Bundled Patterns
Instances
EnvironmentStatus
newtype EnvironmentStatus Source #
Constructors
| EnvironmentStatus' | |
Fields | |
Bundled Patterns
| pattern EnvironmentStatus_Connecting :: EnvironmentStatus | |
| pattern EnvironmentStatus_Creating :: EnvironmentStatus | |
| pattern EnvironmentStatus_Deleting :: EnvironmentStatus | |
| pattern EnvironmentStatus_Error :: EnvironmentStatus | |
| pattern EnvironmentStatus_Ready :: EnvironmentStatus | |
| pattern EnvironmentStatus_Stopped :: EnvironmentStatus | |
| pattern EnvironmentStatus_Stopping :: EnvironmentStatus |
Instances
EnvironmentType
newtype EnvironmentType Source #
Constructors
| EnvironmentType' | |
Fields | |
Bundled Patterns
| pattern EnvironmentType_Ec2 :: EnvironmentType | |
| pattern EnvironmentType_Ssh :: EnvironmentType |
Instances
ManagedCredentialsAction
newtype ManagedCredentialsAction Source #
Constructors
| ManagedCredentialsAction' | |
Fields | |
Bundled Patterns
| pattern ManagedCredentialsAction_DISABLE :: ManagedCredentialsAction | |
| pattern ManagedCredentialsAction_ENABLE :: ManagedCredentialsAction |
Instances
ManagedCredentialsStatus
newtype ManagedCredentialsStatus Source #
Constructors
| ManagedCredentialsStatus' | |
Fields | |
Bundled Patterns
Instances
MemberPermissions
newtype MemberPermissions Source #
Constructors
| MemberPermissions' | |
Fields | |
Bundled Patterns
| pattern MemberPermissions_Read_only :: MemberPermissions | |
| pattern MemberPermissions_Read_write :: MemberPermissions |
Instances
Permissions
newtype Permissions Source #
Constructors
| Permissions' | |
Fields | |
Bundled Patterns
| pattern Permissions_Owner :: Permissions | |
| pattern Permissions_Read_only :: Permissions | |
| pattern Permissions_Read_write :: Permissions |
Instances
Environment
data Environment Source #
Information about an Cloud9 development environment.
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe ConnectionType) (Maybe (Sensitive Text)) (Maybe Text) (Maybe EnvironmentLifecycle) (Maybe ManagedCredentialsStatus) (Maybe Text) EnvironmentType Text Text |
Instances
Arguments
| :: EnvironmentType | |
| -> Text | |
| -> Text | |
| -> Environment |
Create a value of Environment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectionType:Environment', environment_connectionType - The connection type used for connecting to an Amazon EC2 environment.
CONNECT_SSH is selected by default.
$sel:description:Environment', environment_description - The description for the environment.
$sel:id:Environment', environment_id - The ID of the environment.
$sel:lifecycle:Environment', environment_lifecycle - The state of the environment in its creation or deletion lifecycle.
$sel:managedCredentialsStatus:Environment', environment_managedCredentialsStatus - 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
$sel:name:Environment', environment_name - The name of the environment.
$sel:type':Environment', environment_type - 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.
$sel:arn:Environment', environment_arn - The Amazon Resource Name (ARN) of the environment.
$sel:ownerArn:Environment', environment_ownerArn - The Amazon Resource Name (ARN) of the environment owner.
EnvironmentLifecycle
data EnvironmentLifecycle Source #
Information about the current creation or deletion lifecycle state of an Cloud9 development environment.
See: newEnvironmentLifecycle smart constructor.
Constructors
| EnvironmentLifecycle' (Maybe Text) (Maybe Text) (Maybe EnvironmentLifecycleStatus) |
Instances
newEnvironmentLifecycle :: EnvironmentLifecycle Source #
Create a value of EnvironmentLifecycle with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureResource:EnvironmentLifecycle', environmentLifecycle_failureResource - If the environment failed to delete, the Amazon Resource Name (ARN) of
the related Amazon Web Services resource.
$sel:reason:EnvironmentLifecycle', environmentLifecycle_reason - Any informational message about the lifecycle state of the environment.
$sel:status:EnvironmentLifecycle', environmentLifecycle_status - 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.
EnvironmentMember
data EnvironmentMember Source #
Information about an environment member for an Cloud9 development environment.
See: newEnvironmentMember smart constructor.
Constructors
| EnvironmentMember' (Maybe POSIX) Permissions Text Text Text |
Instances
Arguments
| :: Permissions | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> EnvironmentMember |
Create a value of EnvironmentMember with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastAccess:EnvironmentMember', environmentMember_lastAccess - The time, expressed in epoch time format, when the environment member
last opened the environment.
$sel:permissions:EnvironmentMember', environmentMember_permissions - 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.
$sel:userId:EnvironmentMember', environmentMember_userId - The user ID in Identity and Access Management (IAM) of the environment
member.
$sel:userArn:EnvironmentMember', environmentMember_userArn - The Amazon Resource Name (ARN) of the environment member.
$sel:environmentId:EnvironmentMember', environmentMember_environmentId - The ID of the environment for the environment member.
Tag
Metadata that is associated with Amazon Web Services resources. In
particular, a name-value pair that can be associated with an Cloud9
development environment. There are two types of tags: user tags and
system tags. A user tag is created by the user. A system tag is
automatically created by Amazon Web Services services. A system tag is
prefixed with "aws:" and cannot be modified by the user.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.Cloud9.Types.Tag | |
| Generic Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Cloud9.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.Cloud9.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.Cloud9.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Cloud9.Types.Tag" "amazonka-cloud9-2.0-7b5PlMySrOa4RK8dYvmjDd" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The name part of a tag.
$sel:value:Tag', tag_value - The value part of a tag.