The Spaces API from Amazon CodeCatalyst — 18 operation(s) for spaces.
openapi: 3.0.0
info:
version: '2022-09-28'
x-release: bearer
title: Amazon CodeCatalyst AccessTokens Spaces API
description: <p>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. </p> <p>Spaces, by calling the following:</p> <ul> <li> <p> <a>DeleteSpace</a>, which deletes a space.</p> </li> <li> <p> <a>GetSpace</a>, which returns information about a space.</p> </li> <li> <p> <a>GetSubscription</a>, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.</p> </li> <li> <p> <a>ListSpaces</a>, which retrieves a list of spaces.</p> </li> <li> <p> <a>UpdateSpace</a>, which hanges one or more values for a space.</p> </li> </ul> <p>Projects, by calling the following:</p> <ul> <li> <p> <a>CreateProject</a> which creates a project in a specified space.</p> </li> <li> <p> <a>GetProject</a>, which returns information about a project.</p> </li> <li> <p> <a>ListProjects</a>, which retrieves a list of projects in a space.</p> </li> </ul> <p>Users, by calling the following:</p> <ul> <li> <p> <a>GetUserDetails</a>, which returns information about a user in Amazon CodeCatalyst.</p> </li> </ul> <p>Source repositories, by calling the following:</p> <ul> <li> <p> <a>CreateSourceRepository</a>, which creates an empty Git-based source repository in a specified project.</p> </li> <li> <p> <a>CreateSourceRepositoryBranch</a>, which creates a branch in a specified repository where you can work on code.</p> </li> <li> <p> <a>DeleteSourceRepository</a>, which deletes a source repository.</p> </li> <li> <p> <a>GetSourceRepository</a>, which returns information about a source repository.</p> </li> <li> <p> <a>GetSourceRepositoryCloneUrls</a>, which returns information about the URLs that can be used with a Git client to clone a source repository.</p> </li> <li> <p> <a>ListSourceRepositories</a>, which retrieves a list of source repositories in a project.</p> </li> <li> <p> <a>ListSourceRepositoryBranches</a>, which retrieves a list of branches in a source repository.</p> </li> </ul> <p>Dev Environments and the Amazon Web Services Toolkits, by calling the following:</p> <ul> <li> <p> <a>CreateDevEnvironment</a>, which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.</p> </li> <li> <p> <a>DeleteDevEnvironment</a>, which deletes a Dev Environment.</p> </li> <li> <p> <a>GetDevEnvironment</a>, which returns information about a Dev Environment.</p> </li> <li> <p> <a>ListDevEnvironments</a>, which retrieves a list of Dev Environments in a project.</p> </li> <li> <p> <a>ListDevEnvironmentSessions</a>, which retrieves a list of active Dev Environment sessions in a project.</p> </li> <li> <p> <a>StartDevEnvironment</a>, which starts a specified Dev Environment and puts it into an active state.</p> </li> <li> <p> <a>StartDevEnvironmentSession</a>, which starts a session to a specified Dev Environment.</p> </li> <li> <p> <a>StopDevEnvironment</a>, which stops a specified Dev Environment and puts it into an stopped state.</p> </li> <li> <p> <a>StopDevEnvironmentSession</a>, which stops a session for a specified Dev Environment.</p> </li> <li> <p> <a>UpdateDevEnvironment</a>, which changes one or more values for a Dev Environment.</p> </li> </ul> <p>Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:</p> <ul> <li> <p> <a>CreateAccessToken</a>, which creates a personal access token (PAT) for the current user.</p> </li> <li> <p> <a>DeleteAccessToken</a>, which deletes a specified personal access token (PAT).</p> </li> <li> <p> <a>ListAccessTokens</a>, which lists all personal access tokens (PATs) associated with a user.</p> </li> <li> <p> <a>ListEventLogs</a>, which retrieves a list of events that occurred during a specified time period in a space.</p> </li> <li> <p> <a>VerifySession</a>, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.</p> </li> </ul> <note> <p>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 <a href="https://docs.aws.amazon.com/codecatalyst/latest/userguide/set-up-cli.html">Setting up to use the CLI with Amazon CodeCatalyst</a> and the SSO documentation for your SDK.</p> </note>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codecatalyst
x-aws-signingName: codecatalyst
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codecatalyst-2022-09-28.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codecatalyst.global.api.aws
variables: {}
description: The general Amazon CodeCatalyst multi-region endpoint
- url: https://codecatalyst.global.api.aws
variables: {}
description: The general Amazon CodeCatalyst multi-region endpoint
- url: http://codecatalyst.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon CodeCatalyst endpoint for China (Beijing) and China (Ningxia)
- url: https://codecatalyst.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon CodeCatalyst endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Spaces
paths:
/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments:
put:
operationId: CreateDevEnvironment
description: <p>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. </p> <note> <p>When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.</p> </note>
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDevEnvironmentResponse'
examples:
CreateDevEnvironment201Example:
summary: Default CreateDevEnvironment 201 response
x-microcks-default: true
value:
spaceName: example-resource
projectName: example-resource
id: '500123'
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
CreateDevEnvironment480Example:
summary: Default CreateDevEnvironment 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
CreateDevEnvironment481Example:
summary: Default CreateDevEnvironment 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
CreateDevEnvironment482Example:
summary: Default CreateDevEnvironment 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
CreateDevEnvironment483Example:
summary: Default CreateDevEnvironment 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
CreateDevEnvironment484Example:
summary: Default CreateDevEnvironment 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
CreateDevEnvironment485Example:
summary: Default CreateDevEnvironment 485 response
x-microcks-default: true
value: example-value
parameters:
- name: spaceName
in: path
required: true
description: The name of the space.
schema:
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 3
maxLength: 63
- name: projectName
in: path
required: true
description: The name of the project in the space.
schema:
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 3
maxLength: 63
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- instanceType
- persistentStorage
properties:
repositories:
description: 'The source repository that contains the branch to clone into the Dev Environment. '
type: array
items:
$ref: '#/components/schemas/RepositoryInput'
clientToken:
description: A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.
type: string
minLength: 1
maxLength: 1024
alias:
description: The user-defined alias for a Dev Environment.
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 1
maxLength: 128
ides:
description: <p>Information about the integrated development environment (IDE) configured for a Dev Environment.</p> <note> <p>An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided. </p> </note>
type: array
items:
$ref: '#/components/schemas/IdeConfiguration'
minItems: 0
maxItems: 1
instanceType:
description: 'The Amazon EC2 instace type to use for the Dev Environment. '
type: string
enum:
- dev.standard1.small
- dev.standard1.medium
- dev.standard1.large
- dev.standard1.xlarge
inactivityTimeoutMinutes:
description: The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
type: integer
minimum: 0
maximum: 1200
persistentStorage:
description: 'Information about the configuration of persistent storage for a Dev Environment. '
type: object
properties:
sizeInGiB:
allOf:
- $ref: '#/components/schemas/PersistentStorageConfigurationSizeInGiBInteger'
- description: <p>The size of the persistent storage in gigabytes (specifically GiB).</p> <note> <p>Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.</p> </note>
examples:
CreateDevEnvironmentRequestExample:
summary: Default CreateDevEnvironment request
x-microcks-default: true
value:
repositories:
- repositoryName: example-resource
branchName: example-resource
clientToken: example-value
alias: example-value
ides:
- runtime: example-value
name: example-resource
instanceType: dev.standard1.small
inactivityTimeoutMinutes: 1718153645993
persistentStorage:
sizeInGiB: example-value
summary: Amazon CodeCatalyst Create Dev Environment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Spaces
post:
operationId: ListDevEnvironments
description: Retrieves a list of Dev Environments in a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDevEnvironmentsResponse'
examples:
ListDevEnvironments200Example:
summary: Default ListDevEnvironments 200 response
x-microcks-default: true
value:
items: example-value
nextToken: example-value
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ListDevEnvironments480Example:
summary: Default ListDevEnvironments 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
ListDevEnvironments481Example:
summary: Default ListDevEnvironments 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListDevEnvironments482Example:
summary: Default ListDevEnvironments 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
ListDevEnvironments483Example:
summary: Default ListDevEnvironments 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListDevEnvironments484Example:
summary: Default ListDevEnvironments 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListDevEnvironments485Example:
summary: Default ListDevEnvironments 485 response
x-microcks-default: true
value: example-value
parameters:
- name: spaceName
in: path
required: true
description: The name of the space.
schema:
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 3
maxLength: 63
- name: projectName
in: path
required: true
description: The name of the project in the space.
schema:
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 3
maxLength: 63
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filters:
description: Information about filters to apply to narrow the results returned in the list.
type: array
items:
$ref: '#/components/schemas/Filter'
nextToken:
description: A token returned from a call to this API to indicate the next batch of results to return, if any.
type: string
minLength: 1
maxLength: 10000
maxResults:
description: The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.
type: integer
minimum: 1
maximum: 50
examples:
ListDevEnvironmentsRequestExample:
summary: Default ListDevEnvironments request
x-microcks-default: true
value:
filters:
- key: example-value
values: example-value
comparisonOperator: example-value
nextToken: example-value
maxResults: 1
summary: Amazon CodeCatalyst List Dev Environments
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Spaces
/v1/spaces/{spaceName}/projects:
put:
operationId: CreateProject
description: Creates a project in a specified space.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectResponse'
examples:
CreateProject201Example:
summary: Default CreateProject 201 response
x-microcks-default: true
value:
spaceName: example-resource
name: example-resource
displayName: example-resource
description: Example description
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
CreateProject480Example:
summary: Default CreateProject 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
CreateProject481Example:
summary: Default CreateProject 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
CreateProject482Example:
summary: Default CreateProject 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
CreateProject483Example:
summary: Default CreateProject 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
CreateProject484Example:
summary: Default CreateProject 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
CreateProject485Example:
summary: Default CreateProject 485 response
x-microcks-default: true
value: example-value
parameters:
- name: spaceName
in: path
required: true
description: The name of the space.
schema:
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 3
maxLength: 63
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- displayName
properties:
displayName:
description: The friendly name of the project that will be displayed to users.
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\. ][a-zA-Z0-9]+)*'
minLength: 3
maxLength: 63
description:
description: The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
type: string
pattern: '[a-zA-Z0-9]+(?:[-_a-zA-Z0-9.,;:/\+=?&$% ])*'
minLength: 0
maxLength: 200
examples:
CreateProjectRequestExample:
summary: Default CreateProject request
x-microcks-default: true
value:
displayName: example-resource
description: Example description
summary: Amazon CodeCatalyst Create Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Spaces
post:
operationId: ListProjects
description: Retrieves a list of projects.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListProjectsResponse'
examples:
ListProjects200Example:
summary: Default ListProjects 200 response
x-microcks-default: true
value:
nextToken: example-value
items: example-value
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ListProjects480Example:
summary: Default ListProjects 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
ListProjects481Example:
summary: Default ListProjects 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListProjects482Example:
summary: Default ListProjects 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
ListProjects483Example:
summary: Default ListProjects 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListProjects484Example:
summary: Default ListProjects 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListProjects485Example:
summary: Default ListProjects 485 response
x-microcks-default: true
value: example-value
parameters:
- name: spaceName
in: path
required: true
description: The name of the space.
schema:
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 3
maxLength: 63
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
nextToken:
description: A token returned from a call to this API to indicate the next batch of results to return, if any.
type: string
minLength: 1
maxLength: 10000
maxResults:
description: The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.
type: integer
minimum: 1
maximum: 100
filters:
description: Information about filters to apply to narrow the results returned in the list.
type: array
items:
$ref: '#/components/schemas/ProjectListFilter'
examples:
ListProjectsRequestExample:
summary: Default ListProjects request
x-microcks-default: true
value:
nextToken: example-value
maxResults: 1
filters:
- key: example-value
values: example-value
comparisonOperator: example-value
summary: Amazon CodeCatalyst List Projects
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Spaces
/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{name}:
put:
operationId: CreateSourceRepository
description: Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named <code>main</code>.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSourceRepositoryResponse'
examples:
CreateSourceRepository201Example:
summary: Default CreateSourceRepository 201 response
x-microcks-default: true
value:
spaceName: example-resource
projectName: example-resource
name: example-resource
description: Example description
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
CreateSourceRepository480Example:
summary: Default CreateSourceRepository 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
CreateSourceRepository481Example:
summary: Default CreateSourceRepository 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
CreateSourceRepository482Example:
summary: Default CreateSourceRepository 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
CreateSourceRepository483Example:
summary: Default CreateSourceRepository 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
# --- truncated at 32 KB (184 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codecatalyst/refs/heads/main/openapi/amazon-codecatalyst-spaces-api-openapi.yml