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:
DeleteSpace, which deletes a space.
GetSpace, which returns information about a space.
GetSubscription, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
ListSpaces, which retrieves a list of spaces.
UpdateSpace, which hanges one or more values for a space.
Projects, by calling the following:
CreateProject which creates a project in a specified space.
GetProject, which returns information about a project.
ListProjects, which retrieves a list of projects in a space.
Users, by calling the following:
GetUserDetails, which returns information about a user in Amazon CodeCatalyst.
Source repositories, by calling the following:
CreateSourceRepository, which creates an empty Git-based source repository in a specified project.
CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.
DeleteSourceRepository, which deletes a source repository.
GetSourceRepository, which returns information about a source repository.
GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source repository.
ListSourceRepositories, which retrieves a list of source repositories in a project.
ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.
Dev Environments and the Amazon Web Services Toolkits, by calling the following:
CreateDevEnvironment, which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.
DeleteDevEnvironment, which deletes a Dev Environment.
GetDevEnvironment, which returns information about a Dev Environment.
ListDevEnvironments, which retrieves a list of Dev Environments in a project.
ListDevEnvironmentSessions, which retrieves a list of active Dev Environment sessions in a project.
StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.
StartDevEnvironmentSession, which starts a session to a specified Dev Environment.
StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.
StopDevEnvironmentSession, which stops a session for a specified Dev Environment.
UpdateDevEnvironment, which changes one or more values for a Dev Environment.
Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:
CreateAccessToken, which creates a personal access token (PAT) for the current user.
DeleteAccessToken, which deletes a specified personal access token (PAT).
ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.
ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.
VerifySession, 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.
NextToken
element, which you can use to obtain additional results.'
type: integer
maximum: 10
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
examples:
ListAccessTokensRequestExample:
summary: Default ListAccessTokens request
x-microcks-default: true
value:
maxResults: 1
nextToken: example-value
summary: Amazon CodeCatalyst List Access Tokens
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments':
put:
operationId: CreateDevEnvironment
description: '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.
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.
Information about the integrated development environment (IDE) configured for a Dev Environment.
An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.
The size of the persistent storage in gigabytes (specifically GiB).
Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
NextToken
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
'/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
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 NextToken
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
'/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 main.
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
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
CreateSourceRepository484Example:
summary: Default CreateSourceRepository 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
CreateSourceRepository485Example:
summary: Default CreateSourceRepository 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: name
in: path
required: true
description: 'The name of the source repository. For more information about name requirements, see Quotas for
source repositories.'
schema:
type: string
pattern: '(?!.*[.]git$)[\w\-.]*'
minLength: 1
maxLength: 100
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
description: The description of the source repository.
type: string
minLength: 1
maxLength: 255
examples:
CreateSourceRepositoryRequestExample:
summary: Default CreateSourceRepository request
x-microcks-default: true
value:
description: Example description
summary: Amazon CodeCatalyst Create Source Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: DeleteSourceRepository
description: Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSourceRepositoryResponse'
examples:
DeleteSourceRepository200Example:
summary: Default DeleteSourceRepository 200 response
x-microcks-default: true
value:
spaceName: example-resource
projectName: example-resource
name: example-resource
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DeleteSourceRepository480Example:
summary: Default DeleteSourceRepository 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
DeleteSourceRepository481Example:
summary: Default DeleteSourceRepository 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DeleteSourceRepository482Example:
summary: Default DeleteSourceRepository 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
DeleteSourceRepository483Example:
summary: Default DeleteSourceRepository 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DeleteSourceRepository484Example:
summary: Default DeleteSourceRepository 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DeleteSourceRepository485Example:
summary: Default DeleteSourceRepository 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: name
in: path
required: true
description: The name of the source repository.
schema:
type: string
pattern: '(?!.*[.]git$)[\w\-.]*'
minLength: 1
maxLength: 100
summary: Amazon CodeCatalyst Delete Source Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: GetSourceRepository
description: Returns information about a source repository.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSourceRepositoryResponse'
examples:
GetSourceRepository200Example:
summary: Default GetSourceRepository 200 response
x-microcks-default: true
value:
spaceName: example-resource
projectName: example-resource
name: example-resource
description: Example description
lastUpdatedTime: example-value
createdTime: example-value
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
GetSourceRepository480Example:
summary: Default GetSourceRepository 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
GetSourceRepository481Example:
summary: Default GetSourceRepository 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
GetSourceRepository482Example:
summary: Default GetSourceRepository 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
GetSourceRepository483Example:
summary: Default GetSourceRepository 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
GetSourceRepository484Example:
summary: Default GetSourceRepository 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
GetSourceRepository485Example:
summary: Default GetSourceRepository 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: name
in: path
required: true
description: The name of the source repository.
schema:
type: string
pattern: '(?!.*[.]git$)[\w\-.]*'
minLength: 1
maxLength: 100
summary: Amazon CodeCatalyst Get Source Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{sourceRepositoryName}/branches/{name}':
put:
operationId: CreateSourceRepositoryBranch
description: Creates a branch in a specified source repository in Amazon CodeCatalyst.
This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.
The Amazon EC2 instace type to use for the Dev Environment.
Changing this value will cause a restart of the Dev Environment if it is running.
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.
Changing this value will cause a restart of the Dev Environment if it is running.
Deletes a space.
Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.
NextToken
element, which you can use to obtain additional results.'
type: integer
minimum: 1
maximum: 200
examples:
ListDevEnvironmentSessionsRequestExample:
summary: Default ListDevEnvironmentSessions request
x-microcks-default: true
value:
nextToken: example-value
maxResults: 1
summary: Amazon CodeCatalyst List Dev Environment Sessions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/v1/spaces/{spaceName}/eventLogs':
post:
operationId: ListEventLogs
description: Retrieves a list of events that occurred during a specified time period in a space. You can use these events to audit user and system activity in a space.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEventLogsResponse'
examples:
ListEventLogs200Example:
summary: Default ListEventLogs 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:
ListEventLogs480Example:
summary: Default ListEventLogs 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
ListEventLogs481Example:
summary: Default ListEventLogs 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListEventLogs482Example:
summary: Default ListEventLogs 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
ListEventLogs483Example:
summary: Default ListEventLogs 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListEventLogs484Example:
summary: Default ListEventLogs 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListEventLogs485Example:
summary: Default ListEventLogs 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
required:
- startTime
- endTime
properties:
startTime:
description: 'The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
type: string
format: date-time
endTime:
description: 'The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
type: string
format: date-time
eventName:
description: The name of the event.
type: string
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 NextToken
element, which you can use to obtain additional results.'
type: integer
minimum: 1
maximum: 250
examples:
ListEventLogsRequestExample:
summary: Default ListEventLogs request
x-microcks-default: true
value:
startTime: example-value
endTime: example-value
eventName: example-resource
nextToken: example-value
maxResults: 1
summary: Amazon CodeCatalyst List Event Logs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories':
post:
operationId: ListSourceRepositories
description: Retrieves a list of source repositories in a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSourceRepositoriesResponse'
examples:
ListSourceRepositories200Example:
summary: Default ListSourceRepositories 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:
ListSourceRepositories480Example:
summary: Default ListSourceRepositories 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
ListSourceRepositories481Example:
summary: Default ListSourceRepositories 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListSourceRepositories482Example:
summary: Default ListSourceRepositories 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
ListSourceRepositories483Example:
summary: Default ListSourceRepositories 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListSourceRepositories484Example:
summary: Default ListSourceRepositories 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListSourceRepositories485Example:
summary: Default ListSourceRepositories 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:
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 NextToken
element, which you can use to obtain additional results.'
type: integer
minimum: 1
maximum: 200
examples:
ListSourceRepositoriesRequestExample:
summary: Default ListSourceRepositories request
x-microcks-default: true
value:
nextToken: example-value
maxResults: 1
summary: Amazon CodeCatalyst List Source Repositories
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{sourceRepositoryName}/branches':
post:
operationId: ListSourceRepositoryBranches
description: Retrieves a list of branches in a specified source repository.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSourceRepositoryBranchesResponse'
examples:
ListSourceRepositoryBranches200Example:
summary: Default ListSourceRepositoryBranches 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:
ListSourceRepositoryBranches480Example:
summary: Default ListSourceRepositoryBranches 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
ListSourceRepositoryBranches481Example:
summary: Default ListSourceRepositoryBranches 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListSourceRepositoryBranches482Example:
summary: Default ListSourceRepositoryBranches 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
ListSourceRepositoryBranches483Example:
summary: Default ListSourceRepositoryBranches 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListSourceRepositoryBranches484Example:
summary: Default ListSourceRepositoryBranches 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListSourceRepositoryBranches485Example:
summary: Default ListSourceRepositoryBranches 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: sourceRepositoryName
in: path
required: true
description: The name of the source repository.
schema:
type: string
pattern: '(?!.*[.]git$)[\w\-.]*'
minLength: 1
maxLength: 100
- 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 NextToken
element, which you can use to obtain additional results.'
type: integer
minimum: 1
maximum: 50
examples:
ListSourceRepositoryBranchesRequestExample:
summary: Default ListSourceRepositoryBranches request
x-microcks-default: true
value:
nextToken: example-value
maxResults: 1
summary: Amazon CodeCatalyst List Source Repository Branches
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/v1/spaces:
post:
operationId: ListSpaces
description: Retrieves a list of spaces.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSpacesResponse'
examples:
ListSpaces200Example:
summary: Default ListSpaces 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:
ListSpaces480Example:
summary: Default ListSpaces 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
ListSpaces481Example:
summary: Default ListSpaces 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListSpaces482Example:
summary: Default ListSpaces 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
ListSpaces483Example:
summary: Default ListSpaces 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListSpaces484Example:
summary: Default ListSpaces 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListSpaces485Example:
summary: Default ListSpaces 485 response
x-microcks-default: true
value: example-value
parameters:
- 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
examples:
ListSpacesRequestExample:
summary: Default ListSpaces request
x-microcks-default: true
value:
nextToken: example-value
summary: Amazon CodeCatalyst List Spaces
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/start':
put:
operationId: StartDevEnvironment
description: 'Starts a specified Dev Environment and puts it into an active state. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartDevEnvironmentResponse'
examples:
StartDevEnvironment200Example:
summary: Default StartDevEnvironment 200 response
x-microcks-default: true
value:
spaceName: example-resource
projectName: example-resource
id: '500123'
status: ACTIVE
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
StartDevEnvironment480Example:
summary: Default StartDevEnvironment 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StartDevEnvironment481Example:
summary: Default StartDevEnvironment 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StartDevEnvironment482Example:
summary: Default StartDevEnvironment 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
StartDevEnvironment483Example:
summary: Default StartDevEnvironment 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StartDevEnvironment484Example:
summary: Default StartDevEnvironment 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StartDevEnvironment485Example:
summary: Default StartDevEnvironment 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: id
in: path
required: true
description: 'The system-generated unique ID of the Dev Environment. '
schema:
type: string
pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ides:
description: 'Information about the integrated development environment (IDE) configured for a Dev Environment. '
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
examples:
StartDevEnvironmentRequestExample:
summary: Default StartDevEnvironment request
x-microcks-default: true
value:
ides:
- runtime: example-value
name: example-resource
instanceType: dev.standard1.small
inactivityTimeoutMinutes: 1718153645993
summary: Amazon CodeCatalyst Start Dev Environment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session':
put:
operationId: StartDevEnvironmentSession
description: Starts a session for a specified Dev Environment.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartDevEnvironmentSessionResponse'
examples:
StartDevEnvironmentSession200Example:
summary: Default StartDevEnvironmentSession 200 response
x-microcks-default: true
value:
accessDetails:
streamUrl: https://example.amazonaws.com
tokenValue: example-value
sessionId: '500123'
spaceName: example-resource
projectName: example-resource
id: '500123'
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
StartDevEnvironmentSession480Example:
summary: Default StartDevEnvironmentSession 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StartDevEnvironmentSession481Example:
summary: Default StartDevEnvironmentSession 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StartDevEnvironmentSession482Example:
summary: Default StartDevEnvironmentSession 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
StartDevEnvironmentSession483Example:
summary: Default StartDevEnvironmentSession 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StartDevEnvironmentSession484Example:
summary: Default StartDevEnvironmentSession 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StartDevEnvironmentSession485Example:
summary: Default StartDevEnvironmentSession 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: id
in: path
required: true
description: The system-generated unique ID of the Dev Environment.
schema:
type: string
pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sessionConfiguration
properties:
sessionConfiguration:
description: Information about the configuration of a Dev Environment session.
type: object
properties:
sessionType:
allOf:
- $ref: '#/components/schemas/DevEnvironmentSessionType'
- description: The type of the session.
executeCommandSessionConfiguration:
allOf:
- $ref: '#/components/schemas/ExecuteCommandSessionConfiguration'
- description: Information about optional commands that will be run on the Dev Environment when the SSH session begins.
examples:
StartDevEnvironmentSessionRequestExample:
summary: Default StartDevEnvironmentSession request
x-microcks-default: true
value:
sessionConfiguration:
sessionType: STANDARD
executeCommandSessionConfiguration: example-value
summary: Amazon CodeCatalyst Start Dev Environment Session
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/stop':
put:
operationId: StopDevEnvironment
description: Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopDevEnvironmentResponse'
examples:
StopDevEnvironment200Example:
summary: Default StopDevEnvironment 200 response
x-microcks-default: true
value:
spaceName: example-resource
projectName: example-resource
id: '500123'
status: ACTIVE
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
StopDevEnvironment480Example:
summary: Default StopDevEnvironment 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StopDevEnvironment481Example:
summary: Default StopDevEnvironment 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StopDevEnvironment482Example:
summary: Default StopDevEnvironment 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
StopDevEnvironment483Example:
summary: Default StopDevEnvironment 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StopDevEnvironment484Example:
summary: Default StopDevEnvironment 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StopDevEnvironment485Example:
summary: Default StopDevEnvironment 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: id
in: path
required: true
description: 'The system-generated unique ID of the Dev Environment. '
schema:
type: string
pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
summary: Amazon CodeCatalyst Stop Dev Environment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session/{sessionId}':
delete:
operationId: StopDevEnvironmentSession
description: Stops a session for a specified Dev Environment.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopDevEnvironmentSessionResponse'
examples:
StopDevEnvironmentSession200Example:
summary: Default StopDevEnvironmentSession 200 response
x-microcks-default: true
value:
spaceName: example-resource
projectName: example-resource
id: '500123'
sessionId: '500123'
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
StopDevEnvironmentSession480Example:
summary: Default StopDevEnvironmentSession 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StopDevEnvironmentSession481Example:
summary: Default StopDevEnvironmentSession 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StopDevEnvironmentSession482Example:
summary: Default StopDevEnvironmentSession 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
StopDevEnvironmentSession483Example:
summary: Default StopDevEnvironmentSession 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StopDevEnvironmentSession484Example:
summary: Default StopDevEnvironmentSession 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StopDevEnvironmentSession485Example:
summary: Default StopDevEnvironmentSession 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: id
in: path
required: true
description: 'The system-generated unique ID of the Dev Environment. To obtain this ID, use ListDevEnvironments.'
schema:
type: string
pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
- name: sessionId
in: path
required: true
description: The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.
schema:
type: string
minLength: 1
maxLength: 96
summary: Amazon CodeCatalyst Stop Dev Environment Session
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/session:
get:
operationId: VerifySession
description: 'Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/VerifySessionResponse'
examples:
VerifySession200Example:
summary: Default VerifySession 200 response
x-microcks-default: true
value:
identity: '500123'
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
VerifySession480Example:
summary: Default VerifySession 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
VerifySession481Example:
summary: Default VerifySession 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
VerifySession482Example:
summary: Default VerifySession 482 response
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
VerifySession483Example:
summary: Default VerifySession 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
VerifySession484Example:
summary: Default VerifySession 484 response
x-microcks-default: true
value: example-value
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
VerifySession485Example:
summary: Default VerifySession 485 response
x-microcks-default: true
value: example-value
summary: Amazon CodeCatalyst Verify Session
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
parameters: {}
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
schemas:
CreateAccessTokenResponse:
type: object
required:
- secret
- name
- expiresTime
- accessTokenId
properties:
secret:
allOf:
- $ref: '#/components/schemas/AccessTokenSecret'
- description: The secret value of the personal access token.
name:
allOf:
- $ref: '#/components/schemas/AccessTokenName'
- description: The friendly name of the personal access token.
expiresTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: 'The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC
3339. If not specified, the default is one year from creation.'
accessTokenId:
allOf:
- $ref: '#/components/schemas/AccessTokenId'
- description: The system-generated unique ID of the access token.
ThrottlingException: {}
ConflictException: {}
ValidationException: {}
ServiceQuotaExceededException: {}
ResourceNotFoundException: {}
AccessDeniedException: {}
CreateDevEnvironmentResponse:
type: object
required:
- spaceName
- projectName
- id
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
id:
allOf:
- $ref: '#/components/schemas/Uuid'
- description: 'The system-generated unique ID of the Dev Environment. '
RepositoryInput:
type: object
required:
- repositoryName
properties:
repositoryName:
allOf:
- $ref: '#/components/schemas/SourceRepositoryNameString'
- description: The name of the source repository.
branchName:
allOf:
- $ref: '#/components/schemas/SourceRepositoryBranchString'
- description: The name of the branch in a source repository.
description: Information about a repository that will be cloned to a Dev Environment.
IdeConfiguration:
type: object
properties:
runtime:
allOf:
- $ref: '#/components/schemas/IdeConfigurationRuntimeString'
- description: A link to the IDE runtime image.
This parameter is not required for VSCode.
Cloud9, IntelliJ, PyCharm, GoLand, and VSCode.'
description: Information about the configuration of an integrated development environment (IDE) for a Dev Environment.
PersistentStorageConfigurationSizeInGiBInteger:
type: integer
minimum: 0
maximum: 64
CreateProjectResponse:
type: object
required:
- name
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name of the project.
description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the project.
CreateSourceRepositoryResponse:
type: object
required:
- spaceName
- projectName
- name
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
name:
allOf:
- $ref: '#/components/schemas/SourceRepositoryNameString'
- description: The name of the source repository.
description:
allOf:
- $ref: '#/components/schemas/SourceRepositoryDescriptionString'
- description: The description of the source repository.
CreateSourceRepositoryBranchResponse:
type: object
properties:
ref:
allOf:
- $ref: '#/components/schemas/SourceRepositoryBranchRefString'
- description: The Git reference name of the branch.
name:
allOf:
- $ref: '#/components/schemas/SourceRepositoryBranchString'
- description: The name of the newly created branch.
lastUpdatedTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: 'The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.'
headCommitId:
allOf:
- $ref: '#/components/schemas/String'
- description: The commit ID of the tip of the newly created branch.
DeleteAccessTokenResponse:
type: object
properties: {}
DeleteDevEnvironmentResponse:
type: object
required:
- spaceName
- projectName
- id
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
id:
allOf:
- $ref: '#/components/schemas/Uuid'
- description: 'The system-generated unique ID of the deleted Dev Environment. '
DeleteProjectResponse:
type: object
required:
- spaceName
- name
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name displayed to users of the project in Amazon CodeCatalyst.
DeleteSourceRepositoryResponse:
type: object
required:
- spaceName
- projectName
- name
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
name:
allOf:
- $ref: '#/components/schemas/SourceRepositoryNameString'
- description: The name of the repository.
DeleteSpaceResponse:
type: object
required:
- name
properties:
name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name of the space displayed to users of the space in Amazon CodeCatalyst.
GetDevEnvironmentResponse:
type: object
required:
- spaceName
- projectName
- id
- lastUpdatedTime
- creatorId
- status
- repositories
- instanceType
- inactivityTimeoutMinutes
- persistentStorage
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
id:
allOf:
- $ref: '#/components/schemas/Uuid'
- description: 'The system-generated unique ID of the Dev Environment. '
lastUpdatedTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: 'The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
creatorId:
allOf:
- $ref: '#/components/schemas/GetDevEnvironmentResponseCreatorIdString'
- description: 'The system-generated unique ID of the user who created the Dev Environment. '
status:
allOf:
- $ref: '#/components/schemas/DevEnvironmentStatus'
- description: The current status of the Dev Environment.
statusReason:
allOf:
- $ref: '#/components/schemas/StatusReason'
- description: The reason for the status.
repositories:
allOf:
- $ref: '#/components/schemas/DevEnvironmentRepositorySummaries'
- description: 'The source repository that contains the branch cloned into the Dev Environment. '
alias:
allOf:
- $ref: '#/components/schemas/GetDevEnvironmentResponseAliasString'
- description: 'The user-specified alias for the Dev Environment. '
ides:
allOf:
- $ref: '#/components/schemas/Ides'
- description: 'Information about the integrated development environment (IDE) configured for the Dev Environment. '
instanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- description: 'The Amazon EC2 instace type to use for the Dev Environment. '
inactivityTimeoutMinutes:
allOf:
- $ref: '#/components/schemas/InactivityTimeoutMinutes'
- description: 'The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.'
persistentStorage:
allOf:
- $ref: '#/components/schemas/PersistentStorage'
- description: 'Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.'
GetProjectResponse:
type: object
required:
- name
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the project in the space.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name of the project displayed to users in Amazon CodeCatalyst.
description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the project.
GetSourceRepositoryResponse:
type: object
required:
- spaceName
- projectName
- name
- lastUpdatedTime
- createdTime
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
name:
allOf:
- $ref: '#/components/schemas/SourceRepositoryNameString'
- description: The name of the source repository.
description:
allOf:
- $ref: '#/components/schemas/SourceRepositoryDescriptionString'
- description: The description of the source repository.
lastUpdatedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
createdTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
GetSourceRepositoryCloneUrlsResponse:
type: object
required:
- https
properties:
https:
allOf:
- $ref: '#/components/schemas/String'
- description: The HTTPS URL to use when cloning the source repository.
GetSpaceResponse:
type: object
required:
- name
- regionName
properties:
name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
regionName:
allOf:
- $ref: '#/components/schemas/RegionString'
- description: The Amazon Web Services Region where the space exists.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name of the space displayed to users.
description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the space.
GetSubscriptionResponse:
type: object
properties:
subscriptionType:
allOf:
- $ref: '#/components/schemas/String'
- description: The type of the billing plan for the space.
awsAccountName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The display name of the Amazon Web Services account used for billing for the space.
GetUserDetailsResponse:
type: object
properties:
userId:
allOf:
- $ref: '#/components/schemas/String'
- description: The system-generated unique ID of the user.
userName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the user as displayed in Amazon CodeCatalyst.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name displayed for the user in Amazon CodeCatalyst.
primaryEmail:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: The email address provided by the user when they signed up.
version:
allOf:
- $ref: '#/components/schemas/String'
- description:
ListAccessTokensResponse:
type: object
required:
- items
properties:
items:
allOf:
- $ref: '#/components/schemas/AccessTokenSummaries'
- description: A list of personal access tokens (PATs) associated with the calling user identity.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
ListDevEnvironmentSessionsResponse:
type: object
required:
- items
properties:
items:
allOf:
- $ref: '#/components/schemas/DevEnvironmentSessionsSummaryList'
- description: Information about each session retrieved in the list.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
ListDevEnvironmentsResponse:
type: object
required:
- items
properties:
items:
allOf:
- $ref: '#/components/schemas/DevEnvironmentSummaryList'
- description: Information about the Dev Environments in a project.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
Filter:
type: object
required:
- key
- values
properties:
key:
allOf:
- $ref: '#/components/schemas/String'
- description: A key that can be used to sort results.
values:
allOf:
- $ref: '#/components/schemas/StringList'
- description: The values of the key.
comparisonOperator:
allOf:
- $ref: '#/components/schemas/String'
- description: The operator used to compare the fields.
description: Information about a filter used to limit results of a query.
ListEventLogsResponse:
type: object
required:
- items
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
items:
allOf:
- $ref: '#/components/schemas/EventLogEntries'
- description: Information about each event retrieved in the list.
ListProjectsResponse:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
items:
allOf:
- $ref: '#/components/schemas/ProjectSummaries'
- description: Information about the projects.
ProjectListFilter:
type: object
required:
- key
- values
properties:
key:
allOf:
- $ref: '#/components/schemas/FilterKey'
- description: A key that can be used to sort results.
values:
allOf:
- $ref: '#/components/schemas/StringList'
- description: The values of the key.
comparisonOperator:
allOf:
- $ref: '#/components/schemas/ComparisonOperator'
- description: The operator used to compare the fields.
description: nformation about the filter used to narrow the results returned in a list of projects.
ListSourceRepositoriesResponse:
type: object
properties:
items:
allOf:
- $ref: '#/components/schemas/ListSourceRepositoriesItems'
- description: Information about the source repositories.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
ListSourceRepositoryBranchesResponse:
type: object
required:
- items
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
items:
allOf:
- $ref: '#/components/schemas/ListSourceRepositoryBranchesItems'
- description: Information about the source branches.
ListSpacesResponse:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
items:
allOf:
- $ref: '#/components/schemas/SpaceSummaries'
- description: 'Information about the spaces. '
StartDevEnvironmentResponse:
type: object
required:
- spaceName
- projectName
- id
- status
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
id:
allOf:
- $ref: '#/components/schemas/Uuid'
- description: 'The system-generated unique ID of the Dev Environment. '
status:
allOf:
- $ref: '#/components/schemas/DevEnvironmentStatus'
- description: 'The status of the Dev Environment. '
StartDevEnvironmentSessionResponse:
type: object
required:
- accessDetails
- spaceName
- projectName
- id
properties:
accessDetails:
$ref: '#/components/schemas/DevEnvironmentAccessDetails'
sessionId:
allOf:
- $ref: '#/components/schemas/StartDevEnvironmentSessionResponseSessionIdString'
- description: The system-generated unique ID of the Dev Environment session.
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
id:
allOf:
- $ref: '#/components/schemas/Uuid'
- description: The system-generated unique ID of the Dev Environment.
DevEnvironmentSessionType:
type: string
enum:
- SSM
- SSH
ExecuteCommandSessionConfiguration:
type: object
required:
- command
properties:
command:
allOf:
- $ref: '#/components/schemas/ExecuteCommandSessionConfigurationCommandString'
- description: The command used at the beginning of the SSH session to a Dev Environment.
arguments:
allOf:
- $ref: '#/components/schemas/ExecuteCommandSessionConfigurationArguments'
- description: An array of arguments containing arguments and members.
description: Information about the commands that will be run on a Dev Environment when an SSH session begins.
StopDevEnvironmentResponse:
type: object
required:
- spaceName
- projectName
- id
- status
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
id:
allOf:
- $ref: '#/components/schemas/Uuid'
- description: 'The system-generated unique ID of the Dev Environment. '
status:
allOf:
- $ref: '#/components/schemas/DevEnvironmentStatus'
- description: 'The status of the Dev Environment. '
StopDevEnvironmentSessionResponse:
type: object
required:
- spaceName
- projectName
- id
- sessionId
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
id:
allOf:
- $ref: '#/components/schemas/Uuid'
- description: The system-generated unique ID of the Dev Environment.
sessionId:
allOf:
- $ref: '#/components/schemas/StopDevEnvironmentSessionResponseSessionIdString'
- description: The system-generated unique ID of the Dev Environment session.
UpdateDevEnvironmentResponse:
type: object
required:
- id
- spaceName
- projectName
properties:
id:
allOf:
- $ref: '#/components/schemas/Uuid'
- description: 'The system-generated unique ID of the Dev Environment. '
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
projectName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project in the space.
alias:
allOf:
- $ref: '#/components/schemas/UpdateDevEnvironmentResponseAliasString'
- description: The user-specified alias for the Dev Environment.
ides:
allOf:
- $ref: '#/components/schemas/IdeConfigurationList'
- description: Information about the integrated development environment (IDE) configured for the Dev Environment.
instanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- description: 'The Amazon EC2 instace type to use for the Dev Environment. '
inactivityTimeoutMinutes:
allOf:
- $ref: '#/components/schemas/InactivityTimeoutMinutes'
- description: 'The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. '
clientToken:
allOf:
- $ref: '#/components/schemas/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.'
UpdateProjectResponse:
type: object
properties:
spaceName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the project.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name of the project displayed to users in Amazon CodeCatalyst.
description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the project.
UpdateSpaceResponse:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name of the space displayed to users in Amazon CodeCatalyst.
description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the space.
VerifySessionResponse:
type: object
properties:
identity:
allOf:
- $ref: '#/components/schemas/VerifySessionResponseIdentityString'
- description: The system-generated unique ID of the user in Amazon CodeCatalyst.
AccessTokenId:
type: string
minLength: 1
maxLength: 36
AccessTokenName:
type: string
minLength: 1
maxLength: 100
AccessTokenSecret:
type: string
minLength: 1
maxLength: 4000
format: password
AccessTokenSummary:
type: object
required:
- id
- name
properties:
id:
allOf:
- $ref: '#/components/schemas/AccessTokenId'
- description: The system-generated ID of the personal access token.
name:
allOf:
- $ref: '#/components/schemas/AccessTokenName'
- description: The friendly name of the personal access token.
expiresTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: 'The date and time when the personal access token will expire, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
description: Information about a specified personal access token (PAT).
AccessTokenSummaries:
type: array
items:
$ref: '#/components/schemas/AccessTokenSummary'
SyntheticTimestamp_date_time:
type: string
format: date-time
Boolean:
type: boolean
ClientToken:
type: string
minLength: 1
maxLength: 1024
ComparisonOperator:
type: string
enum:
- EQ
- GT
- GE
- LT
- LE
CreateAccessTokenRequest:
type: object
required:
- name
title: CreateAccessTokenRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/AccessTokenName'
- description: The friendly name of the personal access token.
expiresTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: 'The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
NameString:
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 3
maxLength: 63
RepositoriesInput:
type: array
items:
$ref: '#/components/schemas/RepositoryInput'
CreateDevEnvironmentRequestAliasString:
type: string
pattern: '[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 1
maxLength: 128
IdeConfigurationList:
type: array
items:
$ref: '#/components/schemas/IdeConfiguration'
minItems: 0
maxItems: 1
InstanceType:
type: string
enum:
- dev.standard1.small
- dev.standard1.medium
- dev.standard1.large
- dev.standard1.xlarge
InactivityTimeoutMinutes:
type: integer
minimum: 0
maximum: 1200
PersistentStorageConfiguration:
type: object
required:
- sizeInGiB
properties:
sizeInGiB:
allOf:
- $ref: '#/components/schemas/PersistentStorageConfigurationSizeInGiBInteger'
- description: 'The size of the persistent storage in gigabytes (specifically GiB).
Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
Information about the integrated development environment (IDE) configured for a Dev Environment.
An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.
Information about the amount of storage allocated to the Dev Environment.
By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
The size of the persistent storage in gigabytes (specifically GiB).
Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
NextToken
element, which you can use to obtain additional results.'
nextToken:
allOf:
- $ref: '#/components/schemas/ListAccessTokensRequestNextTokenString'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
ListDevEnvironmentSessionsRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListDevEnvironmentSessionsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 200
ListDevEnvironmentSessionsRequest:
type: object
title: ListDevEnvironmentSessionsRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/ListDevEnvironmentSessionsRequestNextTokenString'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
maxResults:
allOf:
- $ref: '#/components/schemas/ListDevEnvironmentSessionsRequestMaxResultsInteger'
- 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 NextToken
element, which you can use to obtain additional results.'
ListDevEnvironmentsRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListDevEnvironmentsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 50
ListDevEnvironmentsRequest:
type: object
title: ListDevEnvironmentsRequest
properties:
filters:
allOf:
- $ref: '#/components/schemas/Filters'
- description: Information about filters to apply to narrow the results returned in the list.
nextToken:
allOf:
- $ref: '#/components/schemas/ListDevEnvironmentsRequestNextTokenString'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
maxResults:
allOf:
- $ref: '#/components/schemas/ListDevEnvironmentsRequestMaxResultsInteger'
- 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 NextToken
element, which you can use to obtain additional results.'
ListEventLogsRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListEventLogsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 250
ListEventLogsRequest:
type: object
required:
- startTime
- endTime
title: ListEventLogsRequest
properties:
startTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: 'The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
endTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: 'The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
eventName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the event.
nextToken:
allOf:
- $ref: '#/components/schemas/ListEventLogsRequestNextTokenString'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
maxResults:
allOf:
- $ref: '#/components/schemas/ListEventLogsRequestMaxResultsInteger'
- 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 NextToken
element, which you can use to obtain additional results.'
ListProjectsRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListProjectsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ProjectListFilters:
type: array
items:
$ref: '#/components/schemas/ProjectListFilter'
ListProjectsRequest:
type: object
title: ListProjectsRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/ListProjectsRequestNextTokenString'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
maxResults:
allOf:
- $ref: '#/components/schemas/ListProjectsRequestMaxResultsInteger'
- 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 NextToken
element, which you can use to obtain additional results.'
filters:
allOf:
- $ref: '#/components/schemas/ProjectListFilters'
- description: Information about filters to apply to narrow the results returned in the list.
ProjectSummaries:
type: array
items:
$ref: '#/components/schemas/ProjectSummary'
SourceRepositoryIdString:
type: string
pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
ListSourceRepositoriesItem:
type: object
required:
- id
- name
- lastUpdatedTime
- createdTime
properties:
id:
allOf:
- $ref: '#/components/schemas/SourceRepositoryIdString'
- description: The system-generated unique ID of the source repository.
name:
allOf:
- $ref: '#/components/schemas/SourceRepositoryNameString'
- description: The name of the source repository.
description:
allOf:
- $ref: '#/components/schemas/SourceRepositoryDescriptionString'
- description: 'The description of the repository, if any.'
lastUpdatedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
createdTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC
3339.'
description: Information about a source repository returned in a list of source repositories.
ListSourceRepositoriesItems:
type: array
items:
$ref: '#/components/schemas/ListSourceRepositoriesItem'
ListSourceRepositoriesRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListSourceRepositoriesRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 200
ListSourceRepositoriesRequest:
type: object
title: ListSourceRepositoriesRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/ListSourceRepositoriesRequestNextTokenString'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
maxResults:
allOf:
- $ref: '#/components/schemas/ListSourceRepositoriesRequestMaxResultsInteger'
- 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 NextToken
element, which you can use to obtain additional results.'
ListSourceRepositoryBranchesItem:
type: object
properties:
ref:
allOf:
- $ref: '#/components/schemas/SourceRepositoryBranchRefString'
- description: The Git reference name of the branch.
name:
allOf:
- $ref: '#/components/schemas/SourceRepositoryBranchString'
- description: The name of the branch.
lastUpdatedTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: 'The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.'
headCommitId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The commit ID of the tip of the branch at the time of the request, also known as the head commit.'
description: Information about a branch of a source repository returned in a list of branches.
ListSourceRepositoryBranchesItems:
type: array
items:
$ref: '#/components/schemas/ListSourceRepositoryBranchesItem'
ListSourceRepositoryBranchesRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListSourceRepositoryBranchesRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 50
ListSourceRepositoryBranchesRequest:
type: object
title: ListSourceRepositoryBranchesRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/ListSourceRepositoryBranchesRequestNextTokenString'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
maxResults:
allOf:
- $ref: '#/components/schemas/ListSourceRepositoryBranchesRequestMaxResultsInteger'
- 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 NextToken
element, which you can use to obtain additional results.'
ListSpacesRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListSpacesRequest:
type: object
title: ListSpacesRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/ListSpacesRequestNextTokenString'
- description: 'A token returned from a call to this API to indicate the next batch of results to return, if any.'
SpaceSummaries:
type: array
items:
$ref: '#/components/schemas/SpaceSummary'
PersistentStorageSizeInGiBInteger:
type: integer
minimum: 0
maximum: 64
ProjectSummary:
type: object
required:
- name
properties:
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the project in the space.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name displayed to users of the project in Amazon CodeCatalyst.
description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the project.
description: Information about a project.
SpaceDescription:
type: string
pattern: '[a-zA-Z0-9]+(?:[-_a-zA-Z0-9.,;:/\+=?&$% ])*'
minLength: 0
maxLength: 200
SpaceSummary:
type: object
required:
- name
- regionName
properties:
name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the space.
regionName:
allOf:
- $ref: '#/components/schemas/RegionString'
- description: The Amazon Web Services Region where the space exists.
displayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The friendly name of the space displayed to users.
description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the space.
description: Information about an space.
StartDevEnvironmentRequest:
type: object
title: StartDevEnvironmentRequest
properties:
ides:
allOf:
- $ref: '#/components/schemas/IdeConfigurationList'
- description: 'Information about the integrated development environment (IDE) configured for a Dev Environment. '
instanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- description: 'The Amazon EC2 instace type to use for the Dev Environment. '
inactivityTimeoutMinutes:
allOf:
- $ref: '#/components/schemas/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.'
StartDevEnvironmentSessionRequest:
type: object
required:
- sessionConfiguration
title: StartDevEnvironmentSessionRequest
properties:
sessionConfiguration:
$ref: '#/components/schemas/DevEnvironmentSessionConfiguration'
StartDevEnvironmentSessionResponseSessionIdString:
type: string
minLength: 1
maxLength: 96
StopDevEnvironmentRequest:
type: object
title: StopDevEnvironmentRequest
properties: {}
StopDevEnvironmentSessionRequestSessionIdString:
type: string
minLength: 1
maxLength: 96
StopDevEnvironmentSessionRequest:
type: object
title: StopDevEnvironmentSessionRequest
properties: {}
StopDevEnvironmentSessionResponseSessionIdString:
type: string
minLength: 1
maxLength: 96
UpdateDevEnvironmentRequestAliasString:
type: string
pattern: '$|^[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*'
minLength: 0
maxLength: 128
UpdateDevEnvironmentRequest:
type: object
title: UpdateDevEnvironmentRequest
properties:
alias:
allOf:
- $ref: '#/components/schemas/UpdateDevEnvironmentRequestAliasString'
- description: The user-specified alias for the Dev Environment. Changing this value will not cause a restart.
ides:
allOf:
- $ref: '#/components/schemas/IdeConfigurationList'
- description: Information about the integrated development environment (IDE) configured for a Dev Environment.
instanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- description: The Amazon EC2 instace type to use for the Dev Environment.
Changing this value will cause a restart of the Dev Environment if it is running.
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.
Changing this value will cause a restart of the Dev Environment if it is running.