We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.CodeCatalyst

Inherits:
AWS.Service show all
Identifier:
codecatalyst
API Version:
2022-09-28
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst API to work with the following objects.

Spaces, by calling the following:

  • DeleteSpace, which deletes a space.

  • GetSpace, which returns information about a space.

  • GetSubscription, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.

  • ListSpaces, which retrieves a list of spaces.

  • UpdateSpace, which changes one or more values for a space.

Projects, by calling the following:

  • CreateProject which creates a project in a specified space.

  • GetProject, which returns information about a project.

  • ListProjects, which retrieves a list of projects in a space.

Users, by calling the following:

  • GetUserDetails, which returns information about a user in Amazon CodeCatalyst.

Source repositories, by calling the following:

Dev Environments and the Amazon Web Services Toolkits, by calling the following:

Workflows, by calling the following:

Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:

  • CreateAccessToken, which creates a personal access token (PAT) for the current user.

  • DeleteAccessToken, which deletes a specified personal access token (PAT).

  • ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.

  • ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.

  • VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

Note: If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO). For more information, see Setting up to use the CLI with Amazon CodeCatalyst and the SSO documentation for your SDK.

Sending a Request Using CodeCatalyst

var codecatalyst = new AWS.CodeCatalyst();
codecatalyst.createAccessToken(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodeCatalyst object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codecatalyst = new AWS.CodeCatalyst({apiVersion: '2022-09-28'});

You can also set the API version globally in AWS.config.apiVersions using the codecatalyst service identifier:

AWS.config.apiVersions = {
  codecatalyst: '2022-09-28',
  // other service API versions
};

var codecatalyst = new AWS.CodeCatalyst();

Version:

  • 2022-09-28

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.CodeCatalyst(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CodeCatalyst object

var codecatalyst = new AWS.CodeCatalyst({apiVersion: '2022-09-28'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.CodeCatalyst.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.CodeCatalyst.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CodeCatalyst.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createAccessToken(params = {}, callback) ⇒ AWS.Request

Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst.

Service Reference:

Examples:

Calling the createAccessToken operation

var params = {
  name: 'STRING_VALUE', /* required */
  expiresTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
codecatalyst.createAccessToken(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 friendly name of the personal access token.

    • expiresTime — (Date)

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

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:

      • secret — (String)

        The secret value of the personal access token.

      • name — (String)

        The friendly name of the personal access token.

      • expiresTime — (Date)

        The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339. If not specified, the default is one year from creation.

      • accessTokenId — (String)

        The system-generated unique ID of the access token.

Returns:

  • (AWS.Request)

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

createDevEnvironment(params = {}, callback) ⇒ AWS.Request

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.

Note: When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.

Service Reference:

Examples:

Calling the createDevEnvironment operation

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.

      • repositoryNamerequired — (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.
      • sizeInGiBrequired — (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.

createProject(params = {}, callback) ⇒ AWS.Request

Creates a project in a specified space.

Service Reference:

Examples:

Calling the createProject operation

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.

createSourceRepository(params = {}, callback) ⇒ AWS.Request

Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named main.

Service Reference:

Examples:

Calling the createSourceRepository operation

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.

createSourceRepositoryBranch(params = {}, callback) ⇒ AWS.Request

Creates a branch in a specified source repository in Amazon CodeCatalyst.

Note: This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.

Service Reference:

Examples:

Calling the createSourceRepositoryBranch operation

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.

deleteAccessToken(params = {}, callback) ⇒ AWS.Request

Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.

Service Reference:

Examples:

Calling the deleteAccessToken operation

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.

deleteDevEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes a Dev Environment.

Service Reference:

Examples:

Calling the deleteDevEnvironment operation

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.

deleteProject(params = {}, callback) ⇒ AWS.Request

Deletes a project in a space.

Service Reference:

Examples:

Calling the deleteProject operation

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.

deleteSourceRepository(params = {}, callback) ⇒ AWS.Request

Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.

Service Reference:

Examples:

Calling the deleteSourceRepository operation

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.

deleteSpace(params = {}, callback) ⇒ AWS.Request

Deletes a space.

Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.

Service Reference:

Examples:

Calling the deleteSpace operation

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.

getDevEnvironment(params = {}, callback) ⇒ AWS.Request

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

Service Reference:

Examples:

Calling the getDevEnvironment operation

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.

        • repositoryNamerequired — (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.

        • sizeInGiBrequired — (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.

getProject(params = {}, callback) ⇒ AWS.Request

Returns information about a project.

Service Reference:

Examples:

Calling the getProject operation

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.

getSourceRepository(params = {}, callback) ⇒ AWS.Request

Returns information about a source repository.

Service Reference:

Examples:

Calling the getSourceRepository operation

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.

getSourceRepositoryCloneUrls(params = {}, callback) ⇒ AWS.Request

Returns information about the URLs that can be used with a Git client to clone a source repository.

Service Reference:

Examples:

Calling the getSourceRepositoryCloneUrls operation

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.

getSpace(params = {}, callback) ⇒ AWS.Request

Returns information about an space.

Service Reference:

Examples:

Calling the getSpace operation

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.

getSubscription(params = {}, callback) ⇒ AWS.Request

Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.

Service Reference:

Examples:

Calling the getSubscription operation

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.

getUserDetails(params = {}, callback) ⇒ AWS.Request

Returns information about a user.

Service Reference:

Examples:

Calling the getUserDetails operation

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.

getWorkflow(params = {}, callback) ⇒ AWS.Request

Returns information about a workflow.

Service Reference:

Examples:

Calling the getWorkflow operation

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.

        • pathrequired — (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.

getWorkflowRun(params = {}, callback) ⇒ AWS.Request

Returns information about a specified run of a workflow.

Service Reference:

Examples:

Calling the getWorkflowRun operation

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.

listAccessTokens(params = {}, callback) ⇒ AWS.Request

Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.

Service Reference:

Examples:

Calling the listAccessTokens operation

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.

        • idrequired — (String)

          The system-generated ID of the personal access token.

        • namerequired — (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.

listDevEnvironments(params = {}, callback) ⇒ AWS.Request

Retrieves a list of Dev Environments in a project.

Service Reference:

Examples:

Calling the listDevEnvironments operation

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.

      • keyrequired — (String)

        A key that can be used to sort results.

      • valuesrequired — (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.

        • idrequired — (String)

          The system-generated unique ID for the Dev Environment.

        • lastUpdatedTimerequired — (Date)

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

        • creatorIdrequired — (String)

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

        • statusrequired — (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.

        • repositoriesrequired — (Array<map>)

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

          • repositoryNamerequired — (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.

        • instanceTyperequired — (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"
        • inactivityTimeoutMinutesrequired — (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.

        • persistentStoragerequired — (map)

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

          • sizeInGiBrequired — (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.

listDevEnvironmentSessions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of active sessions for a Dev Environment in a project.

Service Reference:

Examples:

Calling the listDevEnvironmentSessions operation

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.

        • spaceNamerequired — (String)

          The name of the space.

        • projectNamerequired — (String)

          The name of the project in the space.

        • devEnvironmentIdrequired — (String)

          The system-generated unique ID of the Dev Environment.

        • startedTimerequired — (Date)

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

        • idrequired — (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.

listEventLogs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide.

Note: ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with CloudTrail trails.

Service Reference:

Examples:

Calling the listEventLogs operation

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.

        • idrequired — (String)

          The system-generated unique ID of the event.

        • eventNamerequired — (String)

          The name of the event.

        • eventTyperequired — (String)

          The type of the event.

        • eventCategoryrequired — (String)

          The category for the event.

        • eventSourcerequired — (String)

          The source of the event.

        • eventTimerequired — (Date)

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

        • operationTyperequired — (String)

          The type of the event.

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

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

          • userTyperequired — (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"
          • principalIdrequired — (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.

listProjects(params = {}, callback) ⇒ AWS.Request

Retrieves a list of projects.

Service Reference:

Examples:

Calling the listProjects operation

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.

      • keyrequired — (String)

        A key that can be used to sort results.

        Possible values include:
        • "hasAccessTo"
        • "name"
      • valuesrequired — (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.

        • namerequired — (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.

listSourceRepositories(params = {}, callback) ⇒ AWS.Request

Retrieves a list of source repositories in a project.

Service Reference:

Examples:

Calling the listSourceRepositories operation

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.

        • idrequired — (String)

          The system-generated unique ID of the source repository.

        • namerequired — (String)

          The name of the source repository.

        • description — (String)

          The description of the repository, if any.

        • lastUpdatedTimerequired — (Date)

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

        • createdTimerequired — (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.

listSourceRepositoryBranches(params = {}, callback) ⇒ AWS.Request

Retrieves a list of branches in a specified source repository.

Service Reference:

Examples:

Calling the listSourceRepositoryBranches operation

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.

listSpaces(params = {}, callback) ⇒ AWS.Request

Retrieves a list of spaces.

Service Reference:

Examples:

Calling the listSpaces operation

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.

        • namerequired — (String)

          The name of the space.

        • regionNamerequired — (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.

listWorkflowRuns(params = {}, callback) ⇒ AWS.Request

Retrieves a list of workflow runs of a specified workflow.

Service Reference:

Examples:

Calling the listWorkflowRuns operation

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.

        • idrequired — (String)

          The system-generated unique ID of the workflow run.

        • workflowIdrequired — (String)

          The system-generated unique ID of the workflow.

        • workflowNamerequired — (String)

          The name of the workflow.

        • statusrequired — (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.

        • startTimerequired — (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

        • lastUpdatedTimerequired — (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.

listWorkflows(params = {}, callback) ⇒ AWS.Request

Retrieves a list of workflows in a specified project.

Service Reference:

Examples:

Calling the listWorkflows operation

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.

        • idrequired — (String)

          The system-generated unique ID of a workflow.

        • namerequired — (String)

          The name of the workflow.

        • sourceRepositoryNamerequired — (String)

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

        • sourceBranchNamerequired — (String)

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

        • definitionrequired — (map)

          Information about the workflow definition file.

          • pathrequired — (String)

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

        • createdTimerequired — (Date)

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

        • lastUpdatedTimerequired — (Date)

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

        • runModerequired — (String)

          The run mode of the workflow.

          Possible values include:
          • "QUEUED"
          • "PARALLEL"
          • "SUPERSEDED"
        • statusrequired — (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.

startDevEnvironment(params = {}, callback) ⇒ AWS.Request

Starts a specified Dev Environment and puts it into an active state.

Service Reference:

Examples:

Calling the startDevEnvironment operation

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.

startDevEnvironmentSession(params = {}, callback) ⇒ AWS.Request

Starts a session for a specified Dev Environment.

Service Reference:

Examples:

Calling the startDevEnvironmentSession operation

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.

      • sessionTyperequired — (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.

        • commandrequired — (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.

        • streamUrlrequired — (String)

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

        • tokenValuerequired — (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.

startWorkflowRun(params = {}, callback) ⇒ AWS.Request

Begins a run of a specified workflow.

Service Reference:

Examples:

Calling the startWorkflowRun operation

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.

stopDevEnvironment(params = {}, callback) ⇒ AWS.Request

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

Service Reference:

Examples:

Calling the stopDevEnvironment operation

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.

stopDevEnvironmentSession(params = {}, callback) ⇒ AWS.Request

Stops a session for a specified Dev Environment.

Service Reference:

Examples:

Calling the stopDevEnvironmentSession operation

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.

updateDevEnvironment(params = {}, callback) ⇒ AWS.Request

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

Service Reference:

Examples:

Calling the updateDevEnvironment operation

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.

updateProject(params = {}, callback) ⇒ AWS.Request

Changes one or more values for a project.

Service Reference:

Examples:

Calling the updateProject operation

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.

updateSpace(params = {}, callback) ⇒ AWS.Request

Changes one or more values for a space.

Service Reference:

Examples:

Calling the updateSpace operation

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.

verifySession(params = {}, callback) ⇒ AWS.Request

Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.

Service Reference:

Examples:

Calling the verifySession operation

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.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given CodeCatalyst resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

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.