create_dev_environment
¶
create_dev_environment(
space_name: NameString,
project_name: NameString,
instance_type: InstanceType,
persistent_storage: PersistentStorageConfiguration,
*,
config_overrides: Optional[CodeCatalystClientConfig] = None,
repositories: Optional[RepositoriesInput] = None,
client_token: Optional[ClientToken] = None,
alias: Optional[str] = None,
ides: Optional[IdeConfigurationList] = None,
inactivity_timeout_minutes: Optional[InactivityTimeoutMinutes] = None,
vpc_connection_name: Optional[NameString] = None,
) -> CreateDevEnvironmentResponse
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.
Parameters:
-
space_name(NameString) –The name of the space.
-
project_name(NameString) –The name of the project in the space.
-
repositories(Optional[RepositoriesInput], default:None) –The source repository that contains the branch to clone into the Dev Environment.
-
client_token(Optional[ClientToken], default:None) –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.
-
alias(Optional[str], default:None) –The user-defined alias for a Dev Environment.
-
ides(Optional[IdeConfigurationList], default:None) –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.
-
instance_type(InstanceType) –The Amazon EC2 instace type to use for the Dev Environment.
-
inactivity_timeout_minutes(Optional[InactivityTimeoutMinutes], default:None) –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.
-
persistent_storage(PersistentStorageConfiguration) –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.
-
vpc_connection_name(Optional[NameString], default:None) –The name of the connection that will be used to connect to Amazon VPC, if any.
Raises:
-
AccessDeniedException–The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
-
ConflictException–The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
-
ResourceNotFoundException–The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
-
ServiceQuotaExceededException–The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_codecatalyst/_services/code_catalyst.py
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 | |