codestar: AWS CodeStar

Description Usage Arguments Value Service syntax Operations Examples

View source: R/paws.R

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:

Teams and team members, by calling the following:

Users, by calling the following:

Usage

1
codestar(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- codestar(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_team_member Adds an IAM user to the team for an AWS CodeStar project
create_project Creates a project, including project resources
create_user_profile 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
delete_project Deletes a project, including project resources
delete_user_profile Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address
describe_project Describes a project and its resources
describe_user_profile Describes a user in AWS CodeStar and the user attributes across all projects
disassociate_team_member Removes a user from a project
list_projects Lists all projects in AWS CodeStar associated with your AWS account
list_resources Lists resources associated with a project in AWS CodeStar
list_tags_for_project Gets the tags for a project
list_team_members Lists all team members associated with a project
list_user_profiles Lists all the user profiles configured for your AWS account in AWS CodeStar
tag_project Adds tags to a project
untag_project Removes tags from a project
update_project Updates a project in AWS CodeStar
update_team_member Updates a team member's attributes in an AWS CodeStar project
update_user_profile Updates a user's profile in AWS CodeStar

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- codestar()
svc$associate_team_member(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 5, 2021, 5:19 p.m.

Related to codestar in paws...