CodeCatalyst / Client / delete_space

delete_space#

CodeCatalyst.Client.delete_space(**kwargs)#

Deletes a space.

Warning

Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.

See also: AWS API Documentation

Request Syntax

response = client.delete_space(
    name='string'
)
Parameters:

name (string) –

[REQUIRED]

The name of the space. To retrieve a list of space names, use ListSpaces.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'displayName': 'string'
}

Response Structure

  • (dict) –

    • name (string) –

      The name of the space.

    • displayName (string) –

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

Exceptions

  • CodeCatalyst.Client.exceptions.ThrottlingException

  • CodeCatalyst.Client.exceptions.ConflictException

  • CodeCatalyst.Client.exceptions.ValidationException

  • CodeCatalyst.Client.exceptions.ServiceQuotaExceededException

  • CodeCatalyst.Client.exceptions.ResourceNotFoundException

  • CodeCatalyst.Client.exceptions.AccessDeniedException