Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

UpdateSpace

Changes one or more values for a space.

Request Syntax


PATCH /v1/spaces/name HTTP/1.1
Content-type: application/json

{
   "description": "string"
}

URI Request Parameters

The request uses the following URI parameters.

name

The name of the space.

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: [a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The description of the space.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: [a-zA-Z0-9]+(?:[-_a-zA-Z0-9.,;:/\+=?&$% ])*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "displayName": "string",
   "name": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

description

The description of the space.

Type: String

displayName

The friendly name of the space displayed to users in Amazon CodeCatalyst.

Type: String

name

The name of the space.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: [a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*

Errors

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.

HTTP Status Code: 403

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.

HTTP Status Code: 409

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.

HTTP Status Code: 404

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.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

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.

HTTP Status Code: 400

Examples

Example

The following example illustrates using UpdateSpace to change the value of the description of the ExampleCorp space to A place for us to work together on code..

Sample Request


PATCH https://codecatalyst.global.api.aws/v1/spaces/ExampleCorp
Host: codecatalyst.global.api.aws
User-Agent: aws-cli/2.9.12 Python/3.9.11 Darwin/21.6.0 exe/x86_64 prompt/off command/codecatalyst.update-space
Content-Type: application/json
Authorization: Bearer AKIAI44QH8DHBEXAMPLE

{"description": "A place for us to work together on code."}

Sample Response


200 OK 411b
Content-Type: application/json; charset=utf-8
Date: Wed, 07 Jun 2023 19:43:09 GMT

{
    "name": "ExampleCorp",
    "displayName": "Example_Corp",
    "description": "A place for us to work together on code."
}