Table of Contents
Cloud9.
Client
¶A low-level client representing AWS Cloud9
AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.
For more information about AWS Cloud9, see the AWS Cloud9 User Guide .
AWS Cloud9 supports these operations:
CreateEnvironmentEC2
: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.
CreateEnvironmentMembership
: Adds an environment member to an environment.
DeleteEnvironment
: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
DeleteEnvironmentMembership
: Deletes an environment member from an environment.
DescribeEnvironmentMemberships
: Gets information about environment members for an environment.
DescribeEnvironments
: Gets information about environments.
DescribeEnvironmentStatus
: Gets status information for an environment.
ListEnvironments
: Gets a list of environment identifiers.
ListTagsForResource
: Gets the tags for an environment.
TagResource
: Adds tags to an environment.
UntagResource
: Removes tags from an environment.
UpdateEnvironment
: Changes the settings of an existing environment.
UpdateEnvironmentMembership
: Changes the settings of an existing environment member for an environment.
client = session.create_client('cloud9')
These are the available methods:
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
create_environment_ec2
(**kwargs)¶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
response = client.create_environment_ec2(
name='string',
description='string',
clientRequestToken='string',
instanceType='string',
subnetId='string',
automaticStopTimeMinutes=123,
ownerArn='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
connectionType='CONNECT_SSH'|'CONNECT_SSM'
)
name (string) –
[REQUIRED]
The name of the environment to create.
This name is visible to other AWS IAM users in the same AWS account.
description (string) – The description of the environment to create.
clientRequestToken (string) –
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 .
instanceType (string) –
[REQUIRED]
The type of instance to connect to the environment (for example, t2.micro
).
subnetId (string) – The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.
automaticStopTimeMinutes (integer) – The number of minutes until the running instance is shut down after the environment has last been used.
ownerArn (string) – 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.
tags (list) –
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.
connectionType (string) – The connection type used for connecting to an Amazon EC2 environment.
dict
Response Syntax
{
'environmentId': 'string'
}
Response Structure
(dict) –
environmentId (string) –
The ID of the environment that was created.
Exceptions
Examples
response = client.create_environment_ec2(
name='my-demo-environment',
automaticStopTimeMinutes=60,
description='This is my demonstration environment.',
instanceType='t2.micro',
ownerArn='arn:aws:iam::123456789012:user/MyDemoUser',
subnetId='subnet-1fab8aEX',
)
print(response)
Expected Output:
{
'environmentId': '8d9967e2f0624182b74e7690ad69ebEX',
'ResponseMetadata': {
'...': '...',
},
}
create_environment_membership
(**kwargs)¶Adds an environment member to an AWS Cloud9 development environment.
See also: AWS API Documentation
Request Syntax
response = client.create_environment_membership(
environmentId='string',
userArn='string',
permissions='read-write'|'read-only'
)
environmentId (string) –
[REQUIRED]
The ID of the environment that contains the environment member you want to add.
userArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the environment member you want to add.
permissions (string) –
[REQUIRED]
The type of environment member permissions you want to associate with this environment member. Available values include:
read-only
: Has read-only access to the environment.
read-write
: Has read-write access to the environment.
dict
Response Syntax
{
'membership': {
'permissions': 'owner'|'read-write'|'read-only',
'userId': 'string',
'userArn': 'string',
'environmentId': 'string',
'lastAccess': datetime(2015, 1, 1)
}
}
Response Structure
(dict) –
membership (dict) –
Information about the environment member that was added.
permissions (string) –
The type of environment member permissions associated with this environment member. Available values include:
owner
: Owns the environment.
read-only
: Has read-only access to the environment.
read-write
: Has read-write access to the environment.
userId (string) –
The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.
userArn (string) –
The Amazon Resource Name (ARN) of the environment member.
environmentId (string) –
The ID of the environment for the environment member.
lastAccess (datetime) –
The time, expressed in epoch time format, when the environment member last opened the environment.
Exceptions
Examples
response = client.create_environment_membership(
environmentId='8d9967e2f0624182b74e7690ad69ebEX',
permissions='read-write',
userArn='arn:aws:iam::123456789012:user/AnotherDemoUser',
)
print(response)
Expected Output:
{
'membership': {
'environmentId': '8d9967e2f0624182b74e7690ad69ebEX',
'permissions': 'read-write',
'userArn': 'arn:aws:iam::123456789012:user/AnotherDemoUser',
'userId': 'AIDAJ3BA6O2FMJWCWXHEX',
},
'ResponseMetadata': {
'...': '...',
},
}
delete_environment
(**kwargs)¶Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
See also: AWS API Documentation
Request Syntax
response = client.delete_environment(
environmentId='string'
)
environmentId (string) –
[REQUIRED]
The ID of the environment to delete.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Examples
response = client.delete_environment(
environmentId='8d9967e2f0624182b74e7690ad69ebEX',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_environment_membership
(**kwargs)¶Deletes an environment member from an AWS Cloud9 development environment.
See also: AWS API Documentation
Request Syntax
response = client.delete_environment_membership(
environmentId='string',
userArn='string'
)
environmentId (string) –
[REQUIRED]
The ID of the environment to delete the environment member from.
userArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the environment member to delete from the environment.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Examples
response = client.delete_environment_membership(
environmentId='8d9967e2f0624182b74e7690ad69ebEX',
userArn='arn:aws:iam::123456789012:user/AnotherDemoUser',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_environment_memberships
(**kwargs)¶Gets information about environment members for an AWS Cloud9 development environment.
See also: AWS API Documentation
Request Syntax
response = client.describe_environment_memberships(
userArn='string',
environmentId='string',
permissions=[
'owner'|'read-write'|'read-only',
],
nextToken='string',
maxResults=123
)
userArn (string) – The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.
environmentId (string) – The ID of the environment to get environment member information about.
permissions (list) –
The type of environment member permissions to get information about. Available values include:
owner
: Owns the environment.
read-only
: Has read-only access to the environment.
read-write
: Has read-write access to the environment.
If no value is specified, information about all environment members are returned.
(string) –
nextToken (string) – During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token . To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
maxResults (integer) – The maximum number of environment members to get information about.
dict
Response Syntax
{
'memberships': [
{
'permissions': 'owner'|'read-write'|'read-only',
'userId': 'string',
'userArn': 'string',
'environmentId': 'string',
'lastAccess': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) –
memberships (list) –
Information about the environment members for the environment.
(dict) –
Information about an environment member for an AWS Cloud9 development environment.
permissions (string) –
The type of environment member permissions associated with this environment member. Available values include:
owner
: Owns the environment.
read-only
: Has read-only access to the environment.
read-write
: Has read-write access to the environment.
userId (string) –
The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.
userArn (string) –
The Amazon Resource Name (ARN) of the environment member.
environmentId (string) –
The ID of the environment for the environment member.
lastAccess (datetime) –
The time, expressed in epoch time format, when the environment member last opened the environment.
nextToken (string) –
If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token . To get the next batch of items in the list, call this operation again, adding the next token to the call.
Exceptions
Examples
The following example gets information about all of the environment members for the specified AWS Cloud9 development environment.
response = client.describe_environment_memberships(
environmentId='8d9967e2f0624182b74e7690ad69ebEX',
)
print(response)
Expected Output:
{
'memberships': [
{
'environmentId': '8d9967e2f0624182b74e7690ad69ebEX',
'permissions': 'read-write',
'userArn': 'arn:aws:iam::123456789012:user/AnotherDemoUser',
'userId': 'AIDAJ3BA6O2FMJWCWXHEX',
},
{
'environmentId': '8d9967e2f0624182b74e7690ad69ebEX',
'permissions': 'owner',
'userArn': 'arn:aws:iam::123456789012:user/MyDemoUser',
'userId': 'AIDAJNUEDQAQWFELJDLEX',
},
],
'ResponseMetadata': {
'...': '...',
},
}
The following example gets information about the owner of the specified AWS Cloud9 development environment.
response = client.describe_environment_memberships(
environmentId='8d9967e2f0624182b74e7690ad69ebEX',
permissions=[
'owner',
],
)
print(response)
Expected Output:
{
'memberships': [
{
'environmentId': '8d9967e2f0624182b74e7690ad69ebEX',
'permissions': 'owner',
'userArn': 'arn:aws:iam::123456789012:user/MyDemoUser',
'userId': 'AIDAJNUEDQAQWFELJDLEX',
},
],
'ResponseMetadata': {
'...': '...',
},
}
The following example gets AWS Cloud9 development environment membership information for the specified user.
response = client.describe_environment_memberships(
userArn='arn:aws:iam::123456789012:user/MyDemoUser',
)
print(response)
Expected Output:
{
'memberships': [
{
'environmentId': '10a75714bd494714929e7f5ec4125aEX',
'lastAccess': datetime(2018, 1, 19, 11, 6, 13, 4, 19, 0),
'permissions': 'owner',
'userArn': 'arn:aws:iam::123456789012:user/MyDemoUser',
'userId': 'AIDAJNUEDQAQWFELJDLEX',
},
{
'environmentId': '12bfc3cd537f41cb9776f8af5525c9EX',
'lastAccess': datetime(2018, 1, 19, 11, 39, 19, 4, 19, 0),
'permissions': 'owner',
'userArn': 'arn:aws:iam::123456789012:user/MyDemoUser',
'userId': 'AIDAJNUEDQAQWFELJDLEX',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_environment_status
(**kwargs)¶Gets status information for an AWS Cloud9 development environment.
See also: AWS API Documentation
Request Syntax
response = client.describe_environment_status(
environmentId='string'
)
environmentId (string) –
[REQUIRED]
The ID of the environment to get status information about.
dict
Response Syntax
{
'status': 'error'|'creating'|'connecting'|'ready'|'stopping'|'stopped'|'deleting',
'message': 'string'
}
Response Structure
(dict) –
status (string) –
The status of the environment. Available values include:
connecting
: The environment is connecting.
creating
: The environment is being created.
deleting
: The environment is being deleted.
error
: The environment is in an error state.
ready
: The environment is ready.
stopped
: The environment is stopped.
stopping
: The environment is stopping.
message (string) –
Any informational message about the status of the environment.
Exceptions
Examples
response = client.describe_environment_status(
environmentId='8d9967e2f0624182b74e7690ad69ebEX',
)
print(response)
Expected Output:
{
'message': 'Environment is ready to use',
'status': 'ready',
'ResponseMetadata': {
'...': '...',
},
}
describe_environments
(**kwargs)¶Gets information about AWS Cloud9 development environments.
See also: AWS API Documentation
Request Syntax
response = client.describe_environments(
environmentIds=[
'string',
]
)
environmentIds (list) –
[REQUIRED]
The IDs of individual environments to get information about.
(string) –
dict
Response Syntax
{
'environments': [
{
'id': 'string',
'name': 'string',
'description': 'string',
'type': 'ssh'|'ec2',
'connectionType': 'CONNECT_SSH'|'CONNECT_SSM',
'arn': 'string',
'ownerArn': 'string',
'lifecycle': {
'status': 'CREATING'|'CREATED'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED',
'reason': 'string',
'failureResource': 'string'
}
},
]
}
Response Structure
(dict) –
environments (list) –
Information about the environments that are returned.
(dict) –
Information about an AWS Cloud9 development environment.
id (string) –
The ID of the environment.
name (string) –
The name of the environment.
description (string) –
The description for the environment.
type (string) –
The type of environment. Valid values include the following:
ec2
: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.
ssh
: Your own server connects to the environment.
connectionType (string) –
The connection type used for connecting to an Amazon EC2 environment.
arn (string) –
The Amazon Resource Name (ARN) of the environment.
ownerArn (string) –
The Amazon Resource Name (ARN) of the environment owner.
lifecycle (dict) –
The state of the environment in its creation or deletion lifecycle.
status (string) –
The current creation or deletion lifecycle state of the environment.
CREATING
: The environment is in the process of being created.
CREATED
: The environment was successfully created.
CREATE_FAILED
: The environment failed to be created.
DELETING
: The environment is in the process of being deleted.
DELETE_FAILED
: The environment failed to delete.
reason (string) –
Any informational message about the lifecycle state of the environment.
failureResource (string) –
If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.
Exceptions
Examples
response = client.describe_environments(
environmentIds=[
'8d9967e2f0624182b74e7690ad69ebEX',
'349c86d4579e4e7298d500ff57a6b2EX',
],
)
print(response)
Expected Output:
{
'environments': [
{
'name': 'my-demo-environment',
'type': 'ec2',
'arn': 'arn:aws:cloud9:us-east-2:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX',
'description': 'This is my demonstration environment.',
'id': '8d9967e2f0624182b74e7690ad69ebEX',
'ownerArn': 'arn:aws:iam::123456789012:user/MyDemoUser',
},
{
'name': 'another-demo-environment',
'type': 'ssh',
'arn': 'arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX',
'id': '349c86d4579e4e7298d500ff57a6b2EX',
'ownerArn': 'arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser',
},
],
'ResponseMetadata': {
'...': '...',
},
}
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to
ClientMethod
.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
The presigned url
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
list_environments
(**kwargs)¶Gets a list of AWS Cloud9 development environment identifiers.
See also: AWS API Documentation
Request Syntax
response = client.list_environments(
nextToken='string',
maxResults=123
)
nextToken (string) – During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token . To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
maxResults (integer) – The maximum number of environments to get identifiers for.
dict
Response Syntax
{
'nextToken': 'string',
'environmentIds': [
'string',
]
}
Response Structure
(dict) –
nextToken (string) –
If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token . To get the next batch of items in the list, call this operation again, adding the next token to the call.
environmentIds (list) –
The list of environment identifiers.
(string) –
Exceptions
Examples
response = client.list_environments(
)
print(response)
Expected Output:
{
'environmentIds': [
'349c86d4579e4e7298d500ff57a6b2EX',
'45a3da47af0840f2b0c0824f5ee232EX',
],
'ResponseMetadata': {
'...': '...',
},
}
Gets a list of the tags associated with an AWS Cloud9 development environment.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
ResourceARN (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to get the tags for.
dict
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.
Exceptions
tag_resource
(**kwargs)¶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
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
ResourceARN (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to add tags to.
Tags (list) –
[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.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
untag_resource
(**kwargs)¶Removes tags from an AWS Cloud9 development environment.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
ResourceARN (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.
TagKeys (list) –
[REQUIRED]
The tag names of the tags to remove from the given AWS Cloud9 development environment.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_environment
(**kwargs)¶Changes the settings of an existing AWS Cloud9 development environment.
See also: AWS API Documentation
Request Syntax
response = client.update_environment(
environmentId='string',
name='string',
description='string'
)
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.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Examples
response = client.update_environment(
name='my-changed-demo-environment',
description='This is my changed demonstration environment.',
environmentId='8d9967e2f0624182b74e7690ad69ebEX',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
update_environment_membership
(**kwargs)¶Changes the settings of an existing environment member for an AWS Cloud9 development environment.
See also: AWS API Documentation
Request Syntax
response = client.update_environment_membership(
environmentId='string',
userArn='string',
permissions='read-write'|'read-only'
)
environmentId (string) –
[REQUIRED]
The ID of the environment for the environment member whose settings you want to change.
userArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the environment member whose settings you want to change.
permissions (string) –
[REQUIRED]
The replacement type of environment member permissions you want to associate with this environment member. Available values include:
read-only
: Has read-only access to the environment.
read-write
: Has read-write access to the environment.
dict
Response Syntax
{
'membership': {
'permissions': 'owner'|'read-write'|'read-only',
'userId': 'string',
'userArn': 'string',
'environmentId': 'string',
'lastAccess': datetime(2015, 1, 1)
}
}
Response Structure
(dict) –
membership (dict) –
Information about the environment member whose settings were changed.
permissions (string) –
The type of environment member permissions associated with this environment member. Available values include:
owner
: Owns the environment.
read-only
: Has read-only access to the environment.
read-write
: Has read-write access to the environment.
userId (string) –
The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.
userArn (string) –
The Amazon Resource Name (ARN) of the environment member.
environmentId (string) –
The ID of the environment for the environment member.
lastAccess (datetime) –
The time, expressed in epoch time format, when the environment member last opened the environment.
Exceptions
Examples
response = client.update_environment_membership(
environmentId='8d9967e2f0624182b74e7690ad69ebEX',
permissions='read-only',
userArn='arn:aws:iam::123456789012:user/AnotherDemoUser',
)
print(response)
Expected Output:
{
'membership': {
'environmentId': '8d9967e2f0624182b74e7690ad69eb31',
'permissions': 'read-only',
'userArn': 'arn:aws:iam::123456789012:user/AnotherDemoUser',
'userId': 'AIDAJ3BA6O2FMJWCWXHEX',
},
'ResponseMetadata': {
'...': '...',
},
}
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Cloud9.Client.exceptions.
BadRequestException
¶The target request is invalid.
Example
try:
...
except client.exceptions.BadRequestException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The target request is invalid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Cloud9.Client.exceptions.
ConcurrentAccessException
¶A concurrent access issue occurred.
Example
try:
...
except client.exceptions.ConcurrentAccessException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A concurrent access issue occurred.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Cloud9.Client.exceptions.
ConflictException
¶A conflict occurred.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A conflict occurred.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Cloud9.Client.exceptions.
ForbiddenException
¶An access permissions issue occurred.
Example
try:
...
except client.exceptions.ForbiddenException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An access permissions issue occurred.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Cloud9.Client.exceptions.
InternalServerErrorException
¶An internal server error occurred.
Example
try:
...
except client.exceptions.InternalServerErrorException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An internal server error occurred.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Cloud9.Client.exceptions.
LimitExceededException
¶A service limit was exceeded.
Example
try:
...
except client.exceptions.LimitExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A service limit was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Cloud9.Client.exceptions.
NotFoundException
¶The target resource cannot be found.
Example
try:
...
except client.exceptions.NotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The target resource cannot be found.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Cloud9.Client.exceptions.
TooManyRequestsException
¶Too many service requests were made over the given time period.
Example
try:
...
except client.exceptions.TooManyRequestsException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
Too many service requests were made over the given time period.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
Cloud9.Paginator.
DescribeEnvironmentMemberships
¶paginator = client.get_paginator('describe_environment_memberships')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Cloud9.Client.describe_environment_memberships()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
userArn='string',
environmentId='string',
permissions=[
'owner'|'read-write'|'read-only',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
userArn (string) – The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.
environmentId (string) – The ID of the environment to get environment member information about.
permissions (list) –
The type of environment member permissions to get information about. Available values include:
owner
: Owns the environment.
read-only
: Has read-only access to the environment.
read-write
: Has read-write access to the environment.
If no value is specified, information about all environment members are returned.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'memberships': [
{
'permissions': 'owner'|'read-write'|'read-only',
'userId': 'string',
'userArn': 'string',
'environmentId': 'string',
'lastAccess': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
memberships (list) –
Information about the environment members for the environment.
(dict) –
Information about an environment member for an AWS Cloud9 development environment.
permissions (string) –
The type of environment member permissions associated with this environment member. Available values include:
owner
: Owns the environment.
read-only
: Has read-only access to the environment.
read-write
: Has read-write access to the environment.
userId (string) –
The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.
userArn (string) –
The Amazon Resource Name (ARN) of the environment member.
environmentId (string) –
The ID of the environment for the environment member.
lastAccess (datetime) –
The time, expressed in epoch time format, when the environment member last opened the environment.
NextToken (string) –
A token to resume pagination.
Cloud9.Paginator.
ListEnvironments
¶paginator = client.get_paginator('list_environments')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Cloud9.Client.list_environments()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'environmentIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
environmentIds (list) –
The list of environment identifiers.
(string) –
NextToken (string) –
A token to resume pagination.