paws (version 0.6.0)

codestar: AWS CodeStar

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:

• delete_project, which deletes a project.

• describe_project, which lists the attributes of a project.

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

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

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

• tag_project, which adds tags to a project.

• untag_project, which removes tags from a project.

• update_project, which updates the attributes of a project.

Teams and team members, by calling the following:

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

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

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

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

Users, by calling the following:

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

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

• describe_user_profile, which describes the profile of a user.

• list_user_profiles, which lists all user profiles.

• update_user_profile, which updates the profile for a user.

Usage

codestar(config = list(), credentials = list(), endpoint = NULL, region = NULL)

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.

Arguments

config

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

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Service syntax

svc <- codestar(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  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

if (FALSE) {
svc <- codestar()
svc$associate_team_member(
  Foo = 123
)
}