Class: AWS.CodeCatalyst

var params = {
  instanceType: dev.standard1.small | dev.standard1.medium | dev.standard1.large | dev.standard1.xlarge, /* required */
  persistentStorage: { /* required */
    sizeInGiB: 'NUMBER_VALUE' /* required */
  },
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  alias: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  ides: [
    {
      name: 'STRING_VALUE',
      runtime: 'STRING_VALUE'
    },
    /* more items */
  ],
  inactivityTimeoutMinutes: 'NUMBER_VALUE',
  repositories: [
    {
      repositoryName: 'STRING_VALUE', /* required */
      branchName: 'STRING_VALUE'
    },
    /* more items */
  ],
  vpcConnectionName: 'STRING_VALUE'
};
codecatalyst.createDevEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • repositories — (Array<map>)

    The source repository that contains the branch to clone into the Dev Environment.

    • repositoryName — required — (String)

      The name of the source repository.

    • branchName — (String)

      The name of the branch in a source repository.

  • clientToken — (String)

    A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

  • alias — (String)

    The user-defined alias for a Dev Environment.

  • ides — (Array<map>)

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    Note: An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.
    • runtime — (String)

      A link to the IDE runtime image.

      Note: This parameter is not required for VSCode.
    • name — (String)

      The name of the IDE. Valid values include Cloud9, IntelliJ, PyCharm, GoLand, and VSCode.

  • instanceType — (String)

    The Amazon EC2 instace type to use for the Dev Environment.

    Possible values include:
    • "dev.standard1.small"
    • "dev.standard1.medium"
    • "dev.standard1.large"
    • "dev.standard1.xlarge"
  • inactivityTimeoutMinutes — (Integer)

    The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

  • persistentStorage — (map)

    Information about the amount of storage allocated to the Dev Environment.

    Note: By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
    • sizeInGiB — required — (Integer)

      The size of the persistent storage in gigabytes (specifically GiB).

      Note: Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
  • vpcConnectionName — (String)

    The name of the connection that will be used to connect to Amazon VPC, if any.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The system-generated unique ID of the Dev Environment.

    • vpcConnectionName — (String)

      The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  displayName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
codecatalyst.createProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • displayName — (String)

    The friendly name of the project that will be displayed to users.

  • description — (String)

    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • name — (String)

      The name of the project in the space.

    • displayName — (String)

      The friendly name of the project.

    • description — (String)

      The description of the project.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
codecatalyst.createSourceRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • name — (String)

    The name of the source repository. For more information about name requirements, see Quotas for source repositories.

  • description — (String)

    The description of the source repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • name — (String)

      The name of the source repository.

    • description — (String)

      The description of the source repository.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  sourceRepositoryName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  headCommitId: 'STRING_VALUE'
};
codecatalyst.createSourceRepositoryBranch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • sourceRepositoryName — (String)

    The name of the repository where you want to create a branch.

  • name — (String)

    The name for the branch you're creating.

  • headCommitId — (String)

    The commit ID in an existing branch from which you want to create the new branch.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ref — (String)

      The Git reference name of the branch.

    • name — (String)

      The name of the newly created branch.

    • lastUpdatedTime — (Date)

      The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • headCommitId — (String)

      The commit ID of the tip of the newly created branch.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
codecatalyst.deleteAccessToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the personal access token to delete. You can find the IDs of all PATs associated with your Amazon Web Services Builder ID in a space by calling ListAccessTokens.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.deleteDevEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • id — (String)

    The system-generated unique ID of the Dev Environment you want to delete. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The system-generated unique ID of the deleted Dev Environment.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.deleteProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • name — (String)

    The name of the project in the space. To retrieve a list of project names, use ListProjects.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • name — (String)

      The name of the project in the space.

    • displayName — (String)

      The friendly name displayed to users of the project in Amazon CodeCatalyst.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.deleteSourceRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • name — (String)

    The name of the source repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • name — (String)

      The name of the repository.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE' /* required */
};
codecatalyst.deleteSpace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the space. To retrieve a list of space names, use ListSpaces.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • name — (String)

      The name of the space.

    • displayName — (String)

      The friendly name of the space displayed to users of the space in Amazon CodeCatalyst.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.getDevEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • id — (String)

    The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The system-generated unique ID of the Dev Environment.

    • lastUpdatedTime — (Date)

      The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • creatorId — (String)

      The system-generated unique ID of the user who created the Dev Environment.

    • status — (String)

      The current status of the Dev Environment.

      Possible values include:
      • "PENDING"
      • "RUNNING"
      • "STARTING"
      • "STOPPING"
      • "STOPPED"
      • "FAILED"
      • "DELETING"
      • "DELETED"
    • statusReason — (String)

      The reason for the status.

    • repositories — (Array<map>)

      The source repository that contains the branch cloned into the Dev Environment.

      • repositoryName — required — (String)

        The name of the source repository.

      • branchName — (String)

        The name of the branch in a source repository cloned into the Dev Environment.

    • alias — (String)

      The user-specified alias for the Dev Environment.

    • ides — (Array<map>)

      Information about the integrated development environment (IDE) configured for the Dev Environment.

      • runtime — (String)

        A link to the IDE runtime image.

      • name — (String)

        The name of the IDE.

    • instanceType — (String)

      The Amazon EC2 instace type to use for the Dev Environment.

      Possible values include:
      • "dev.standard1.small"
      • "dev.standard1.medium"
      • "dev.standard1.large"
      • "dev.standard1.xlarge"
    • inactivityTimeoutMinutes — (Integer)

      The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.

    • persistentStorage — (map)

      Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.

      • sizeInGiB — required — (Integer)

        The size of the persistent storage in gigabytes (specifically GiB).

        Note: Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
    • vpcConnectionName — (String)

      The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.getProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • name — (String)

    The name of the project in the space.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • name — (String)

      The name of the project in the space.

    • displayName — (String)

      The friendly name of the project displayed to users in Amazon CodeCatalyst.

    • description — (String)

      The description of the project.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.getSourceRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • name — (String)

    The name of the source repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • name — (String)

      The name of the source repository.

    • description — (String)

      The description of the source repository.

    • lastUpdatedTime — (Date)

      The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • createdTime — (Date)

      The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  projectName: 'STRING_VALUE', /* required */
  sourceRepositoryName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.getSourceRepositoryCloneUrls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • sourceRepositoryName — (String)

    The name of the source repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • https — (String)

      The HTTPS URL to use when cloning the source repository.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE' /* required */
};
codecatalyst.getSpace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the space.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • name — (String)

      The name of the space.

    • regionName — (String)

      The Amazon Web Services Region where the space exists.

    • displayName — (String)

      The friendly name of the space displayed to users.

    • description — (String)

      The description of the space.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.getSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • subscriptionType — (String)

      The type of the billing plan for the space.

    • awsAccountName — (String)

      The display name of the Amazon Web Services account used for billing for the space.

    • pendingSubscriptionType — (String)

      The type of the billing plan that the space will be changed to at the start of the next billing cycle. This applies only to changes that reduce the functionality available for the space. Billing plan changes that increase functionality are applied immediately. For more information, see Pricing.

    • pendingSubscriptionStartTime — (Date)

      The day and time the pending change will be applied to the space, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE',
  userName: 'STRING_VALUE'
};
codecatalyst.getUserDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The system-generated unique ID of the user.

  • userName — (String)

    The name of the user as displayed in Amazon CodeCatalyst.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • userId — (String)

      The system-generated unique ID of the user.

    • userName — (String)

      The name of the user as displayed in Amazon CodeCatalyst.

    • displayName — (String)

      The friendly name displayed for the user in Amazon CodeCatalyst.

    • primaryEmail — (map)

      The email address provided by the user when they signed up.

      • email — (String)

        The email address.

      • verified — (Boolean)

        Whether the email address has been verified.

    • version — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.getWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • id — (String)

    The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows.

  • projectName — (String)

    The name of the project in the space.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The ID of the workflow.

    • name — (String)

      The name of the workflow.

    • sourceRepositoryName — (String)

      The name of the source repository where the workflow YAML is stored.

    • sourceBranchName — (String)

      The name of the branch that contains the workflow YAML.

    • definition — (map)

      Information about the workflow definition file for the workflow.

      • path — required — (String)

        The path to the workflow definition file stored in the source repository for the project, including the file name.

    • createdTime — (Date)

      The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

    • lastUpdatedTime — (Date)

      The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

    • runMode — (String)

      The behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

      Possible values include:
      • "QUEUED"
      • "PARALLEL"
      • "SUPERSEDED"
    • status — (String)

      The status of the workflow.

      Possible values include:
      • "INVALID"
      • "ACTIVE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.getWorkflowRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • id — (String)

    The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns.

  • projectName — (String)

    The name of the project in the space.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The ID of the workflow run.

    • workflowId — (String)

      The ID of the workflow.

    • status — (String)

      The status of the workflow run.

      Possible values include:
      • "SUCCEEDED"
      • "FAILED"
      • "STOPPED"
      • "SUPERSEDED"
      • "CANCELLED"
      • "NOT_RUN"
      • "VALIDATING"
      • "PROVISIONING"
      • "IN_PROGRESS"
      • "STOPPING"
      • "ABANDONED"
    • statusReasons — (Array<map>)

      Information about the reasons for the status of the workflow run.

    • startTime — (Date)

      The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

    • endTime — (Date)

      The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • lastUpdatedTime — (Date)

      The date and time the workflow run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codecatalyst.listAccessTokens(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    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 NextToken element, which you can use to obtain additional results.

  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • items — (Array<map>)

      A list of personal access tokens (PATs) associated with the calling user identity.

      • id — required — (String)

        The system-generated ID of the personal access token.

      • name — required — (String)

        The friendly name of the personal access token.

      • expiresTime — (Date)

        The date and time when the personal access token will expire, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  spaceName: 'STRING_VALUE', /* required */
  filters: [
    {
      key: 'STRING_VALUE', /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      comparisonOperator: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  projectName: 'STRING_VALUE'
};
codecatalyst.listDevEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • filters — (Array<map>)

    Information about filters to apply to narrow the results returned in the list.

    • key — required — (String)

      A key that can be used to sort results.

    • values — required — (Array<String>)

      The values of the key.

    • comparisonOperator — (String)

      The operator used to compare the fields.

  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults — (Integer)

    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 NextToken element, which you can use to obtain additional results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • items — (Array<map>)

      Information about the Dev Environments in a project.

      • spaceName — (String)

        The name of the space.

      • projectName — (String)

        The name of the project in the space.

      • id — required — (String)

        The system-generated unique ID for the Dev Environment.

      • lastUpdatedTime — required — (Date)

        The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

      • creatorId — required — (String)

        The system-generated unique ID of the user who created the Dev Environment.

      • status — required — (String)

        The status of the Dev Environment.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
        • "FAILED"
        • "DELETING"
        • "DELETED"
      • statusReason — (String)

        The reason for the status.

      • repositories — required — (Array<map>)

        Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.

        • repositoryName — required — (String)

          The name of the source repository.

        • branchName — (String)

          The name of the branch in a source repository cloned into the Dev Environment.

      • alias — (String)

        The user-specified alias for the Dev Environment.

      • ides — (Array<map>)

        Information about the integrated development environment (IDE) configured for a Dev Environment.

        • runtime — (String)

          A link to the IDE runtime image.

        • name — (String)

          The name of the IDE.

      • instanceType — required — (String)

        The Amazon EC2 instace type used for the Dev Environment.

        Possible values include:
        • "dev.standard1.small"
        • "dev.standard1.medium"
        • "dev.standard1.large"
        • "dev.standard1.xlarge"
      • inactivityTimeoutMinutes — required — (Integer)

        The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.

      • persistentStorage — required — (map)

        Information about the configuration of persistent storage for the Dev Environment.

        • sizeInGiB — required — (Integer)

          The size of the persistent storage in gigabytes (specifically GiB).

          Note: Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
      • vpcConnectionName — (String)

        The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  devEnvironmentId: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codecatalyst.listDevEnvironmentSessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • devEnvironmentId — (String)

    The system-generated unique ID of the Dev Environment.

  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults — (Integer)

    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 NextToken element, which you can use to obtain additional results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • items — (Array<map>)

      Information about each session retrieved in the list.

      • spaceName — required — (String)

        The name of the space.

      • projectName — required — (String)

        The name of the project in the space.

      • devEnvironmentId — required — (String)

        The system-generated unique ID of the Dev Environment.

      • startedTime — required — (Date)

        The date and time the session started, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

      • id — required — (String)

        The system-generated unique ID of the Dev Environment session.

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  spaceName: 'STRING_VALUE', /* required */
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  eventName: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codecatalyst.listEventLogs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • startTime — (Date)

    The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • endTime — (Date)

    The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • eventName — (String)

    The name of the event.

  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults — (Integer)

    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 NextToken element, which you can use to obtain additional results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items — (Array<map>)

      Information about each event retrieved in the list.

      • id — required — (String)

        The system-generated unique ID of the event.

      • eventName — required — (String)

        The name of the event.

      • eventType — required — (String)

        The type of the event.

      • eventCategory — required — (String)

        The category for the event.

      • eventSource — required — (String)

        The source of the event.

      • eventTime — required — (Date)

        The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

      • operationType — required — (String)

        The type of the event.

        Possible values include:
        • "READONLY"
        • "MUTATION"
      • userIdentity — required — (map)

        The system-generated unique ID of the user whose actions are recorded in the event.

        • userType — required — (String)

          The role assigned to the user in a Amazon CodeCatalyst space or project when the event occurred.

          Possible values include:
          • "USER"
          • "AWS_ACCOUNT"
          • "UNKNOWN"
        • principalId — required — (String)

          The ID of the Amazon CodeCatalyst service principal.

        • userName — (String)

          The display name of the user in Amazon CodeCatalyst.

        • awsAccountId — (String)

          The Amazon Web Services account number of the user in Amazon Web Services, if any.

      • projectInformation — (map)

        Information about the project where the event occurred.

        • name — (String)

          The name of the project in the space.

        • projectId — (String)

          The system-generated unique ID of the project.

      • requestId — (String)

        The system-generated unique ID of the request.

      • requestPayload — (map)

        Information about the payload of the request.

        • contentType — (String)

          The type of content in the event payload.

        • data — (String)

          The data included in the event payload.

      • responsePayload — (map)

        Information about the payload of the response, if any.

        • contentType — (String)

          The type of content in the event payload.

        • data — (String)

          The data included in the event payload.

      • errorCode — (String)

        The code of the error, if any.

      • sourceIpAddress — (String)

        The IP address of the user whose actions are recorded in the event.

      • userAgent — (String)

        The user agent whose actions are recorded in the event.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  spaceName: 'STRING_VALUE', /* required */
  filters: [
    {
      key: hasAccessTo | name, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      comparisonOperator: EQ | GT | GE | LT | LE | BEGINS_WITH
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codecatalyst.listProjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults — (Integer)

    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 NextToken element, which you can use to obtain additional results.

  • filters — (Array<map>)

    Information about filters to apply to narrow the results returned in the list.

    • key — required — (String)

      A key that can be used to sort results.

      Possible values include:
      • "hasAccessTo"
      • "name"
    • values — required — (Array<String>)

      The values of the key.

    • comparisonOperator — (String)

      The operator used to compare the fields.

      Possible values include:
      • "EQ"
      • "GT"
      • "GE"
      • "LT"
      • "LE"
      • "BEGINS_WITH"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items — (Array<map>)

      Information about the projects.

      • name — required — (String)

        The name of the project in the space.

      • displayName — (String)

        The friendly name displayed to users of the project in Amazon CodeCatalyst.

      • description — (String)

        The description of the project.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codecatalyst.listSourceRepositories(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults — (Integer)

    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 NextToken element, which you can use to obtain additional results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • items — (Array<map>)

      Information about the source repositories.

      • id — required — (String)

        The system-generated unique ID of the source repository.

      • name — required — (String)

        The name of the source repository.

      • description — (String)

        The description of the repository, if any.

      • lastUpdatedTime — required — (Date)

        The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

      • createdTime — required — (Date)

        The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  projectName: 'STRING_VALUE', /* required */
  sourceRepositoryName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codecatalyst.listSourceRepositoryBranches(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • sourceRepositoryName — (String)

    The name of the source repository.

  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults — (Integer)

    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 NextToken element, which you can use to obtain additional results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items — (Array<map>)

      Information about the source branches.

      • ref — (String)

        The Git reference name of the branch.

      • name — (String)

        The name of the branch.

      • lastUpdatedTime — (Date)

        The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

      • headCommitId — (String)

        The commit ID of the tip of the branch at the time of the request, also known as the head commit.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nextToken: 'STRING_VALUE'
};
codecatalyst.listSpaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items — (Array<map>)

      Information about the spaces.

      • name — required — (String)

        The name of the space.

      • regionName — required — (String)

        The Amazon Web Services Region where the space exists.

      • displayName — (String)

        The friendly name of the space displayed to users.

      • description — (String)

        The description of the space.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: [
    {
    },
    /* more items */
  ],
  workflowId: 'STRING_VALUE'
};
codecatalyst.listWorkflowRuns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • workflowId — (String)

    The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

  • projectName — (String)

    The name of the project in the space.

  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults — (Integer)

    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 NextToken element, which you can use to obtain additional results.

  • sortBy — (Array<map>)

    Information used to sort the items in the returned list.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items — (Array<map>)

      Information about the runs of a workflow.

      • id — required — (String)

        The system-generated unique ID of the workflow run.

      • workflowId — required — (String)

        The system-generated unique ID of the workflow.

      • workflowName — required — (String)

        The name of the workflow.

      • status — required — (String)

        The status of the workflow run.

        Possible values include:
        • "SUCCEEDED"
        • "FAILED"
        • "STOPPED"
        • "SUPERSEDED"
        • "CANCELLED"
        • "NOT_RUN"
        • "VALIDATING"
        • "PROVISIONING"
        • "IN_PROGRESS"
        • "STOPPING"
        • "ABANDONED"
      • statusReasons — (Array<map>)

        The reasons for the workflow run status.

      • startTime — required — (Date)

        The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

      • endTime — (Date)

        The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

      • lastUpdatedTime — required — (Date)

        The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: [
    {
    },
    /* more items */
  ]
};
codecatalyst.listWorkflows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • nextToken — (String)

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults — (Integer)

    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 NextToken element, which you can use to obtain additional results.

  • sortBy — (Array<map>)

    Information used to sort the items in the returned list.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items — (Array<map>)

      Information about the workflows in a project.

      • id — required — (String)

        The system-generated unique ID of a workflow.

      • name — required — (String)

        The name of the workflow.

      • sourceRepositoryName — required — (String)

        The name of the source repository where the workflow definition file is stored.

      • sourceBranchName — required — (String)

        The name of the branch of the source repository where the workflow definition file is stored.

      • definition — required — (map)

        Information about the workflow definition file.

        • path — required — (String)

          The path to the workflow definition file stored in the source repository for the project, including the file name.

      • createdTime — required — (Date)

        The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

      • lastUpdatedTime — required — (Date)

        The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

      • runMode — required — (String)

        The run mode of the workflow.

        Possible values include:
        • "QUEUED"
        • "PARALLEL"
        • "SUPERSEDED"
      • status — required — (String)

        The status of the workflow.

        Possible values include:
        • "INVALID"
        • "ACTIVE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  ides: [
    {
      name: 'STRING_VALUE',
      runtime: 'STRING_VALUE'
    },
    /* more items */
  ],
  inactivityTimeoutMinutes: 'NUMBER_VALUE',
  instanceType: dev.standard1.small | dev.standard1.medium | dev.standard1.large | dev.standard1.xlarge
};
codecatalyst.startDevEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • id — (String)

    The system-generated unique ID of the Dev Environment.

  • ides — (Array<map>)

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    • runtime — (String)

      A link to the IDE runtime image.

      Note: This parameter is not required for VSCode.
    • name — (String)

      The name of the IDE. Valid values include Cloud9, IntelliJ, PyCharm, GoLand, and VSCode.

  • instanceType — (String)

    The Amazon EC2 instace type to use for the Dev Environment.

    Possible values include:
    • "dev.standard1.small"
    • "dev.standard1.medium"
    • "dev.standard1.large"
    • "dev.standard1.xlarge"
  • inactivityTimeoutMinutes — (Integer)

    The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The system-generated unique ID of the Dev Environment.

    • status — (String)

      The status of the Dev Environment.

      Possible values include:
      • "PENDING"
      • "RUNNING"
      • "STARTING"
      • "STOPPING"
      • "STOPPED"
      • "FAILED"
      • "DELETING"
      • "DELETED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  sessionConfiguration: { /* required */
    sessionType: SSM | SSH, /* required */
    executeCommandSessionConfiguration: {
      command: 'STRING_VALUE', /* required */
      arguments: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.startDevEnvironmentSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • id — (String)

    The system-generated unique ID of the Dev Environment.

  • sessionConfiguration — (map)

    Information about the configuration of a Dev Environment session.

    • sessionType — required — (String)

      The type of the session.

      Possible values include:
      • "SSM"
      • "SSH"
    • executeCommandSessionConfiguration — (map)

      Information about optional commands that will be run on the Dev Environment when the SSH session begins.

      • command — required — (String)

        The command used at the beginning of the SSH session to a Dev Environment.

      • arguments — (Array<String>)

        An array of arguments containing arguments and members.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • accessDetails — (map)

      Information about connection details for a Dev Environment.

      • streamUrl — required — (String)

        The URL used to send commands to and from the Dev Environment.

      • tokenValue — required — (String)

        An encrypted token value that contains session and caller information used to authenticate the connection.

    • sessionId — (String)

      The system-generated unique ID of the Dev Environment session.

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The system-generated unique ID of the Dev Environment.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
codecatalyst.startWorkflowRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • workflowId — (String)

    The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

  • clientToken — (String)

    A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The system-generated unique ID of the workflow run.

    • workflowId — (String)

      The system-generated unique ID of the workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.stopDevEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • id — (String)

    The system-generated unique ID of the Dev Environment.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The system-generated unique ID of the Dev Environment.

    • status — (String)

      The status of the Dev Environment.

      Possible values include:
      • "PENDING"
      • "RUNNING"
      • "STARTING"
      • "STOPPING"
      • "STOPPED"
      • "FAILED"
      • "DELETING"
      • "DELETED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE' /* required */
};
codecatalyst.stopDevEnvironmentSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • id — (String)

    The system-generated unique ID of the Dev Environment. To obtain this ID, use ListDevEnvironments.

  • sessionId — (String)

    The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • id — (String)

      The system-generated unique ID of the Dev Environment.

    • sessionId — (String)

      The system-generated unique ID of the Dev Environment session.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  alias: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  ides: [
    {
      name: 'STRING_VALUE',
      runtime: 'STRING_VALUE'
    },
    /* more items */
  ],
  inactivityTimeoutMinutes: 'NUMBER_VALUE',
  instanceType: dev.standard1.small | dev.standard1.medium | dev.standard1.large | dev.standard1.xlarge
};
codecatalyst.updateDevEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • projectName — (String)

    The name of the project in the space.

  • id — (String)

    The system-generated unique ID of the Dev Environment.

  • alias — (String)

    The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

  • ides — (Array<map>)

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    • runtime — (String)

      A link to the IDE runtime image.

      Note: This parameter is not required for VSCode.
    • name — (String)

      The name of the IDE. Valid values include Cloud9, IntelliJ, PyCharm, GoLand, and VSCode.

  • instanceType — (String)

    The Amazon EC2 instace type to use for the Dev Environment.

    Note: Changing this value will cause a restart of the Dev Environment if it is running.
    Possible values include:
    • "dev.standard1.small"
    • "dev.standard1.medium"
    • "dev.standard1.large"
    • "dev.standard1.xlarge"
  • inactivityTimeoutMinutes — (Integer)

    The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

    Note: Changing this value will cause a restart of the Dev Environment if it is running.
  • clientToken — (String)

    A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The system-generated unique ID of the Dev Environment.

    • spaceName — (String)

      The name of the space.

    • projectName — (String)

      The name of the project in the space.

    • alias — (String)

      The user-specified alias for the Dev Environment.

    • ides — (Array<map>)

      Information about the integrated development environment (IDE) configured for the Dev Environment.

      • runtime — (String)

        A link to the IDE runtime image.

        Note: This parameter is not required for VSCode.
      • name — (String)

        The name of the IDE. Valid values include Cloud9, IntelliJ, PyCharm, GoLand, and VSCode.

    • instanceType — (String)

      The Amazon EC2 instace type to use for the Dev Environment.

      Possible values include:
      • "dev.standard1.small"
      • "dev.standard1.medium"
      • "dev.standard1.large"
      • "dev.standard1.xlarge"
    • inactivityTimeoutMinutes — (Integer)

      The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.

    • clientToken — (String)

      A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  spaceName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
codecatalyst.updateProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceName — (String)

    The name of the space.

  • name — (String)

    The name of the project.

  • description — (String)

    The description of the project.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • spaceName — (String)

      The name of the space.

    • name — (String)

      The name of the project.

    • displayName — (String)

      The friendly name of the project displayed to users in Amazon CodeCatalyst.

    • description — (String)

      The description of the project.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
codecatalyst.updateSpace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the space.

  • description — (String)

    The description of the space.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • name — (String)

      The name of the space.

    • displayName — (String)

      The friendly name of the space displayed to users in Amazon CodeCatalyst.

    • description — (String)

      The description of the space.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

codecatalyst.verifySession(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • identity — (String)

      The system-generated unique ID of the user in Amazon CodeCatalyst.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.