Module Smaws_Client_Cloud9.Types

type nonrec user_arn = string
type nonrec update_environment_result = unit
type nonrec environment_id = string
type nonrec environment_name = string
type nonrec environment_description = string
type nonrec managed_credentials_action =
  1. | DISABLE
  2. | ENABLE
type nonrec update_environment_request = {
  1. managed_credentials_action : managed_credentials_action option;
    (*

    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.

    *)
  2. description : environment_description option;
    (*

    Any new or replacement description for the environment.

    *)
  3. name : environment_name option;
    (*

    A replacement name for the environment.

    *)
  4. environment_id : environment_id;
    (*

    The ID of the environment to change settings.

    *)
}
type nonrec permissions =
  1. | READ_ONLY
  2. | READ_WRITE
  3. | OWNER
type nonrec string_ = string
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec environment_member = {
  1. last_access : timestamp option;
    (*

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

    *)
  2. environment_id : environment_id;
    (*

    The ID of the environment for the environment member.

    *)
  3. user_arn : user_arn;
    (*

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

    *)
  4. user_id : string_;
    (*

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

    *)
  5. permissions : 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.
    *)
}

Information about an environment member for an Cloud9 development environment.

type nonrec update_environment_membership_result = {
  1. membership : environment_member option;
    (*

    Information about the environment member whose settings were changed.

    *)
}
type nonrec member_permissions =
  1. | READ_ONLY
  2. | READ_WRITE
type nonrec update_environment_membership_request = {
  1. permissions : member_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.
    *)
  2. user_arn : user_arn;
    (*

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

    *)
  3. environment_id : environment_id;
    (*

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

    *)
}
type nonrec integer = int
type nonrec too_many_requests_exception = {
  1. code : integer option;
  2. class_name : string_ option;
  3. message : string_ option;
}

Too many service requests were made over the given time period.

type nonrec not_found_exception = {
  1. code : integer option;
  2. class_name : string_ option;
  3. message : string_ option;
}

The target resource cannot be found.

type nonrec limit_exceeded_exception = {
  1. code : integer option;
  2. class_name : string_ option;
  3. message : string_ option;
}

A service limit was exceeded.

type nonrec internal_server_error_exception = {
  1. code : integer option;
  2. class_name : string_ option;
  3. message : string_ option;
}

An internal server error occurred.

type nonrec forbidden_exception = {
  1. code : integer option;
  2. class_name : string_ option;
  3. message : string_ option;
}

An access permissions issue occurred.

type nonrec conflict_exception = {
  1. code : integer option;
  2. class_name : string_ option;
  3. message : string_ option;
}

A conflict occurred.

type nonrec bad_request_exception = {
  1. code : integer option;
  2. class_name : string_ option;
  3. message : string_ option;
}

The target request is invalid.

type nonrec untag_resource_response = unit
type nonrec environment_arn = string
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_keys : tag_key_list;
    (*

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

    *)
  2. resource_ar_n : environment_arn;
    (*

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

    *)
}
type nonrec concurrent_access_exception = {
  1. code : integer option;
  2. class_name : string_ option;
  3. message : string_ option;
}

A concurrent access issue occurred.

type nonrec tag_value = string
type nonrec tag_resource_response = unit
type nonrec tag = {
  1. value : tag_value;
    (*

    The value part of a tag.

    *)
  2. key : tag_key;
    (*

    The name part of a 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.

type nonrec tag_list = tag list
type nonrec tag_resource_request = {
  1. tags : tag_list;
    (*

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

    *)
  2. resource_ar_n : environment_arn;
    (*

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

    *)
}
type nonrec subnet_id = string
type nonrec permissions_list = permissions list
type nonrec nullable_boolean = bool
type nonrec max_results = int
type nonrec managed_credentials_status =
  1. | FAILED_REMOVAL_BY_OWNER
  2. | FAILED_REMOVAL_BY_COLLABORATOR
  3. | PENDING_START_REMOVAL_BY_OWNER
  4. | PENDING_REMOVAL_BY_OWNER
  5. | PENDING_START_REMOVAL_BY_COLLABORATOR
  6. | PENDING_REMOVAL_BY_COLLABORATOR
  7. | DISABLED_BY_COLLABORATOR
  8. | DISABLED_BY_OWNER
  9. | DISABLED_BY_DEFAULT
  10. | ENABLED_BY_OWNER
  11. | ENABLED_ON_CREATE
type nonrec list_tags_for_resource_response = {
  1. tags : tag_list option;
    (*

    The list of tags associated with the Cloud9 development environment.

    *)
}
type nonrec list_tags_for_resource_request = {
  1. resource_ar_n : environment_arn;
    (*

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

    *)
}
type nonrec environment_id_list = environment_id list
type nonrec list_environments_result = {
  1. environment_ids : environment_id_list option;
    (*

    The list of environment identifiers.

    *)
  2. next_token : string_ option;
    (*

    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.

    *)
}
type nonrec list_environments_request = {
  1. max_results : max_results option;
    (*

    The maximum number of environments to get identifiers for.

    *)
  2. next_token : string_ option;
    (*

    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.

    *)
}
type nonrec instance_type = string
type nonrec image_id = string
type nonrec environment_type =
  1. | EC2
  2. | SSH
type nonrec environment_status =
  1. | DELETING
  2. | STOPPED
  3. | STOPPING
  4. | READY
  5. | CONNECTING
  6. | CREATING
  7. | ERROR
type nonrec environment_members_list = environment_member list
type nonrec connection_type =
  1. | CONNECT_SSM
  2. | CONNECT_SSH
type nonrec environment_lifecycle_status =
  1. | DELETE_FAILED
  2. | DELETING
  3. | CREATE_FAILED
  4. | CREATED
  5. | CREATING
type nonrec environment_lifecycle = {
  1. failure_resource : string_ option;
    (*

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

    *)
  2. reason : string_ option;
    (*

    Any informational message about the lifecycle state of the environment.

    *)
  3. status : environment_lifecycle_status option;
    (*

    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.
    *)
}

Information about the current creation or deletion lifecycle state of an Cloud9 development environment.

type nonrec environment = {
  1. managed_credentials_status : managed_credentials_status option;
    (*

    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
    *)
  2. lifecycle : environment_lifecycle option;
    (*

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

    *)
  3. owner_arn : string_;
    (*

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

    *)
  4. arn : string_;
    (*

    The Amazon Resource Name (ARN) of the environment.

    *)
  5. connection_type : connection_type option;
    (*

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

    *)
  6. type_ : 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.
    *)
  7. description : environment_description option;
    (*

    The description for the environment.

    *)
  8. name : environment_name option;
    (*

    The name of the environment.

    *)
  9. id : environment_id option;
    (*

    The ID of the environment.

    *)
}

Information about an Cloud9 development environment.

type nonrec environment_list = environment list
type nonrec describe_environments_result = {
  1. environments : environment_list option;
    (*

    Information about the environments that are returned.

    *)
}
type nonrec bounded_environment_id_list = environment_id list
type nonrec describe_environments_request = {
  1. environment_ids : bounded_environment_id_list;
    (*

    The IDs of individual environments to get information about.

    *)
}
type nonrec describe_environment_status_result = {
  1. message : string_;
    (*

    Any informational message about the status of the environment.

    *)
  2. status : environment_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.
    *)
}
type nonrec describe_environment_status_request = {
  1. environment_id : environment_id;
    (*

    The ID of the environment to get status information about.

    *)
}
type nonrec describe_environment_memberships_result = {
  1. next_token : string_ option;
    (*

    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.

    *)
  2. memberships : environment_members_list option;
    (*

    Information about the environment members for the environment.

    *)
}
type nonrec describe_environment_memberships_request = {
  1. max_results : max_results option;
    (*

    The maximum number of environment members to get information about.

    *)
  2. next_token : string_ option;
    (*

    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.

    *)
  3. permissions : permissions_list option;
    (*

    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.

    *)
  4. environment_id : environment_id option;
    (*

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

    *)
  5. user_arn : user_arn option;
    (*

    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.

    *)
}
type nonrec delete_environment_result = unit
type nonrec delete_environment_request = {
  1. environment_id : environment_id;
    (*

    The ID of the environment to delete.

    *)
}
type nonrec delete_environment_membership_result = unit
type nonrec delete_environment_membership_request = {
  1. user_arn : user_arn;
    (*

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

    *)
  2. environment_id : environment_id;
    (*

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

    *)
}
type nonrec create_environment_membership_result = {
  1. membership : environment_member;
    (*

    Information about the environment member that was added.

    *)
}
type nonrec create_environment_membership_request = {
  1. permissions : member_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.
    *)
  2. user_arn : user_arn;
    (*

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

    *)
  3. environment_id : environment_id;
    (*

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

    *)
}
type nonrec create_environment_ec2_result = {
  1. environment_id : environment_id option;
    (*

    The ID of the environment that was created.

    *)
}
type nonrec client_request_token = string
type nonrec automatic_stop_time_minutes = int
type nonrec create_environment_ec2_request = {
  1. dry_run : nullable_boolean option;
    (*

    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.

    *)
  2. connection_type : connection_type option;
    (*

    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.

    *)
  3. tags : tag_list option;
    (*

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

    *)
  4. owner_arn : user_arn option;
    (*

    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.

    *)
  5. automatic_stop_time_minutes : automatic_stop_time_minutes option;
    (*

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

    *)
  6. image_id : 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 Amazon EC2 Systems Manager (SSM) path.

    We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported.

    From December 16, 2024, Ubuntu 18.04 will be removed from the list of available imageIds for Cloud9. This change is necessary as Ubuntu 18.04 has ended standard support on May 31, 2023. This change will only affect direct API consumers, and not Cloud9 console users.

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

    AMI aliases

    • Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64
    • Ubuntu 22.04: ubuntu-22.04-x86_64

    SSM paths

    • Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64
    • Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64
    *)
  7. subnet_id : subnet_id option;
    (*

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

    *)
  8. instance_type : instance_type;
    (*

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

    *)
  9. client_request_token : client_request_token option;
    (*

    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.

    *)
  10. description : environment_description option;
    (*

    The description of the environment to create.

    *)
  11. name : environment_name;
    (*

    The name of the environment to create.

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

    *)
}