Class: AWS.CodeStar

Inherits:
AWS.Service show all
Identifier:
codestar
API Version:
2017-04-19
Defined in:
(unknown)

Overview

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

Service Description

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

  • DeleteProject, which deletes a project.

  • DescribeProject, which lists the attributes of a project.

  • ListProjects, which lists all projects associated with your AWS account.

  • ListResources, which lists the resources associated with a project.

  • ListTagsForProject, which lists the tags associated with a project.

  • TagProject, which adds tags to a project.

  • UntagProject, which removes tags from a project.

  • UpdateProject, which updates the attributes of a project.

Teams and team members, by calling the following:

  • AssociateTeamMember, which adds an IAM user to the team for a project.

  • DisassociateTeamMember, which removes an IAM user from the team for a project.

  • ListTeamMembers, which lists all the IAM users in the team for a project, including their roles and attributes.

  • UpdateTeamMember, which updates a team member's attributes in a project.

Users, by calling the following:

  • CreateUserProfile, which creates a user profile that contains data associated with the user across all projects.

  • DeleteUserProfile, which deletes all user profile information across all projects.

  • DescribeUserProfile, which describes the profile of a user.

  • ListUserProfiles, which lists all user profiles.

  • UpdateUserProfile, which updates the profile for a user.

Sending a Request Using CodeStar

var codestar = new AWS.CodeStar();
codestar.associateTeamMember(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 CodeStar object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codestar = new AWS.CodeStar({apiVersion: '2017-04-19'});

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

AWS.config.apiVersions = {
  codestar: '2017-04-19',
  // other service API versions
};

var codestar = new AWS.CodeStar();

Version:

  • 2017-04-19

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a CodeStar object

var codestar = new AWS.CodeStar({apiVersion: '2017-04-19'});

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) —

    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'.

  • 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.CodeStar.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.CodeStar.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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • 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.

Property Details

endpoint ⇒ AWS.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

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

Adds an IAM user to the team for an AWS CodeStar project.

Service Reference:

Examples:

Calling the associateTeamMember operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  projectRole: 'STRING_VALUE', /* required */
  userArn: 'STRING_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE',
  remoteAccessAllowed: true || false
};
codestar.associateTeamMember(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: {}) —
    • projectId — (String)

      The ID of the project to which you will add the IAM user.

    • clientRequestToken — (String)

      A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.

    • userArn — (String)

      The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.

    • projectRole — (String)

      The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.

    • remoteAccessAllowed — (Boolean)

      Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.

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:

      • clientRequestToken — (String)

        The user- or system-generated token from the initial request that can be used to repeat the request.

Returns:

  • (AWS.Request) —

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

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

Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.

Service Reference:

Examples:

Calling the createProject operation

var params = {
  id: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  sourceCode: [
    {
      destination: { /* required */
        codeCommit: {
          name: 'STRING_VALUE' /* required */
        },
        gitHub: {
          issuesEnabled: true || false, /* required */
          name: 'STRING_VALUE', /* required */
          owner: 'STRING_VALUE', /* required */
          privateRepository: true || false, /* required */
          token: 'STRING_VALUE', /* required */
          type: 'STRING_VALUE', /* required */
          description: 'STRING_VALUE'
        }
      },
      source: { /* required */
        s3: { /* required */
          bucketKey: 'STRING_VALUE',
          bucketName: 'STRING_VALUE'
        }
      }
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  toolchain: {
    source: { /* required */
      s3: { /* required */
        bucketKey: 'STRING_VALUE',
        bucketName: 'STRING_VALUE'
      }
    },
    roleArn: 'STRING_VALUE',
    stackParameters: {
      '<TemplateParameterKey>': 'STRING_VALUE',
      /* '<TemplateParameterKey>': ... */
    }
  }
};
codestar.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: {}) —
    • name — (String)

      The display name for the project to be created in AWS CodeStar.

    • id — (String)

      The ID of the project to be created in AWS CodeStar.

    • description — (String)

      The description of the project, if any.

    • clientRequestToken — (String)

      A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.

    • sourceCode — (Array<map>)

      A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.

      • source — required — (map)

        The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.

        • s3 — required — (map)

          Information about the Amazon S3 location where the source code files provided with the project request are stored.

          • bucketName — (String)

            The Amazon S3 bucket name where the source code files provided with the project request are stored.

          • bucketKey — (String)

            The Amazon S3 object key where the source code files provided with the project request are stored.

      • destination — required — (map)

        The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the project request are placed in the repository.

        • codeCommit — (map)

          Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

          • name — required — (String)

            The name of the AWS CodeCommit repository to be created in AWS CodeStar.

        • gitHub — (map)

          Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

          • name — required — (String)

            Name of the GitHub repository to be created in AWS CodeStar.

          • description — (String)

            Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.

          • type — required — (String)

            The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.

          • owner — required — (String)

            The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name.

          • privateRepository — required — (Boolean)

            Whether the GitHub repository is to be a private repository.

          • issuesEnabled — required — (Boolean)

            Whether to enable issues for the GitHub repository.

          • token — required — (String)

            The GitHub user's personal access token for the GitHub repository.

    • toolchain — (map)

      The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter.

      • source — required — (map)

        The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.

        • s3 — required — (map)

          The Amazon S3 bucket where the toolchain template file provided with the project request is stored.

          • bucketName — (String)

            The Amazon S3 bucket name where the source code files provided with the project request are stored.

          • bucketKey — (String)

            The Amazon S3 object key where the source code files provided with the project request are stored.

      • roleArn — (String)

        The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.

      • stackParameters — (map<String>)

        The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.

    • tags — (map<String>)

      The tags created for 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:

      • id — (String)

        The ID of the project.

      • arn — (String)

        The Amazon Resource Name (ARN) of the created project.

      • clientRequestToken — (String)

        A user- or system-generated token that identifies the entity that requested project creation.

      • projectTemplateId — (String)

        Reserved for future use.

Returns:

  • (AWS.Request) —

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

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

Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

Service Reference:

Examples:

Calling the createUserProfile operation

var params = {
  displayName: 'STRING_VALUE', /* required */
  emailAddress: 'STRING_VALUE', /* required */
  userArn: 'STRING_VALUE', /* required */
  sshPublicKey: 'STRING_VALUE'
};
codestar.createUserProfile(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: {}) —
    • userArn — (String)

      The Amazon Resource Name (ARN) of the user in IAM.

    • displayName — (String)

      The name that will be displayed as the friendly name for the user in AWS CodeStar.

    • emailAddress — (String)

      The email address that will be displayed as part of the user's profile in AWS CodeStar.

    • sshPublicKey — (String)

      The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

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:

      • userArn — (String)

        The Amazon Resource Name (ARN) of the user in IAM.

      • displayName — (String)

        The name that is displayed as the friendly name for the user in AWS CodeStar.

      • emailAddress — (String)

        The email address that is displayed as part of the user's profile in AWS CodeStar.

      • sshPublicKey — (String)

        The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.

      • createdTimestamp — (Date)

        The date the user profile was created, in timestamp format.

      • lastModifiedTimestamp — (Date)

        The date the user profile was last modified, in timestamp format.

Returns:

  • (AWS.Request) —

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

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

Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.

Service Reference:

Examples:

Calling the deleteProject operation

var params = {
  id: 'STRING_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE',
  deleteStack: true || false
};
codestar.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: {}) —
    • id — (String)

      The ID of the project to be deleted in AWS CodeStar.

    • clientRequestToken — (String)

      A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.

    • deleteStack — (Boolean)

      Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.

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:

      • stackId — (String)

        The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.

      • projectArn — (String)

        The Amazon Resource Name (ARN) of the deleted project.

Returns:

  • (AWS.Request) —

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

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

Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.

Service Reference:

Examples:

Calling the deleteUserProfile operation

var params = {
  userArn: 'STRING_VALUE' /* required */
};
codestar.deleteUserProfile(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: {}) —
    • userArn — (String)

      The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.

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:

      • userArn — (String)

        The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.

Returns:

  • (AWS.Request) —

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

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

Describes a project and its resources.

Service Reference:

Examples:

Calling the describeProject operation

var params = {
  id: 'STRING_VALUE' /* required */
};
codestar.describeProject(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 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:

      • name — (String)

        The display name for the project.

      • id — (String)

        The ID of the project.

      • arn — (String)

        The Amazon Resource Name (ARN) for the project.

      • description — (String)

        The description of the project, if any.

      • clientRequestToken — (String)

        A user- or system-generated token that identifies the entity that requested project creation.

      • createdTimeStamp — (Date)

        The date and time the project was created, in timestamp format.

      • stackId — (String)

        The ID of the primary stack in AWS CloudFormation used to generate resources for the project.

      • projectTemplateId — (String)

        The ID for the AWS CodeStar project template used to create the project.

      • status — (map)

        The project creation or deletion status.

        • state — required — (String)

          The phase of completion for a project creation or deletion.

        • reason — (String)

          In the case of a project creation or deletion failure, a reason for the failure.

Returns:

  • (AWS.Request) —

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

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

Describes a user in AWS CodeStar and the user attributes across all projects.

Service Reference:

Examples:

Calling the describeUserProfile operation

var params = {
  userArn: 'STRING_VALUE' /* required */
};
codestar.describeUserProfile(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: {}) —
    • userArn — (String)

      The Amazon Resource Name (ARN) of the user.

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:

      • userArn — (String)

        The Amazon Resource Name (ARN) of the user.

      • displayName — (String)

        The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").

      • emailAddress — (String)

        The email address for the user. Optional.

      • sshPublicKey — (String)

        The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources.

      • createdTimestamp — (Date)

        The date and time when the user profile was created in AWS CodeStar, in timestamp format.

      • lastModifiedTimestamp — (Date)

        The date and time when the user profile was last modified, in timestamp format.

Returns:

  • (AWS.Request) —

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

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

Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.

Service Reference:

Examples:

Calling the disassociateTeamMember operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  userArn: 'STRING_VALUE' /* required */
};
codestar.disassociateTeamMember(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: {}) —
    • projectId — (String)

      The ID of the AWS CodeStar project from which you want to remove a team member.

    • userArn — (String)

      The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from 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.

Returns:

  • (AWS.Request) —

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

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

Lists all projects in AWS CodeStar associated with your AWS account.

Service Reference:

Examples:

Calling the listProjects operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codestar.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: {}) —
    • nextToken — (String)

      The continuation token to be used to return the next set of results, if the results cannot be returned in one response.

    • maxResults — (Integer)

      The maximum amount of data that can be contained in a single set of 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:

      • projects — (Array<map>)

        A list of projects.

        • projectId — (String)

          The ID of the project.

        • projectArn — (String)

          The Amazon Resource Name (ARN) of the project.

      • nextToken — (String)

        The continuation token to use when requesting the next set of results, if there are more results to be returned.

Returns:

  • (AWS.Request) —

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

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

Lists resources associated with a project in AWS CodeStar.

Service Reference:

Examples:

Calling the listResources operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codestar.listResources(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: {}) —
    • projectId — (String)

      The ID of the project.

    • nextToken — (String)

      The continuation token for the next set of results, if the results cannot be returned in one response.

    • maxResults — (Integer)

      The maximum amount of data that can be contained in a single set of 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:

      • resources — (Array<map>)

        An array of resources associated with the project.

        • id — required — (String)

          The Amazon Resource Name (ARN) of the resource.

      • nextToken — (String)

        The continuation token to use when requesting the next set of results, if there are more results to be returned.

Returns:

  • (AWS.Request) —

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

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

Gets the tags for a project.

Service Reference:

Examples:

Calling the listTagsForProject operation

var params = {
  id: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codestar.listTagsForProject(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 project to get tags for.

    • nextToken — (String)

      Reserved for future use.

    • maxResults — (Integer)

      Reserved for future use.

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:

      • tags — (map<String>)

        The tags for the project.

      • nextToken — (String)

        Reserved for future use.

Returns:

  • (AWS.Request) —

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

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

Lists all team members associated with a project.

Service Reference:

Examples:

Calling the listTeamMembers operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codestar.listTeamMembers(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: {}) —
    • projectId — (String)

      The ID of the project for which you want to list team members.

    • nextToken — (String)

      The continuation token for the next set of results, if the results cannot be returned in one response.

    • maxResults — (Integer)

      The maximum number of team members you want returned in a response.

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:

      • teamMembers — (Array<map>)

        A list of team member objects for the project.

        • userArn — required — (String)

          The Amazon Resource Name (ARN) of the user in IAM.

        • projectRole — required — (String)

          The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.

        • remoteAccessAllowed — (Boolean)

          Whether the user is allowed to remotely access project resources using an SSH public/private key pair.

      • nextToken — (String)

        The continuation token to use when requesting the next set of results, if there are more results to be returned.

Returns:

  • (AWS.Request) —

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

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

Lists all the user profiles configured for your AWS account in AWS CodeStar.

Service Reference:

Examples:

Calling the listUserProfiles operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codestar.listUserProfiles(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)

      The continuation token for the next set of results, if the results cannot be returned in one response.

    • maxResults — (Integer)

      The maximum number of results to return in a response.

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:

      • userProfiles — (Array<map>)

        All the user profiles configured in AWS CodeStar for an AWS account.

        • userArn — (String)

          The Amazon Resource Name (ARN) of the user in IAM.

        • displayName — (String)

          The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").

        • emailAddress — (String)

          The email address associated with the user.

        • sshPublicKey — (String)

          The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

      • nextToken — (String)

        The continuation token to use when requesting the next set of results, if there are more results to be returned.

Returns:

  • (AWS.Request) —

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

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

Adds tags to a project.

Service Reference:

Examples:

Calling the tagProject operation

var params = {
  id: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
codestar.tagProject(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 project you want to add a tag to.

    • tags — (map<String>)

      The tags you want to add to 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:

      • tags — (map<String>)

        The tags for the project.

Returns:

  • (AWS.Request) —

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

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

Removes tags from a project.

Service Reference:

Examples:

Calling the untagProject operation

var params = {
  id: 'STRING_VALUE', /* required */
  tags: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
codestar.untagProject(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 project to remove tags from.

    • tags — (Array<String>)

      The tags to remove from 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.

Returns:

  • (AWS.Request) —

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

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

Updates a project in AWS CodeStar.

Service Reference:

Examples:

Calling the updateProject operation

var params = {
  id: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
codestar.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: {}) —
    • id — (String)

      The ID of the project you want to update.

    • name — (String)

      The name of the project you want to update.

    • description — (String)

      The description of the project, 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.

Returns:

  • (AWS.Request) —

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

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

Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources.

Service Reference:

Examples:

Calling the updateTeamMember operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  userArn: 'STRING_VALUE', /* required */
  projectRole: 'STRING_VALUE',
  remoteAccessAllowed: true || false
};
codestar.updateTeamMember(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: {}) —
    • projectId — (String)

      The ID of the project.

    • userArn — (String)

      The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.

    • projectRole — (String)

      The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.

    • remoteAccessAllowed — (Boolean)

      Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources.

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:

      • userArn — (String)

        The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.

      • projectRole — (String)

        The project role granted to the user.

      • remoteAccessAllowed — (Boolean)

        Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.

Returns:

  • (AWS.Request) —

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

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

Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

Service Reference:

Examples:

Calling the updateUserProfile operation

var params = {
  userArn: 'STRING_VALUE', /* required */
  displayName: 'STRING_VALUE',
  emailAddress: 'STRING_VALUE',
  sshPublicKey: 'STRING_VALUE'
};
codestar.updateUserProfile(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: {}) —
    • userArn — (String)

      The name that will be displayed as the friendly name for the user in AWS CodeStar.

    • displayName — (String)

      The name that is displayed as the friendly name for the user in AWS CodeStar.

    • emailAddress — (String)

      The email address that is displayed as part of the user's profile in AWS CodeStar.

    • sshPublicKey — (String)

      The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

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:

      • userArn — (String)

        The Amazon Resource Name (ARN) of the user in IAM.

      • displayName — (String)

        The name that is displayed as the friendly name for the user in AWS CodeStar.

      • emailAddress — (String)

        The email address that is displayed as part of the user's profile in AWS CodeStar.

      • sshPublicKey — (String)

        The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.

      • createdTimestamp — (Date)

        The date the user profile was created, in timestamp format.

      • lastModifiedTimestamp — (Date)

        The date the user profile was last modified, in timestamp format.

Returns:

  • (AWS.Request) —

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