Client

codecatalyst

R Documentation

Amazon CodeCatalyst¶

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:

delete_space, which deletes a space.
get_space, which returns information about a space.
get_subscription, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
list_spaces, which retrieves a list of spaces.
update_space, which changes one or more values for a space.

Projects, by calling the following:

create_project which creates a project in a specified space.
get_project, which returns information about a project.
list_projects, which retrieves a list of projects in a space.

Users, by calling the following:

get_user_details, which returns information about a user in Amazon CodeCatalyst.

Source repositories, by calling the following:

create_source_repository, which creates an empty Git-based source repository in a specified project.
create_source_repository_branch, which creates a branch in a specified repository where you can work on code.
delete_source_repository, which deletes a source repository.
get_source_repository, which returns information about a source repository.
get_source_repository_clone_urls, which returns information about the URLs that can be used with a Git client to clone a source repository.
list_source_repositories, which retrieves a list of source repositories in a project.
list_source_repository_branches, which retrieves a list of branches in a source repository.

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

create_dev_environment, which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.
delete_dev_environment, which deletes a Dev Environment.
get_dev_environment, which returns information about a Dev Environment.
list_dev_environments, which retrieves a list of Dev Environments in a project.
list_dev_environment_sessions, which retrieves a list of active Dev Environment sessions in a project.
start_dev_environment, which starts a specified Dev Environment and puts it into an active state.
start_dev_environment_session, which starts a session to a specified Dev Environment.
stop_dev_environment, which stops a specified Dev Environment and puts it into an stopped state.
stop_dev_environment_session, which stops a session for a specified Dev Environment.
update_dev_environment, which changes one or more values for a Dev Environment.

Workflows, by calling the following:

get_workflow, which returns information about a workflow.
get_workflow_run, which returns information about a specified run of a workflow.
list_workflow_runs, which retrieves a list of runs of a specified workflow.
list_workflows, which retrieves a list of workflows in a specified project.
start_workflow_run, which starts a run of a specified workflow.

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

create_access_token, which creates a personal access token (PAT) for the current user.
delete_access_token, which deletes a specified personal access token (PAT).
list_access_tokens, which lists all personal access tokens (PATs) associated with a user.
list_event_logs, which retrieves a list of events that occurred during a specified time period in a space.
verify_session, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

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.

Usage¶

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

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.

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¶

svc <- codecatalyst(
  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¶

create_access_token: Creates a personal access token (PAT) for the current user
create_dev_environment: 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
create_project: Creates a project in a specified space
create_source_repository: Creates an empty Git-based source repository in a specified project
create_source_repository_branch: Creates a branch in a specified source repository in Amazon CodeCatalyst
delete_access_token: Deletes a specified personal access token (PAT)
delete_dev_environment: Deletes a Dev Environment
delete_project: Deletes a project in a space
delete_source_repository: Deletes a source repository in Amazon CodeCatalyst
delete_space: Deletes a space
get_dev_environment: Returns information about a Dev Environment for a source repository in a project
get_project: Returns information about a project
get_source_repository: Returns information about a source repository
get_source_repository_clone_urls: Returns information about the URLs that can be used with a Git client to clone a source repository
get_space: Returns information about an space
get_subscription: Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space
get_user_details: Returns information about a user
get_workflow: Returns information about a workflow
get_workflow_run: Returns information about a specified run of a workflow
list_access_tokens: Lists all personal access tokens (PATs) associated with the user who calls the API
list_dev_environments: Retrieves a list of Dev Environments in a project
list_dev_environment_sessions: Retrieves a list of active sessions for a Dev Environment in a project
list_event_logs: Retrieves a list of events that occurred during a specific time in a space
list_projects: Retrieves a list of projects
list_source_repositories: Retrieves a list of source repositories in a project
list_source_repository_branches: Retrieves a list of branches in a specified source repository
list_spaces: Retrieves a list of spaces
list_workflow_runs: Retrieves a list of workflow runs of a specified workflow
list_workflows: Retrieves a list of workflows in a specified project
start_dev_environment: Starts a specified Dev Environment and puts it into an active state
start_dev_environment_session: Starts a session for a specified Dev Environment
start_workflow_run: Begins a run of a specified workflow
stop_dev_environment: Pauses a specified Dev Environment and places it in a non-running state
stop_dev_environment_session: Stops a session for a specified Dev Environment
update_dev_environment: Changes one or more values for a Dev Environment
update_project: Changes one or more values for a project
update_space: Changes one or more values for a space
verify_session: Verifies whether the calling user has a valid Amazon CodeCatalyst login and session

Examples¶

## Not run: 
svc <- codecatalyst()
svc$create_access_token(
  Foo = 123
)

## End(Not run)