EVSClient#
Auto-generated documentation for EVS type annotations stubs module types-boto3-evs.
EVSClient#
Type annotations and code completion for boto3.client("evs")
.
boto3 documentation
# EVSClient usage example
from boto3.session import Session
from types_boto3_evs.client import EVSClient
def get_evs_client() -> EVSClient:
return Session().client("evs")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("evs").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("evs")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.TagPolicyException,
client.exceptions.ThrottlingException,
client.exceptions.TooManyTagsException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from types_boto3_evs.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Type annotations and code completion for boto3.client("evs").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
generate_presigned_url#
Type annotations and code completion for boto3.client("evs").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:
...
create_environment#
Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Amazon EVS is in public preview release and is subject to change. Type annotations and code completion for Type annotations and code completion for boto3.client("evs").create_environment
method.
boto3 documentation# create_environment method definition
def create_environment(
self,
*,
vpcId: str,
serviceAccessSubnetId: str,
vcfVersion: VcfVersionType, # (1)
termsAccepted: bool,
licenseInfo: Sequence[LicenseInfoTypeDef], # (2)
initialVlans: InitialVlansTypeDef, # (3)
hosts: Sequence[HostInfoForCreateTypeDef], # (4)
connectivityInfo: ConnectivityInfoUnionTypeDef, # (5)
vcfHostnames: VcfHostnamesTypeDef, # (6)
siteId: str,
clientToken: str = ...,
environmentName: str = ...,
kmsKeyId: str = ...,
tags: Mapping[str, str] = ...,
serviceAccessSecurityGroups: ServiceAccessSecurityGroupsUnionTypeDef = ..., # (7)
) -> CreateEnvironmentResponseTypeDef: # (8)
...
Sequence[LicenseInfoTypeDef]
Sequence[HostInfoForCreateTypeDef]
# create_environment method usage example with argument unpacking
kwargs: CreateEnvironmentRequestTypeDef = { # (1)
"vpcId": ...,
"serviceAccessSubnetId": ...,
"vcfVersion": ...,
"termsAccepted": ...,
"licenseInfo": ...,
"initialVlans": ...,
"hosts": ...,
"connectivityInfo": ...,
"vcfHostnames": ...,
"siteId": ...,
}
parent.create_environment(**kwargs)
create_environment_host#
boto3.client("evs").create_environment_host
method.
boto3 documentation# create_environment_host method definition
def create_environment_host(
self,
*,
environmentId: str,
host: HostInfoForCreateTypeDef, # (1)
clientToken: str = ...,
) -> CreateEnvironmentHostResponseTypeDef: # (2)
...
# create_environment_host method usage example with argument unpacking
kwargs: CreateEnvironmentHostRequestTypeDef = { # (1)
"environmentId": ...,
"host": ...,
}
parent.create_environment_host(**kwargs)
delete_environment#
boto3.client("evs").delete_environment
method.
boto3 documentation# delete_environment method definition
def delete_environment(
self,
*,
environmentId: str,
clientToken: str = ...,
) -> DeleteEnvironmentResponseTypeDef: # (1)
...
# delete_environment method usage example with argument unpacking
kwargs: DeleteEnvironmentRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.delete_environment(**kwargs)
delete_environment_host#
boto3.client("evs").delete_environment_host
method.
boto3 documentation# delete_environment_host method definition
def delete_environment_host(
self,
*,
environmentId: str,
hostName: str,
clientToken: str = ...,
) -> DeleteEnvironmentHostResponseTypeDef: # (1)
...
# delete_environment_host method usage example with argument unpacking
kwargs: DeleteEnvironmentHostRequestTypeDef = { # (1)
"environmentId": ...,
"hostName": ...,
}
parent.delete_environment_host(**kwargs)
get_environment#
boto3.client("evs").get_environment
method.
boto3 documentation# get_environment method definition
def get_environment(
self,
*,
environmentId: str,
) -> GetEnvironmentResponseTypeDef: # (1)
...
# get_environment method usage example with argument unpacking
kwargs: GetEnvironmentRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.get_environment(**kwargs)
list_environment_hosts#
boto3.client("evs").list_environment_hosts
method.
boto3 documentation# list_environment_hosts method definition
def list_environment_hosts(
self,
*,
environmentId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListEnvironmentHostsResponseTypeDef: # (1)
...
# list_environment_hosts method usage example with argument unpacking
kwargs: ListEnvironmentHostsRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.list_environment_hosts(**kwargs)
list_environment_vlans#
boto3.client("evs").list_environment_vlans
method.
boto3 documentation# list_environment_vlans method definition
def list_environment_vlans(
self,
*,
environmentId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListEnvironmentVlansResponseTypeDef: # (1)
...
# list_environment_vlans method usage example with argument unpacking
kwargs: ListEnvironmentVlansRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.list_environment_vlans(**kwargs)
list_environments#
boto3.client("evs").list_environments
method.
boto3 documentation# list_environments method definition
def list_environments(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
state: Sequence[EnvironmentStateType] = ..., # (1)
) -> ListEnvironmentsResponseTypeDef: # (2)
...
Sequence[EnvironmentStateType]
# list_environments method usage example with argument unpacking
kwargs: ListEnvironmentsRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_environments(**kwargs)
list_tags_for_resource#
boto3.client("evs").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: ListTagsForResourceRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
tag_resource#
boto3.client("evs").tag_resource
method.
boto3 documentation# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
boto3.client("evs").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: UntagResourceRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
get_paginator#
boto3.client("evs").get_paginator
method with overloads.
client.get_paginator("list_environment_hosts")
-> ListEnvironmentHostsPaginatorclient.get_paginator("list_environment_vlans")
-> ListEnvironmentVlansPaginatorclient.get_paginator("list_environments")
-> ListEnvironmentsPaginator