AWS API Changes

2020/02/17 - AWS Cloud9 - 3 new 1 updated api methods

Changes AWS Cloud9 now supports the ability to tag Cloud9 development environments.

ListTagsForResource (new)

Gets a list of the tags associated with an AWS Cloud9 development environment.

Request Syntax

client.list_tags_for_resource(
    ResourceARN='string'
)

type ResourceARN

string

param ResourceARN

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to get the tags for.

rtype

dict

returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- Tags (list) --
  
  The list of tags associated with the AWS Cloud9 development environment.
  - (dict) --
    
    Metadata that is associated with AWS resources. In particular, a name-value pair that can be associated with an AWS Cloud9 development environment. There are two types of tags: user tags and system tags . A user tag is created by the user. A system tag is automatically created by AWS services. A system tag is prefixed with "aws:" and cannot be modified by the user.
    - Key (string) --
      
      The name part of a tag.
    - Value (string) --
      
      The value part of a tag.

TagResource (new)

Link ¶

Adds tags to an AWS Cloud9 development environment.

Warning

Tags that you add to an AWS Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceARN

string

param ResourceARN

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to add tags to.

type Tags

list

param Tags

[REQUIRED]

The list of tags to add to the given AWS Cloud9 development environment.

(dict) --

Metadata that is associated with AWS resources. In particular, a name-value pair that can be associated with an AWS Cloud9 development environment. There are two types of tags: user tags and system tags . A user tag is created by the user. A system tag is automatically created by AWS services. A system tag is prefixed with "aws:" and cannot be modified by the user.
- Key (string) -- [REQUIRED]
  
  The name part of a tag.
- Value (string) -- [REQUIRED]
  
  The value part of a tag.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UntagResource (new)

Link ¶

Removes tags from an AWS Cloud9 development environment.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)

type ResourceARN

string

param ResourceARN

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.

type TagKeys

list

param TagKeys

[REQUIRED]

The tag names of the tags to remove from the given AWS Cloud9 development environment.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateEnvironmentEC2 (updated)

Link ¶
Changes (request)

{'tags': [{'Key': 'string', 'Value': 'string'}]}

Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

See also: AWS API Documentation

Request Syntax

client.create_environment_ec2(
    name='string',
    description='string',
    clientRequestToken='string',
    instanceType='string',
    subnetId='string',
    automaticStopTimeMinutes=123,
    ownerArn='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type name

string

param name

[REQUIRED]

The name of the environment to create.

This name is visible to other AWS IAM users in the same AWS account.

type description

string

param description

The description of the environment to create.

type clientRequestToken

string

param clientRequestToken

A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.

For more information, see Client Tokens in the Amazon EC2 API Reference .

type instanceType

string

param instanceType

[REQUIRED]

The type of instance to connect to the environment (for example, t2.micro ).

type subnetId

string

param subnetId

The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.

type automaticStopTimeMinutes

integer

param automaticStopTimeMinutes

The number of minutes until the running instance is shut down after the environment has last been used.

type ownerArn

string

param ownerArn

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

type tags

list

param tags

An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.

(dict) --

Metadata that is associated with AWS resources. In particular, a name-value pair that can be associated with an AWS Cloud9 development environment. There are two types of tags: user tags and system tags . A user tag is created by the user. A system tag is automatically created by AWS services. A system tag is prefixed with "aws:" and cannot be modified by the user.
- Key (string) -- [REQUIRED]
  
  The name part of a tag.
- Value (string) -- [REQUIRED]
  
  The value part of a tag.

rtype

dict

returns

Response Syntax

{
    'environmentId': 'string'
}

Response Structure

(dict) --
- environmentId (string) --
  
  The ID of the environment that was created.