Cloud9 / Client / update_environment

update_environment

Cloud9.Client.update_environment(**kwargs)

Changes the settings of an existing Cloud9 development environment.

Warning

Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more”

See also: AWS API Documentation

Request Syntax

response = client.update_environment(
    environmentId='string',
    name='string',
    description='string',
    managedCredentialsAction='ENABLE'|'DISABLE'
)

Parameters:

• environmentId (string) –

  [REQUIRED]

  The ID of the environment to change settings.

• name (string) – A replacement name for the environment.

• description (string) – Any new or replacement description for the environment.

• managedCredentialsAction (string) –

  Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials for an Cloud9 environment by using one of the following values:

  • ENABLE

  • DISABLE

  Note

  Only the environment owner can change the status of managed temporary credentials. An AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary credentials is made by an account that’s not the environment owner.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• Cloud9.Client.exceptions.BadRequestException

• Cloud9.Client.exceptions.ConflictException

• Cloud9.Client.exceptions.NotFoundException

• Cloud9.Client.exceptions.ForbiddenException

• Cloud9.Client.exceptions.TooManyRequestsException

• Cloud9.Client.exceptions.LimitExceededException

• Cloud9.Client.exceptions.InternalServerErrorException

Examples

response = client.update_environment(
    name='my-changed-demo-environment',
    description='This is my changed demonstration environment.',
    environmentId='8d9967e2f0624182b74e7690ad69ebEX',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}