@datafire/amazonaws_codestar
v5.0.0
Published
DataFire integration for AWS CodeStar
Downloads
24
Readme
@datafire/amazonaws_codestar
Client library for AWS CodeStar
Installation and Usage
npm install --save @datafire/amazonaws_codestar
let amazonaws_codestar = require('@datafire/amazonaws_codestar').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_codestar.AssociateTeamMember({
"projectId": "",
"userArn": "",
"projectRole": ""
}).then(data => {
console.log(data);
});
Description
AWS CodeStar 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.
Actions
AssociateTeamMember
amazonaws_codestar.AssociateTeamMember({
"projectId": "",
"userArn": "",
"projectRole": ""
}, context)
Input
- input
object
- clientRequestToken ClientRequestToken
- projectId required ProjectId
- projectRole required Role
- remoteAccessAllowed RemoteAccessAllowed
- userArn required UserArn
Output
- output AssociateTeamMemberResult
CreateProject
amazonaws_codestar.CreateProject({
"name": "",
"id": ""
}, context)
Input
- input
object
- clientRequestToken ClientRequestToken
- description ProjectDescription
- id required ProjectId
- name required ProjectName
Output
- output CreateProjectResult
CreateUserProfile
amazonaws_codestar.CreateUserProfile({
"userArn": "",
"displayName": "",
"emailAddress": ""
}, context)
Input
- input
object
- displayName required UserProfileDisplayName
- emailAddress required Email
- sshPublicKey SshPublicKey
- userArn required UserArn
Output
- output CreateUserProfileResult
DeleteProject
amazonaws_codestar.DeleteProject({
"id": ""
}, context)
Input
- input
object
- clientRequestToken ClientRequestToken
- deleteStack DeleteStack
- id required ProjectId
Output
- output DeleteProjectResult
DeleteUserProfile
amazonaws_codestar.DeleteUserProfile({
"userArn": ""
}, context)
Input
- input
object
- userArn required UserArn
Output
- output DeleteUserProfileResult
DescribeProject
amazonaws_codestar.DescribeProject({
"id": ""
}, context)
Input
- input
object
- id required ProjectId
Output
- output DescribeProjectResult
DescribeUserProfile
amazonaws_codestar.DescribeUserProfile({
"userArn": ""
}, context)
Input
- input
object
- userArn required UserArn
Output
- output DescribeUserProfileResult
DisassociateTeamMember
amazonaws_codestar.DisassociateTeamMember({
"projectId": "",
"userArn": ""
}, context)
Input
Output
- output DisassociateTeamMemberResult
ListProjects
amazonaws_codestar.ListProjects({}, context)
Input
- input
object
- maxResults MaxResults
- nextToken PaginationToken
Output
- output ListProjectsResult
ListResources
amazonaws_codestar.ListResources({
"projectId": ""
}, context)
Input
- input
object
- maxResults MaxResults
- nextToken PaginationToken
- projectId required ProjectId
Output
- output ListResourcesResult
ListTagsForProject
amazonaws_codestar.ListTagsForProject({
"id": ""
}, context)
Input
- input
object
- id required ProjectId
- maxResults MaxResults
- nextToken PaginationToken
Output
- output ListTagsForProjectResult
ListTeamMembers
amazonaws_codestar.ListTeamMembers({
"projectId": ""
}, context)
Input
- input
object
- maxResults MaxResults
- nextToken PaginationToken
- projectId required ProjectId
Output
- output ListTeamMembersResult
ListUserProfiles
amazonaws_codestar.ListUserProfiles({}, context)
Input
- input
object
- maxResults MaxResults
- nextToken PaginationToken
Output
- output ListUserProfilesResult
TagProject
amazonaws_codestar.TagProject({
"id": "",
"tags": []
}, context)
Input
Output
- output TagProjectResult
UntagProject
amazonaws_codestar.UntagProject({
"id": "",
"tags": []
}, context)
Input
Output
- output UntagProjectResult
UpdateProject
amazonaws_codestar.UpdateProject({
"id": ""
}, context)
Input
- input
object
- description ProjectDescription
- id required ProjectId
- name ProjectName
Output
- output UpdateProjectResult
UpdateTeamMember
amazonaws_codestar.UpdateTeamMember({
"projectId": "",
"userArn": ""
}, context)
Input
- input
object
- projectId required ProjectId
- projectRole Role
- remoteAccessAllowed RemoteAccessAllowed
- userArn required UserArn
Output
- output UpdateTeamMemberResult
UpdateUserProfile
amazonaws_codestar.UpdateUserProfile({
"userArn": ""
}, context)
Input
- input
object
- displayName UserProfileDisplayName
- emailAddress Email
- sshPublicKey SshPublicKey
- userArn required UserArn
Output
- output UpdateUserProfileResult
Definitions
AssociateTeamMemberRequest
- AssociateTeamMemberRequest
object
- clientRequestToken ClientRequestToken
- projectId required ProjectId
- projectRole required Role
- remoteAccessAllowed RemoteAccessAllowed
- userArn required UserArn
AssociateTeamMemberResult
- AssociateTeamMemberResult
object
- clientRequestToken ClientRequestToken
ClientRequestToken
- ClientRequestToken
string
ConcurrentModificationException
- ConcurrentModificationException
object
: Another modification is being made. That modification must complete before you can make your change.
CreateProjectRequest
- CreateProjectRequest
object
- clientRequestToken ClientRequestToken
- description ProjectDescription
- id required ProjectId
- name required ProjectName
CreateProjectResult
- CreateProjectResult
object
- arn required ProjectArn
- clientRequestToken ClientRequestToken
- id required ProjectId
- projectTemplateId ProjectTemplateId
CreateUserProfileRequest
- CreateUserProfileRequest
object
- displayName required UserProfileDisplayName
- emailAddress required Email
- sshPublicKey SshPublicKey
- userArn required UserArn
CreateUserProfileResult
- CreateUserProfileResult
object
- createdTimestamp CreatedTimestamp
- displayName UserProfileDisplayName
- emailAddress Email
- lastModifiedTimestamp LastModifiedTimestamp
- sshPublicKey SshPublicKey
- userArn required UserArn
CreatedTimestamp
- CreatedTimestamp
string
DeleteProjectRequest
- DeleteProjectRequest
object
- clientRequestToken ClientRequestToken
- deleteStack DeleteStack
- id required ProjectId
DeleteProjectResult
- DeleteProjectResult
object
- projectArn ProjectArn
- stackId StackId
DeleteStack
- DeleteStack
boolean
DeleteUserProfileRequest
- DeleteUserProfileRequest
object
- userArn required UserArn
DeleteUserProfileResult
- DeleteUserProfileResult
object
- userArn required UserArn
DescribeProjectRequest
- DescribeProjectRequest
object
- id required ProjectId
DescribeProjectResult
- DescribeProjectResult
object
- arn ProjectArn
- clientRequestToken ClientRequestToken
- createdTimeStamp CreatedTimestamp
- description ProjectDescription
- id ProjectId
- name ProjectName
- projectTemplateId ProjectTemplateId
- stackId StackId
DescribeUserProfileRequest
- DescribeUserProfileRequest
object
- userArn required UserArn
DescribeUserProfileResult
- DescribeUserProfileResult
object
- createdTimestamp required CreatedTimestamp
- displayName UserProfileDisplayName
- emailAddress Email
- lastModifiedTimestamp required LastModifiedTimestamp
- sshPublicKey SshPublicKey
- userArn required UserArn
DisassociateTeamMemberRequest
DisassociateTeamMemberResult
- DisassociateTeamMemberResult
object
- Email
string
InvalidNextTokenException
- InvalidNextTokenException
object
: The next token is not valid.
InvalidServiceRoleException
- InvalidServiceRoleException
object
: The service role is not valid.
LastModifiedTimestamp
- LastModifiedTimestamp
string
LimitExceededException
- LimitExceededException
object
: A resource limit has been exceeded.
ListProjectsRequest
- ListProjectsRequest
object
- maxResults MaxResults
- nextToken PaginationToken
ListProjectsResult
- ListProjectsResult
object
- nextToken PaginationToken
- projects required ProjectsList
ListResourcesRequest
- ListResourcesRequest
object
- maxResults MaxResults
- nextToken PaginationToken
- projectId required ProjectId
ListResourcesResult
- ListResourcesResult
object
- nextToken PaginationToken
- resources ResourcesResult
ListTagsForProjectRequest
- ListTagsForProjectRequest
object
- id required ProjectId
- maxResults MaxResults
- nextToken PaginationToken
ListTagsForProjectResult
- ListTagsForProjectResult
object
- nextToken PaginationToken
- tags Tags
ListTeamMembersRequest
- ListTeamMembersRequest
object
- maxResults MaxResults
- nextToken PaginationToken
- projectId required ProjectId
ListTeamMembersResult
- ListTeamMembersResult
object
- nextToken PaginationToken
- teamMembers required TeamMemberResult
ListUserProfilesRequest
- ListUserProfilesRequest
object
- maxResults MaxResults
- nextToken PaginationToken
ListUserProfilesResult
- ListUserProfilesResult
object
- nextToken PaginationToken
- userProfiles required UserProfilesList
MaxResults
- MaxResults
integer
PaginationToken
- PaginationToken
string
ProjectAlreadyExistsException
- ProjectAlreadyExistsException
object
: An AWS CodeStar project with the same ID already exists in this region for the AWS account. AWS CodeStar project IDs must be unique within a region for the AWS account.
ProjectArn
- ProjectArn
string
ProjectConfigurationException
- ProjectConfigurationException
object
: Project configuration information is required but not specified.
ProjectCreationFailedException
- ProjectCreationFailedException
object
: The project creation request was valid, but a nonspecific exception or error occurred during project creation. The project could not be created in AWS CodeStar.
ProjectDescription
- ProjectDescription
string
ProjectId
- ProjectId
string
ProjectName
- ProjectName
string
ProjectNotFoundException
- ProjectNotFoundException
object
: The specified AWS CodeStar project was not found.
ProjectSummary
- ProjectSummary
object
: Information about the metadata for a project.- projectArn ProjectArn
- projectId ProjectId
ProjectTemplateId
- ProjectTemplateId
string
ProjectsList
- ProjectsList
array
- items ProjectSummary
RemoteAccessAllowed
- RemoteAccessAllowed
boolean
Resource
- Resource
object
: Information about a resource for a project.- id required ResourceId
ResourceId
- ResourceId
string
ResourcesResult
- ResourcesResult
array
- items Resource
Role
- Role
string
SshPublicKey
- SshPublicKey
string
StackId
- StackId
string
TagKey
- TagKey
string
TagKeys
- TagKeys
array
- items TagKey
TagProjectRequest
TagProjectResult
- TagProjectResult
object
- tags Tags
TagValue
- TagValue
string
Tags
TeamMember
- TeamMember
object
: Information about a team member in a project.- projectRole required Role
- remoteAccessAllowed RemoteAccessAllowed
- userArn required UserArn
TeamMemberAlreadyAssociatedException
- TeamMemberAlreadyAssociatedException
object
: The team member is already associated with a role in this project.
TeamMemberNotFoundException
- TeamMemberNotFoundException
object
: The specified team member was not found.
TeamMemberResult
- TeamMemberResult
array
- items TeamMember
UntagProjectRequest
UntagProjectResult
- UntagProjectResult
object
UpdateProjectRequest
- UpdateProjectRequest
object
- description ProjectDescription
- id required ProjectId
- name ProjectName
UpdateProjectResult
- UpdateProjectResult
object
UpdateTeamMemberRequest
- UpdateTeamMemberRequest
object
- projectId required ProjectId
- projectRole Role
- remoteAccessAllowed RemoteAccessAllowed
- userArn required UserArn
UpdateTeamMemberResult
- UpdateTeamMemberResult
object
- projectRole Role
- remoteAccessAllowed RemoteAccessAllowed
- userArn UserArn
UpdateUserProfileRequest
- UpdateUserProfileRequest
object
- displayName UserProfileDisplayName
- emailAddress Email
- sshPublicKey SshPublicKey
- userArn required UserArn
UpdateUserProfileResult
- UpdateUserProfileResult
object
- createdTimestamp CreatedTimestamp
- displayName UserProfileDisplayName
- emailAddress Email
- lastModifiedTimestamp LastModifiedTimestamp
- sshPublicKey SshPublicKey
- userArn required UserArn
UserArn
- UserArn
string
UserProfileAlreadyExistsException
- UserProfileAlreadyExistsException
object
: A user profile with that name already exists in this region for the AWS account. AWS CodeStar user profile names must be unique within a region for the AWS account.
UserProfileDisplayName
- UserProfileDisplayName
string
UserProfileNotFoundException
- UserProfileNotFoundException
object
: The user profile was not found.
UserProfileSummary
- UserProfileSummary
object
: Information about a user's profile in AWS CodeStar.- displayName UserProfileDisplayName
- emailAddress Email
- sshPublicKey SshPublicKey
- userArn UserArn
UserProfilesList
- UserProfilesList
array
- items UserProfileSummary
ValidationException
- ValidationException
object
: The specified input is either not valid, or it could not be validated.