Cloud9Client#
Auto-generated documentation for Cloud9 type annotations stubs module mypy-boto3-cloud9.
Cloud9Client#
Type annotations and code completion for boto3.client("cloud9").
boto3 documentation
# Cloud9Client usage example
from boto3.session import Session
from mypy_boto3_cloud9.client import Cloud9Client
def get_cloud9_client() -> Cloud9Client:
return Session().client("cloud9")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("cloud9").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("cloud9")
try:
do_something(client)
except (
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConcurrentAccessException,
client.exceptions.ConflictException,
client.exceptions.ForbiddenException,
client.exceptions.InternalServerErrorException,
client.exceptions.LimitExceededException,
client.exceptions.NotFoundException,
client.exceptions.TooManyRequestsException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_cloud9.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("cloud9").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("cloud9").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_environment_ec2#
Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
Type annotations and code completion for boto3.client("cloud9").create_environment_ec2 method.
boto3 documentation
# create_environment_ec2 method definition
def create_environment_ec2(
self,
*,
name: str,
instanceType: str,
imageId: str,
description: str = ...,
clientRequestToken: str = ...,
subnetId: str = ...,
automaticStopTimeMinutes: int = ...,
ownerArn: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
connectionType: ConnectionTypeType = ..., # (2)
dryRun: bool = ...,
) -> CreateEnvironmentEC2ResultTypeDef: # (3)
...# create_environment_ec2 method usage example with argument unpacking
kwargs: CreateEnvironmentEC2RequestRequestTypeDef = { # (1)
"name": ...,
"instanceType": ...,
"imageId": ...,
}
parent.create_environment_ec2(**kwargs)create_environment_membership#
Adds an environment member to an Cloud9 development environment.
Type annotations and code completion for boto3.client("cloud9").create_environment_membership method.
boto3 documentation
# create_environment_membership method definition
def create_environment_membership(
self,
*,
environmentId: str,
userArn: str,
permissions: MemberPermissionsType, # (1)
) -> CreateEnvironmentMembershipResultTypeDef: # (2)
...# create_environment_membership method usage example with argument unpacking
kwargs: CreateEnvironmentMembershipRequestRequestTypeDef = { # (1)
"environmentId": ...,
"userArn": ...,
"permissions": ...,
}
parent.create_environment_membership(**kwargs)delete_environment#
Deletes an Cloud9 development environment.
Type annotations and code completion for boto3.client("cloud9").delete_environment method.
boto3 documentation
# delete_environment method definition
def delete_environment(
self,
*,
environmentId: str,
) -> Dict[str, Any]:
...# delete_environment method usage example with argument unpacking
kwargs: DeleteEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.delete_environment(**kwargs)delete_environment_membership#
Deletes an environment member from a development environment.
Type annotations and code completion for boto3.client("cloud9").delete_environment_membership method.
boto3 documentation
# delete_environment_membership method definition
def delete_environment_membership(
self,
*,
environmentId: str,
userArn: str,
) -> Dict[str, Any]:
...# delete_environment_membership method usage example with argument unpacking
kwargs: DeleteEnvironmentMembershipRequestRequestTypeDef = { # (1)
"environmentId": ...,
"userArn": ...,
}
parent.delete_environment_membership(**kwargs)describe_environment_memberships#
Gets information about environment members for an Cloud9 development environment.
Type annotations and code completion for boto3.client("cloud9").describe_environment_memberships method.
boto3 documentation
# describe_environment_memberships method definition
def describe_environment_memberships(
self,
*,
userArn: str = ...,
environmentId: str = ...,
permissions: Sequence[PermissionsType] = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeEnvironmentMembershipsResultTypeDef: # (2)
...# describe_environment_memberships method usage example with argument unpacking
kwargs: DescribeEnvironmentMembershipsRequestRequestTypeDef = { # (1)
"userArn": ...,
}
parent.describe_environment_memberships(**kwargs)describe_environment_status#
Gets status information for an Cloud9 development environment.
Type annotations and code completion for boto3.client("cloud9").describe_environment_status method.
boto3 documentation
# describe_environment_status method definition
def describe_environment_status(
self,
*,
environmentId: str,
) -> DescribeEnvironmentStatusResultTypeDef: # (1)
...# describe_environment_status method usage example with argument unpacking
kwargs: DescribeEnvironmentStatusRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.describe_environment_status(**kwargs)describe_environments#
Gets information about Cloud9 development environments.
Type annotations and code completion for boto3.client("cloud9").describe_environments method.
boto3 documentation
# describe_environments method definition
def describe_environments(
self,
*,
environmentIds: Sequence[str],
) -> DescribeEnvironmentsResultTypeDef: # (1)
...# describe_environments method usage example with argument unpacking
kwargs: DescribeEnvironmentsRequestRequestTypeDef = { # (1)
"environmentIds": ...,
}
parent.describe_environments(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("cloud9").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...list_environments#
Gets a list of Cloud9 development environment identifiers.
Type annotations and code completion for boto3.client("cloud9").list_environments method.
boto3 documentation
# list_environments method definition
def list_environments(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListEnvironmentsResultTypeDef: # (1)
...# list_environments method usage example with argument unpacking
kwargs: ListEnvironmentsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_environments(**kwargs)list_tags_for_resource#
Gets a list of the tags associated with an Cloud9 development environment.
Type annotations and code completion for boto3.client("cloud9").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)tag_resource#
Adds tags to an Cloud9 development environment.
Type annotations and code completion for boto3.client("cloud9").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes tags from an Cloud9 development environment.
Type annotations and code completion for boto3.client("cloud9").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)update_environment#
Changes the settings of an existing Cloud9 development environment.
Type annotations and code completion for boto3.client("cloud9").update_environment method.
boto3 documentation
# update_environment method definition
def update_environment(
self,
*,
environmentId: str,
name: str = ...,
description: str = ...,
managedCredentialsAction: ManagedCredentialsActionType = ..., # (1)
) -> Dict[str, Any]:
...# update_environment method usage example with argument unpacking
kwargs: UpdateEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.update_environment(**kwargs)update_environment_membership#
Changes the settings of an existing environment member for an Cloud9 development environment.
Type annotations and code completion for boto3.client("cloud9").update_environment_membership method.
boto3 documentation
# update_environment_membership method definition
def update_environment_membership(
self,
*,
environmentId: str,
userArn: str,
permissions: MemberPermissionsType, # (1)
) -> UpdateEnvironmentMembershipResultTypeDef: # (2)
...# update_environment_membership method usage example with argument unpacking
kwargs: UpdateEnvironmentMembershipRequestRequestTypeDef = { # (1)
"environmentId": ...,
"userArn": ...,
"permissions": ...,
}
parent.update_environment_membership(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("cloud9").get_paginator method with overloads.
client.get_paginator("describe_environment_memberships")-> DescribeEnvironmentMembershipsPaginatorclient.get_paginator("list_environments")-> ListEnvironmentsPaginator