@aws-sdk/client-cloud9 3.533.0 → 3.535.0

package/dist-types/models/models_0.d.ts

@@ -1,8 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { Cloud9ServiceException as __BaseException } from "./Cloud9ServiceException";
 /**
- * @public
  * <p>The target request is invalid.</p>
+ * @public
  */
 export declare class BadRequestException extends __BaseException {
     readonly name: "BadRequestException";
@@ -15,8 +15,8 @@ export declare class BadRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
 /**
- * @public
  * <p>A conflict occurred.</p>
+ * @public
  */
 export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
@@ -41,22 +41,22 @@ export declare const ConnectionType: {
  */
 export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType];
 /**
- * @public
  * <p>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:
  *         <i>user tags</i> and <i>system tags</i>. 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 <code>"aws:"</code> and cannot be modified by the user.</p>
+ * @public
  */
 export interface Tag {
     /**
-     * @public
      * <p>The <b>name</b> part of a tag.</p>
+     * @public
      */
     Key: string | undefined;
     /**
-     * @public
      * <p>The <b>value</b> part of a tag.</p>
+     * @public
      */
     Value: string | undefined;
 }
@@ -65,38 +65,37 @@ export interface Tag {
  */
 export interface CreateEnvironmentEC2Request {
     /**
-     * @public
      * <p>The name of the environment to create.</p>
      *          <p>This name is visible to other IAM users in the same Amazon Web Services account.</p>
+     * @public
      */
     name: string | undefined;
     /**
-     * @public
      * <p>The description of the environment to create.</p>
+     * @public
      */
     description?: string;
     /**
-     * @public
      * <p>A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no
      *       more than one time.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Client Tokens</a> in the
      *         <i>Amazon EC2 API Reference</i>.</p>
+     * @public
      */
     clientRequestToken?: string;
     /**
-     * @public
      * <p>The type of instance to connect to the environment (for example,
      *       <code>t2.micro</code>).</p>
+     * @public
      */
     instanceType: string | undefined;
     /**
-     * @public
      * <p>The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2
      *       instance.</p>
+     * @public
      */
     subnetId?: string;
     /**
-     * @public
      * <p>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.</p>
@@ -153,39 +152,40 @@ export interface CreateEnvironmentEC2Request {
      *                </p>
      *             </li>
      *          </ul>
+     * @public
      */
     imageId: string | undefined;
     /**
-     * @public
      * <p>The number of minutes until the running instance is shut down after the environment has
      *       last been used.</p>
+     * @public
      */
     automaticStopTimeMinutes?: number;
     /**
-     * @public
      * <p>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.</p>
+     * @public
      */
     ownerArn?: string;
     /**
-     * @public
      * <p>An array of key-value pairs that will be associated with the new Cloud9 development
      *       environment.</p>
+     * @public
      */
     tags?: Tag[];
     /**
-     * @public
      * <p>The connection type used for connecting to an Amazon EC2 environment. Valid values are
      *         <code>CONNECT_SSH</code> (default) and <code>CONNECT_SSM</code> (connected through
      *       Amazon EC2 Systems Manager).</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/cloud9/latest/user-guide/ec2-ssm.html">Accessing no-ingress EC2 instances with
      *         Amazon EC2 Systems Manager</a> in the <i>Cloud9 User Guide</i>.</p>
+     * @public
      */
     connectionType?: ConnectionType;
     /**
-     * @public
      * <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
+     * @public
      */
     dryRun?: boolean;
 }
@@ -194,14 +194,14 @@ export interface CreateEnvironmentEC2Request {
  */
 export interface CreateEnvironmentEC2Result {
     /**
-     * @public
      * <p>The ID of the environment that was created.</p>
+     * @public
      */
     environmentId?: string;
 }
 /**
- * @public
  * <p>An access permissions issue occurred.</p>
+ * @public
  */
 export declare class ForbiddenException extends __BaseException {
     readonly name: "ForbiddenException";
@@ -214,8 +214,8 @@ export declare class ForbiddenException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
 }
 /**
- * @public
  * <p>An internal server error occurred.</p>
+ * @public
  */
 export declare class InternalServerErrorException extends __BaseException {
     readonly name: "InternalServerErrorException";
@@ -228,8 +228,8 @@ export declare class InternalServerErrorException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerErrorException, __BaseException>);
 }
 /**
- * @public
  * <p>A service limit was exceeded.</p>
+ * @public
  */
 export declare class LimitExceededException extends __BaseException {
     readonly name: "LimitExceededException";
@@ -242,8 +242,8 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
- * @public
  * <p>The target resource cannot be found.</p>
+ * @public
  */
 export declare class NotFoundException extends __BaseException {
     readonly name: "NotFoundException";
@@ -256,8 +256,8 @@ export declare class NotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
- * @public
  * <p>Too many service requests were made over the given time period.</p>
+ * @public
  */
 export declare class TooManyRequestsException extends __BaseException {
     readonly name: "TooManyRequestsException";
@@ -286,17 +286,16 @@ export type MemberPermissions = (typeof MemberPermissions)[keyof typeof MemberPe
  */
 export interface CreateEnvironmentMembershipRequest {
     /**
-     * @public
      * <p>The ID of the environment that contains the environment member you want to add.</p>
+     * @public
      */
     environmentId: string | undefined;
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the environment member you want to add.</p>
+     * @public
      */
     userArn: string | undefined;
     /**
-     * @public
      * <p>The type of environment member permissions you want to associate with this environment
      *       member. Available values include:</p>
      *          <ul>
@@ -309,6 +308,7 @@ export interface CreateEnvironmentMembershipRequest {
      *                   <code>read-write</code>: Has read-write access to the environment.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     permissions: MemberPermissions | undefined;
 }
@@ -326,12 +326,11 @@ export declare const Permissions: {
  */
 export type Permissions = (typeof Permissions)[keyof typeof Permissions];
 /**
- * @public
  * <p>Information about an environment member for an Cloud9 development environment.</p>
+ * @public
  */
 export interface EnvironmentMember {
     /**
-     * @public
      * <p>The type of environment member permissions associated with this environment member.
      *       Available values include:</p>
      *          <ul>
@@ -348,27 +347,28 @@ export interface EnvironmentMember {
      *                   <code>read-write</code>: Has read-write access to the environment.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     permissions: Permissions | undefined;
     /**
-     * @public
      * <p>The user ID in Identity and Access Management (IAM) of the environment member.</p>
+     * @public
      */
     userId: string | undefined;
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the environment member.</p>
+     * @public
      */
     userArn: string | undefined;
     /**
-     * @public
      * <p>The ID of the environment for the environment member.</p>
+     * @public
      */
     environmentId: string | undefined;
     /**
-     * @public
      * <p>The time, expressed in epoch time format, when the environment member last opened the
      *       environment.</p>
+     * @public
      */
     lastAccess?: Date;
 }
@@ -377,8 +377,8 @@ export interface EnvironmentMember {
  */
 export interface CreateEnvironmentMembershipResult {
     /**
-     * @public
      * <p>Information about the environment member that was added.</p>
+     * @public
      */
     membership: EnvironmentMember | undefined;
 }
@@ -387,8 +387,8 @@ export interface CreateEnvironmentMembershipResult {
  */
 export interface DeleteEnvironmentRequest {
     /**
-     * @public
      * <p>The ID of the environment to delete.</p>
+     * @public
      */
     environmentId: string | undefined;
 }
@@ -402,14 +402,14 @@ export interface DeleteEnvironmentResult {
  */
 export interface DeleteEnvironmentMembershipRequest {
     /**
-     * @public
      * <p>The ID of the environment to delete the environment member from.</p>
+     * @public
      */
     environmentId: string | undefined;
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the environment member to delete from the
      *       environment.</p>
+     * @public
      */
     userArn: string | undefined;
 }
@@ -423,19 +423,18 @@ export interface DeleteEnvironmentMembershipResult {
  */
 export interface DescribeEnvironmentMembershipsRequest {
     /**
-     * @public
      * <p>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.</p>
+     * @public
      */
     userArn?: string;
     /**
-     * @public
      * <p>The ID of the environment to get environment member information about.</p>
+     * @public
      */
     environmentId?: string;
     /**
-     * @public
      * <p>The type of environment member permissions to get information about. Available values
      *       include:</p>
      *          <ul>
@@ -453,20 +452,21 @@ export interface DescribeEnvironmentMembershipsRequest {
      *             </li>
      *          </ul>
      *          <p>If no value is specified, information about all environment members are returned.</p>
+     * @public
      */
     permissions?: Permissions[];
     /**
-     * @public
      * <p>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 <i>next token</i>. 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.</p>
+     * @public
      */
     nextToken?: string;
     /**
-     * @public
      * <p>The maximum number of environment members to get information about.</p>
+     * @public
      */
     maxResults?: number;
 }
@@ -475,15 +475,15 @@ export interface DescribeEnvironmentMembershipsRequest {
  */
 export interface DescribeEnvironmentMembershipsResult {
     /**
-     * @public
      * <p>Information about the environment members for the environment.</p>
+     * @public
      */
     memberships?: EnvironmentMember[];
     /**
-     * @public
      * <p>If there are more than 25 items in the list, only the first 25 items are returned, along
      *       with a unique string called a <i>next token</i>. To get the next batch of items
      *       in the list, call this operation again, adding the next token to the call.</p>
+     * @public
      */
     nextToken?: string;
 }
@@ -492,8 +492,8 @@ export interface DescribeEnvironmentMembershipsResult {
  */
 export interface DescribeEnvironmentsRequest {
     /**
-     * @public
      * <p>The IDs of individual environments to get information about.</p>
+     * @public
      */
     environmentIds: string[] | undefined;
 }
@@ -513,13 +513,12 @@ export declare const EnvironmentLifecycleStatus: {
  */
 export type EnvironmentLifecycleStatus = (typeof EnvironmentLifecycleStatus)[keyof typeof EnvironmentLifecycleStatus];
 /**
- * @public
  * <p>Information about the current creation or deletion lifecycle state of an Cloud9 development
  *       environment.</p>
+ * @public
  */
 export interface EnvironmentLifecycle {
     /**
-     * @public
      * <p>The current creation or deletion lifecycle state of the environment.</p>
      *          <ul>
      *             <li>
@@ -543,17 +542,18 @@ export interface EnvironmentLifecycle {
      *                   <code>DELETE_FAILED</code>: The environment failed to delete.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     status?: EnvironmentLifecycleStatus;
     /**
-     * @public
      * <p>Any informational message about the lifecycle state of the environment.</p>
+     * @public
      */
     reason?: string;
     /**
-     * @public
      * <p>If the environment failed to delete, the Amazon Resource Name (ARN) of the related Amazon Web Services
      *       resource.</p>
+     * @public
      */
     failureResource?: string;
 }
@@ -591,27 +591,26 @@ export declare const EnvironmentType: {
  */
 export type EnvironmentType = (typeof EnvironmentType)[keyof typeof EnvironmentType];
 /**
- * @public
  * <p>Information about an Cloud9 development environment.</p>
+ * @public
  */
 export interface Environment {
     /**
-     * @public
      * <p>The ID of the environment.</p>
+     * @public
      */
     id?: string;
     /**
-     * @public
      * <p>The name of the environment.</p>
+     * @public
      */
     name?: string;
     /**
-     * @public
      * <p>The description for the environment.</p>
+     * @public
      */
     description?: string;
     /**
-     * @public
      * <p>The type of environment. Valid values include the following:</p>
      *          <ul>
      *             <li>
@@ -623,31 +622,31 @@ export interface Environment {
      *                   <code>ssh</code>: Your own server connects to the environment.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     type: EnvironmentType | undefined;
     /**
-     * @public
      * <p>The connection type used for connecting to an Amazon EC2 environment. <code>CONNECT_SSH</code>
      *       is selected by default.</p>
+     * @public
      */
     connectionType?: ConnectionType;
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the environment.</p>
+     * @public
      */
     arn: string | undefined;
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the environment owner.</p>
+     * @public
      */
     ownerArn: string | undefined;
     /**
-     * @public
      * <p>The state of the environment in its creation or deletion lifecycle.</p>
+     * @public
      */
     lifecycle?: EnvironmentLifecycle;
     /**
-     * @public
      * <p>Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.
      *       Available values are:</p>
      *          <ul>
@@ -702,6 +701,7 @@ export interface Environment {
      *                </p>
      *             </li>
      *          </ul>
+     * @public
      */
     managedCredentialsStatus?: ManagedCredentialsStatus;
 }
@@ -710,8 +710,8 @@ export interface Environment {
  */
 export interface DescribeEnvironmentsResult {
     /**
-     * @public
      * <p>Information about the environments that are returned.</p>
+     * @public
      */
     environments?: Environment[];
 }
@@ -720,8 +720,8 @@ export interface DescribeEnvironmentsResult {
  */
 export interface DescribeEnvironmentStatusRequest {
     /**
-     * @public
      * <p>The ID of the environment to get status information about.</p>
+     * @public
      */
     environmentId: string | undefined;
 }
@@ -747,7 +747,6 @@ export type EnvironmentStatus = (typeof EnvironmentStatus)[keyof typeof Environm
  */
 export interface DescribeEnvironmentStatusResult {
     /**
-     * @public
      * <p>The status of the environment. Available values include:</p>
      *          <ul>
      *             <li>
@@ -779,11 +778,12 @@ export interface DescribeEnvironmentStatusResult {
      *                   <code>stopping</code>: The environment is stopping.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     status: EnvironmentStatus | undefined;
     /**
-     * @public
      * <p>Any informational message about the status of the environment.</p>
+     * @public
      */
     message: string | undefined;
 }
@@ -792,17 +792,17 @@ export interface DescribeEnvironmentStatusResult {
  */
 export interface ListEnvironmentsRequest {
     /**
-     * @public
      * <p>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 <i>next token</i>. 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.</p>
+     * @public
      */
     nextToken?: string;
     /**
-     * @public
      * <p>The maximum number of environments to get identifiers for.</p>
+     * @public
      */
     maxResults?: number;
 }
@@ -811,15 +811,15 @@ export interface ListEnvironmentsRequest {
  */
 export interface ListEnvironmentsResult {
     /**
-     * @public
      * <p>If there are more than 25 items in the list, only the first 25 items are returned, along
      *       with a unique string called a <i>next token</i>. To get the next batch of items
      *       in the list, call this operation again, adding the next token to the call.</p>
+     * @public
      */
     nextToken?: string;
     /**
-     * @public
      * <p>The list of environment identifiers.</p>
+     * @public
      */
     environmentIds?: string[];
 }
@@ -828,9 +828,9 @@ export interface ListEnvironmentsResult {
  */
 export interface ListTagsForResourceRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the Cloud9 development environment to get the tags
      *       for.</p>
+     * @public
      */
     ResourceARN: string | undefined;
 }
@@ -839,14 +839,14 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
-     * @public
      * <p>The list of tags associated with the Cloud9 development environment.</p>
+     * @public
      */
     Tags?: Tag[];
 }
 /**
- * @public
  * <p>A concurrent access issue occurred.</p>
+ * @public
  */
 export declare class ConcurrentAccessException extends __BaseException {
     readonly name: "ConcurrentAccessException";
@@ -863,14 +863,14 @@ export declare class ConcurrentAccessException extends __BaseException {
  */
 export interface TagResourceRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the Cloud9 development environment to add tags
      *       to.</p>
+     * @public
      */
     ResourceARN: string | undefined;
     /**
-     * @public
      * <p>The list of tags to add to the given Cloud9 development environment.</p>
+     * @public
      */
     Tags: Tag[] | undefined;
 }
@@ -884,15 +884,15 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the Cloud9 development environment to remove tags
      *       from.</p>
+     * @public
      */
     ResourceARN: string | undefined;
     /**
-     * @public
      * <p>The tag names of the tags to remove from the given Cloud9 development
      *       environment.</p>
+     * @public
      */
     TagKeys: string[] | undefined;
 }
@@ -918,22 +918,21 @@ export type ManagedCredentialsAction = (typeof ManagedCredentialsAction)[keyof t
  */
 export interface UpdateEnvironmentRequest {
     /**
-     * @public
      * <p>The ID of the environment to change settings.</p>
+     * @public
      */
     environmentId: string | undefined;
     /**
-     * @public
      * <p>A replacement name for the environment.</p>
+     * @public
      */
     name?: string;
     /**
-     * @public
      * <p>Any new or replacement description for the environment.</p>
+     * @public
      */
     description?: string;
     /**
-     * @public
      * <p>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:</p>
      *          <ul>
@@ -952,6 +951,7 @@ export interface UpdateEnvironmentRequest {
      *             <p>Only the environment owner can change the status of managed temporary credentials. An <code>AccessDeniedException</code> 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.</p>
      *          </note>
+     * @public
      */
     managedCredentialsAction?: ManagedCredentialsAction;
 }
@@ -965,19 +965,18 @@ export interface UpdateEnvironmentResult {
  */
 export interface UpdateEnvironmentMembershipRequest {
     /**
-     * @public
      * <p>The ID of the environment for the environment member whose settings you want to
      *       change.</p>
+     * @public
      */
     environmentId: string | undefined;
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the environment member whose settings you want to
      *       change.</p>
+     * @public
      */
     userArn: string | undefined;
     /**
-     * @public
      * <p>The replacement type of environment member permissions you want to associate with this
      *       environment member. Available values include:</p>
      *          <ul>
@@ -990,6 +989,7 @@ export interface UpdateEnvironmentMembershipRequest {
      *                   <code>read-write</code>: Has read-write access to the environment.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     permissions: MemberPermissions | undefined;
 }
@@ -998,8 +998,8 @@ export interface UpdateEnvironmentMembershipRequest {
  */
 export interface UpdateEnvironmentMembershipResult {
     /**
-     * @public
      * <p>Information about the environment member whose settings were changed.</p>
+     * @public
      */
     membership?: EnvironmentMember;
 }