@aws-sdk/client-codecatalyst 3.295.0 → 3.297.0

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { CodeCatalystServiceException as __BaseException } from "./CodeCatalystServiceException";
 /**
+ * @public
  * <p>The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -12,6 +13,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request.
  *        Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.</p>
  */
@@ -23,6 +25,9 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateAccessTokenRequest {
     /**
      * <p>The friendly name of the personal access token.</p>
@@ -33,6 +38,9 @@ export interface CreateAccessTokenRequest {
      */
     expiresTime?: Date;
 }
+/**
+ * @public
+ */
 export interface CreateAccessTokenResponse {
     /**
      * <p>The secret value of the personal access token.</p>
@@ -52,6 +60,7 @@ export interface CreateAccessTokenResponse {
     accessTokenId: string | undefined;
 }
 /**
+ * @public
  * <p>The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -63,6 +72,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce
  *       the number of resources, or change the tier if applicable.</p>
  */
@@ -75,6 +85,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied due to request throttling.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -87,6 +98,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -97,14 +109,23 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteAccessTokenRequest {
     /**
      * <p>The ID of the personal access token to delete. You can find the IDs of all PATs associated with your user account by calling <a>ListAccessTokens</a>.</p>
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteAccessTokenResponse {
 }
+/**
+ * @public
+ */
 export interface ListAccessTokensRequest {
     /**
      * <p>The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p>
@@ -116,6 +137,7 @@ export interface ListAccessTokensRequest {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>Information about a specified personal access token (PAT).</p>
  */
 export interface AccessTokenSummary {
@@ -132,6 +154,9 @@ export interface AccessTokenSummary {
      */
     expiresTime?: Date;
 }
+/**
+ * @public
+ */
 export interface ListAccessTokensResponse {
     /**
      * <p>A list of personal access tokens (PATs) associated with the calling user.</p>
@@ -142,10 +167,16 @@ export interface ListAccessTokensResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum CatalogActionVersionFileRecordType {
     LICENSE = "LICENSE",
     README = "README"
 }
+/**
+ * @public
+ */
 export interface GetUserDetailsRequest {
     /**
      * <p>The system-generated unique ID of the user. </p>
@@ -157,6 +188,7 @@ export interface GetUserDetailsRequest {
     userName?: string;
 }
 /**
+ * @public
  * <p>Information about an email address.</p>
  */
 export interface EmailAddress {
@@ -169,6 +201,9 @@ export interface EmailAddress {
      */
     verified?: boolean;
 }
+/**
+ * @public
+ */
 export interface GetUserDetailsResponse {
     /**
      * <p>The system-generated unique ID of the user.</p>
@@ -191,6 +226,9 @@ export interface GetUserDetailsResponse {
      */
     version?: string;
 }
+/**
+ * @public
+ */
 export interface ListEventLogsRequest {
     /**
      * <p>The name of the space.</p>
@@ -217,11 +255,15 @@ export interface ListEventLogsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export declare enum OperationType {
     MUTATION = "MUTATION",
     READONLY = "READONLY"
 }
 /**
+ * @public
  * <p>Information about a project in a space.</p>
  */
 export interface ProjectInformation {
@@ -235,6 +277,7 @@ export interface ProjectInformation {
     projectId?: string;
 }
 /**
+ * @public
  * <p>Information about the payload of an event recording Amazon CodeCatalyst activity.</p>
  */
 export interface EventPayload {
@@ -247,12 +290,16 @@ export interface EventPayload {
      */
     data?: string;
 }
+/**
+ * @public
+ */
 export declare enum UserType {
     AWS_ACCOUNT = "AWS_ACCOUNT",
     UNKNOWN = "UNKNOWN",
     USER = "USER"
 }
 /**
+ * @public
  * <p>Information about a user whose activity is recorded in an event for a space.</p>
  */
 export interface UserIdentity {
@@ -274,6 +321,7 @@ export interface UserIdentity {
     awsAccountId?: string;
 }
 /**
+ * @public
  * <p>Information about an entry in an event log of Amazon CodeCatalyst activity.</p>
  */
 export interface EventLogEntry {
@@ -338,6 +386,9 @@ export interface EventLogEntry {
      */
     userAgent?: string;
 }
+/**
+ * @public
+ */
 export interface ListEventLogsResponse {
     /**
      * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
@@ -348,12 +399,18 @@ export interface ListEventLogsResponse {
      */
     items: EventLogEntry[] | undefined;
 }
+/**
+ * @public
+ */
 export interface GetSpaceRequest {
     /**
      * <p>The name of the space.</p>
      */
     name: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetSpaceResponse {
     /**
      * <p>The name of the space.</p>
@@ -372,6 +429,9 @@ export interface GetSpaceResponse {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export interface ListSpacesRequest {
     /**
      * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
@@ -379,6 +439,7 @@ export interface ListSpacesRequest {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>Information about an space.</p>
  */
 export interface SpaceSummary {
@@ -400,6 +461,9 @@ export interface SpaceSummary {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export interface ListSpacesResponse {
     /**
      * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
@@ -410,6 +474,9 @@ export interface ListSpacesResponse {
      */
     items?: SpaceSummary[];
 }
+/**
+ * @public
+ */
 export interface CreateProjectRequest {
     /**
      * <p>The name of the space.</p>
@@ -424,6 +491,9 @@ export interface CreateProjectRequest {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export interface CreateProjectResponse {
     /**
      * <p>The name of the space.</p>
@@ -443,6 +513,7 @@ export interface CreateProjectResponse {
     description?: string;
 }
 /**
+ * @public
  * <p>Information about the configuration of an integrated development environment (IDE) for a Dev Environment.</p>
  */
 export interface IdeConfiguration {
@@ -458,6 +529,9 @@ export interface IdeConfiguration {
      */
     name?: string;
 }
+/**
+ * @public
+ */
 export declare enum _InstanceType {
     DEV_STANDARD1_LARGE = "dev.standard1.large",
     DEV_STANDARD1_MEDIUM = "dev.standard1.medium",
@@ -465,6 +539,7 @@ export declare enum _InstanceType {
     DEV_STANDARD1_XLARGE = "dev.standard1.xlarge"
 }
 /**
+ * @public
  * <p>Information about the configuration of persistent storage for a Dev Environment. </p>
  */
 export interface PersistentStorageConfiguration {
@@ -478,6 +553,7 @@ export interface PersistentStorageConfiguration {
     sizeInGiB: number | undefined;
 }
 /**
+ * @public
  * <p>Information about a repository that will be cloned to a Dev Environment.</p>
  */
 export interface RepositoryInput {
@@ -490,6 +566,9 @@ export interface RepositoryInput {
      */
     branchName?: string;
 }
+/**
+ * @public
+ */
 export interface CreateDevEnvironmentRequest {
     /**
      * <p>The name of the space.</p>
@@ -540,6 +619,9 @@ export interface CreateDevEnvironmentRequest {
      */
     persistentStorage: PersistentStorageConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateDevEnvironmentResponse {
     /**
      * <p>The name of the space.</p>
@@ -554,6 +636,9 @@ export interface CreateDevEnvironmentResponse {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteDevEnvironmentRequest {
     /**
      * <p>The name of the space.</p>
@@ -568,6 +653,9 @@ export interface DeleteDevEnvironmentRequest {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteDevEnvironmentResponse {
     /**
      * <p>The name of the space.</p>
@@ -582,6 +670,9 @@ export interface DeleteDevEnvironmentResponse {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetDevEnvironmentRequest {
     /**
      * <p>The name of the space.</p>
@@ -597,6 +688,7 @@ export interface GetDevEnvironmentRequest {
     id: string | undefined;
 }
 /**
+ * @public
  * <p>Information about an integrated development environment (IDE) used in a Dev Environment.</p>
  */
 export interface Ide {
@@ -610,6 +702,7 @@ export interface Ide {
     name?: string;
 }
 /**
+ * @public
  * <p>Information about the persistent storage for a Dev Environment.</p>
  */
 export interface PersistentStorage {
@@ -623,6 +716,7 @@ export interface PersistentStorage {
     sizeInGiB: number | undefined;
 }
 /**
+ * @public
  * <p>Information about the source repsitory for a Dev Environment. </p>
  */
 export interface DevEnvironmentRepositorySummary {
@@ -635,6 +729,9 @@ export interface DevEnvironmentRepositorySummary {
      */
     branchName?: string;
 }
+/**
+ * @public
+ */
 export declare enum DevEnvironmentStatus {
     DELETED = "DELETED",
     DELETING = "DELETING",
@@ -645,6 +742,9 @@ export declare enum DevEnvironmentStatus {
     STOPPED = "STOPPED",
     STOPPING = "STOPPING"
 }
+/**
+ * @public
+ */
 export interface GetDevEnvironmentResponse {
     /**
      * <p>The name of the space.</p>
@@ -700,6 +800,7 @@ export interface GetDevEnvironmentResponse {
     persistentStorage: PersistentStorage | undefined;
 }
 /**
+ * @public
  * <p/>
  */
 export interface Filter {
@@ -716,6 +817,9 @@ export interface Filter {
      */
     comparisonOperator?: string;
 }
+/**
+ * @public
+ */
 export interface ListDevEnvironmentsRequest {
     /**
      * <p>The name of the space.</p>
@@ -739,6 +843,7 @@ export interface ListDevEnvironmentsRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>Information about a Dev Environment. </p>
  */
 export interface DevEnvironmentSummary {
@@ -795,6 +900,9 @@ export interface DevEnvironmentSummary {
      */
     persistentStorage: PersistentStorage | undefined;
 }
+/**
+ * @public
+ */
 export interface ListDevEnvironmentsResponse {
     /**
      * <p>Information about the Dev Environments in a project.</p>
@@ -805,6 +913,9 @@ export interface ListDevEnvironmentsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface StartDevEnvironmentRequest {
     /**
      * <p>The name of the space.</p>
@@ -831,6 +942,9 @@ export interface StartDevEnvironmentRequest {
      */
     inactivityTimeoutMinutes?: number;
 }
+/**
+ * @public
+ */
 export interface StartDevEnvironmentResponse {
     /**
      * <p>The name of the space.</p>
@@ -850,6 +964,7 @@ export interface StartDevEnvironmentResponse {
     status: DevEnvironmentStatus | string | undefined;
 }
 /**
+ * @public
  * <p>Information about the commands that will be run on a Dev Environment when an SSH session begins.</p>
  */
 export interface ExecuteCommandSessionConfiguration {
@@ -862,11 +977,15 @@ export interface ExecuteCommandSessionConfiguration {
      */
     arguments?: string[];
 }
+/**
+ * @public
+ */
 export declare enum DevEnvironmentSessionType {
     SSH = "SSH",
     SSM = "SSM"
 }
 /**
+ * @public
  * <p>Information about the configuration of a Dev Environment session.</p>
  */
 export interface DevEnvironmentSessionConfiguration {
@@ -879,6 +998,9 @@ export interface DevEnvironmentSessionConfiguration {
      */
     executeCommandSessionConfiguration?: ExecuteCommandSessionConfiguration;
 }
+/**
+ * @public
+ */
 export interface StartDevEnvironmentSessionRequest {
     /**
      * <p>The name of the space.</p>
@@ -898,6 +1020,7 @@ export interface StartDevEnvironmentSessionRequest {
     sessionConfiguration: DevEnvironmentSessionConfiguration | undefined;
 }
 /**
+ * @public
  * <p>Information about connection details for a Dev Environment.</p>
  */
 export interface DevEnvironmentAccessDetails {
@@ -910,6 +1033,9 @@ export interface DevEnvironmentAccessDetails {
      */
     tokenValue: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StartDevEnvironmentSessionResponse {
     /**
      * <p>Information about connection details for a Dev Environment.</p>
@@ -932,6 +1058,9 @@ export interface StartDevEnvironmentSessionResponse {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopDevEnvironmentRequest {
     /**
      * <p>The name of the space.</p>
@@ -946,6 +1075,9 @@ export interface StopDevEnvironmentRequest {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopDevEnvironmentResponse {
     /**
      * <p>The name of the space.</p>
@@ -964,6 +1096,9 @@ export interface StopDevEnvironmentResponse {
      */
     status: DevEnvironmentStatus | string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopDevEnvironmentSessionRequest {
     /**
      * <p>The name of the space.</p>
@@ -982,6 +1117,9 @@ export interface StopDevEnvironmentSessionRequest {
      */
     sessionId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopDevEnvironmentSessionResponse {
     /**
      * <p>The name of the space.</p>
@@ -1000,6 +1138,9 @@ export interface StopDevEnvironmentSessionResponse {
      */
     sessionId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateDevEnvironmentRequest {
     /**
      * <p>The name of the space.</p>
@@ -1042,6 +1183,9 @@ export interface UpdateDevEnvironmentRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateDevEnvironmentResponse {
     /**
      * <p>The system-generated unique ID of the Dev Environment. </p>
@@ -1077,6 +1221,9 @@ export interface UpdateDevEnvironmentResponse {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface GetProjectRequest {
     /**
      * <p>The name of the space.</p>
@@ -1087,6 +1234,9 @@ export interface GetProjectRequest {
      */
     name: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetProjectResponse {
     /**
      * <p>The name of the space.</p>
@@ -1105,6 +1255,9 @@ export interface GetProjectResponse {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export declare enum ComparisonOperator {
     EQUALS = "EQ",
     GREATER_THAN = "GT",
@@ -1112,10 +1265,14 @@ export declare enum ComparisonOperator {
     LESS_THAN = "LT",
     LESS_THAN_OR_EQUALS = "LE"
 }
+/**
+ * @public
+ */
 export declare enum FilterKey {
     HAS_ACCESS_TO = "hasAccessTo"
 }
 /**
+ * @public
  * <p>nformation about the filter used to narrow the results returned in a list of projects.</p>
  */
 export interface ProjectListFilter {
@@ -1132,6 +1289,9 @@ export interface ProjectListFilter {
      */
     comparisonOperator?: ComparisonOperator | string;
 }
+/**
+ * @public
+ */
 export interface ListProjectsRequest {
     /**
      * <p>The name of the space.</p>
@@ -1151,6 +1311,7 @@ export interface ListProjectsRequest {
     filters?: ProjectListFilter[];
 }
 /**
+ * @public
  * <p>Information about a project.</p>
  */
 export interface ProjectSummary {
@@ -1167,6 +1328,9 @@ export interface ProjectSummary {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export interface ListProjectsResponse {
     /**
      * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
@@ -1177,6 +1341,9 @@ export interface ListProjectsResponse {
      */
     items?: ProjectSummary[];
 }
+/**
+ * @public
+ */
 export interface GetSourceRepositoryCloneUrlsRequest {
     /**
      * <p>The name of the space.</p>
@@ -1191,12 +1358,18 @@ export interface GetSourceRepositoryCloneUrlsRequest {
      */
     sourceRepositoryName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetSourceRepositoryCloneUrlsResponse {
     /**
      * <p>The HTTPS URL to use when cloning the source repository.</p>
      */
     https: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListSourceRepositoriesRequest {
     /**
      * <p>The name of the space.</p>
@@ -1216,6 +1389,7 @@ export interface ListSourceRepositoriesRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>Information about a source repository returned in a list of source repositories.</p>
  */
 export interface ListSourceRepositoriesItem {
@@ -1240,6 +1414,9 @@ export interface ListSourceRepositoriesItem {
      */
     createdTime: Date | undefined;
 }
+/**
+ * @public
+ */
 export interface ListSourceRepositoriesResponse {
     /**
      * <p>Information about the source repositories.</p>
@@ -1250,6 +1427,9 @@ export interface ListSourceRepositoriesResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateSourceRepositoryBranchRequest {
     /**
      * <p>The name of the space.</p>
@@ -1272,6 +1452,9 @@ export interface CreateSourceRepositoryBranchRequest {
      */
     headCommitId?: string;
 }
+/**
+ * @public
+ */
 export interface CreateSourceRepositoryBranchResponse {
     /**
      * <p>The Git reference name of the branch.</p>
@@ -1290,6 +1473,9 @@ export interface CreateSourceRepositoryBranchResponse {
      */
     headCommitId?: string;
 }
+/**
+ * @public
+ */
 export interface ListSourceRepositoryBranchesRequest {
     /**
      * <p>The name of the space.</p>
@@ -1313,6 +1499,7 @@ export interface ListSourceRepositoryBranchesRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>Information about a branch of a source repository returned in a list of branches.</p>
  */
 export interface ListSourceRepositoryBranchesItem {
@@ -1333,6 +1520,9 @@ export interface ListSourceRepositoryBranchesItem {
      */
     headCommitId?: string;
 }
+/**
+ * @public
+ */
 export interface ListSourceRepositoryBranchesResponse {
     /**
      * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
@@ -1343,12 +1533,18 @@ export interface ListSourceRepositoryBranchesResponse {
      */
     items: ListSourceRepositoryBranchesItem[] | undefined;
 }
+/**
+ * @public
+ */
 export interface GetSubscriptionRequest {
     /**
      * <p>The name of the space.</p>
      */
     spaceName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetSubscriptionResponse {
     /**
      * <p>The type of the billing plan for the space.</p>
@@ -1359,6 +1555,9 @@ export interface GetSubscriptionResponse {
      */
     awsAccountName?: string;
 }
+/**
+ * @public
+ */
 export interface VerifySessionResponse {
     /**
      * <p>The system-generated unique ID of the user in Amazon CodeCatalyst.</p>